Sign in
QuickLinks

Records the usage of a QuickLink after the associated action has been performed.

Call this endpoint after performing the QuickLink action to record the usage. Include success=false and error details if the action failed. This increments usage counters and marks tokens as used if successful.

post/Sites/{siteId}/Quicklinks/{slug}/Consume

Path parameters

siteIdinteger required

The unique identifier of the site

slugstring required

The unique slug of the QuickLink

Request body

scheduledOrderIdinteger required
customerIdinteger nullable
tokenstring nullable
successboolean required
errorCodestring nullable
errorMessagestring nullable
ipAddressstring nullable
userAgentstring nullable
executedAtstring date-time nullable

Response

Usage recorded successfully

recordedboolean
usageIdinteger
messagestring nullable
currentUsageCountinteger
usageRemaininginteger nullable

Changes

No recorded changes to this endpoint across all 1 revision of this API.