API reference

Booking links

8 operations.

GET /v1/links/path-check

Whether a path can be saved in this account. The answer is the slug the path would be stored as.

Operation id
checkLinkPath
Who can call it
Acts in one account, the one the credential belongs to.
Credentials
session or API key
Permission
links.read
Assistant tool
No. Not in the first set of tools (decision 0043, point 9).

Parameters

Name In Type Required Notes
path query string yes

Answers

200 The normalised path, and why it cannot be saved when it cannot. application/json

Field Type Always sent Notes
path string yes
available boolean yes
problems array of string yes

Refusals

Status Meaning Codes
400 The request is not valid. invalid_request
401 Sign in is required. unauthenticated
403 You are not allowed to do that. Choose an account to act in first. forbidden , no_active_account
429 Too many attempts. rate_limited