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

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/post.ts
A function with typed inputs. Its response is checked against the schema.

siteIdinteger required

The unique identifier of the site

namestring required

slugstring nullable

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

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

maxUsesinteger nullable

requiresLoginboolean

requiresConfirmationboolean

expiredUtcstring date-time nullable

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

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