API Reference
Back to QPilot.cloud

Verifies if a QuickLink can be consumed by checking validity, status, expiration, usage limits, and permissions.

post
https://api.qpilot.cloud/Sites//Quicklinks/Verify/

Call this endpoint before performing the QuickLink action. If Valid=true, proceed with the action then call Consume.

Possible error codes returned when Valid=false:

  • LINK_NOT_FOUND: QuickLink slug doesn't exist for this site
  • LINK_DISABLED: QuickLink status is not Enabled (disabled or deleted)
  • LINK_EXPIRED: QuickLink has passed its ExpiredUtc date
  • USAGE_LIMIT_REACHED: QuickLink has reached its usage limit (SingleUse or Limited)
  • INVALID_TOKEN: Token provided doesn't match any token for this QuickLink
  • TOKEN_ALREADY_USED: Token has already been consumed (IsUsed=true)
  • TOKEN_EXPIRED: Token has passed its ExpiredUtc date
  • SCHEDULED_ORDER_MISMATCH: Token is tied to a different scheduled order
  • SCHEDULED_ORDER_NOT_FOUND: ScheduledOrderId doesn't exist for this site
  • CUSTOMER_NOT_FOUND: CustomerId provided doesn't exist for this site
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
int64
required

The unique identifier of the site

string
required

The unique slug of the QuickLink

Query Params
string

Optional token for single-use QuickLinks

Body Params

Verification request containing scheduled order ID, customer ID, and login status

int64
required
int64 | null
string | null
string | null
boolean
Headers
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

500

Internal server error occurred

Updated 2 months ago

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
text/plain
application/json
text/json

Updated 2 months ago