Sign in

v1

latestOpenAPI 3.0.12026-07-24168217310.4 KB
QuickLinks

Creates a new QuickLink for a site.

The slug must be unique within the site. Once created, the slug cannot be changed.

post/Sites/{siteId}/Quicklinks

Path parameters

siteIdinteger required

The unique identifier of the site

Request body

namestring required
slugstring nullable
actionType'Resume' | 'Pause' | 'ProcessNow' | 'Reactivate' required
usageLimitType'SingleUse' | 'LimitedUse' | 'Unlimited' required
maxUsesinteger nullable
requiresLoginboolean
requiresConfirmationboolean
expiredUtcstring date-time nullable

Response

QuickLink created successfully

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