QuickLinks

Updates an existing QuickLink's properties.

The slug cannot be modified after creation. All other properties can be updated.

put/Sites/{siteId}/Quicklinks/{id}

Request

Base URL
https://api.qpilot.cloud
Auth
API key in header Authorization
TypeScript
https://skmtc.dev/qpilot/apis/qpilot-api/docs/Sites/:siteId/Quicklinks/:id/put.ts
A function with typed inputs. Its response is checked against the schema.

siteIdinteger required

The unique identifier of the site

idinteger required

The unique identifier of the QuickLink to update

namestring required

actionType'Resume' | 'Pause' | 'ProcessNow' | 'Reactivate' required

usageLimitType'SingleUse' | 'LimitedUse' | 'Unlimited' required

maxUsesinteger nullable

requiresLoginboolean

requiresConfirmationboolean

expiredUtcstring date-time nullable

Success

idinteger

siteIdinteger

namestring nullable

slugstring nullable

actionType'Resume' | 'Pause' | 'ProcessNow' | 'Reactivate'

status'Disabled' | 'Enabled' | 'Deleted'

usageLimitType'SingleUse' | 'LimitedUse' | 'Unlimited'

maxUsesinteger nullable

currentUsageCountinteger

requiresLoginboolean

requiresConfirmationboolean

createdUtcstring date-time

updatedUtcstring date-time

expiredUtcstring date-time nullable

templateUrlstring nullable

No recorded changes to this operation across all 2 revisions of this API.