Errors

Failures are application/problem+json. type links to the entry below (https://app.clearslot.eu/docs/errors#<code>), code is stable, detail is an English sentence you can show to people, and requestId helps support find the request.

unauthorized

Status 401. The request has no valid API key or access token.

credential_expired

Status 401. This API key has expired. Create a new key in Clearslot under Settings, Developers.

credential_revoked

Status 401. This API key has been revoked. Create a new key in Clearslot under Settings, Developers.

forbidden

Status 403. This credential is not allowed to do this.

insufficient_scope

Status 403. This credential does not have the scope this request needs.

ip_not_allowed

Status 403. This API key cannot be used from this IP address. Check the key's IP allowlist.

organization_ineligible

Status 403. This business cannot use Clearslot at the moment. Contact Clearslot support.

plan_required

Status 402. The Clearslot API is part of Pro. Upgrade the business in Clearslot to continue.

plan_limit

Status varies. The current Clearslot plan of this business does not include this.

api_access_suspended

Status 403. API access for this business is suspended. Contact Clearslot support.

api_unavailable

Status 503. The Clearslot API is not available for this business.

account_step_required

Status 409. The account has a step to finish in Clearslot first.

reauthentication_required

Status 403. Confirm your password or two-factor code, then try again.

not_found

Status 404. The resource does not exist, or this credential cannot see it.

invalid_input

Status 400. The request is not valid. The errors field lists what to fix.

payload_too_large

Status 413. The request body is larger than 250 KB.

conflict

Status 409. The request conflicts with the resource's current state.

limit_reached

Status 409. The business has reached its limit for this kind of resource.

slot_unavailable

Status 409. That time is not available. Choose another time.

online_payment_unsupported

Status 409. This booking link takes online payment, which bookings made through the API cannot use yet.

rate_limited

Status 429. Too many requests. Wait for the number of seconds in Retry-After, then try again.

concurrency_limited

Status 429. Too many requests for this business are running at once. Try again in a moment.

daily_quota_exceeded

Status 429. The business has used its daily API quota. It resets at midnight UTC.

service_busy

Status 503. Clearslot is busy. Wait for the number of seconds in Retry-After, then try again.

idempotency_conflict

Status 409. This Idempotency-Key was already used with a different request.

idempotency_in_progress

Status 409. A request with this Idempotency-Key is still running.

unexpected_error

Status 500. Something went wrong on our side. Try again later, and quote the request ID if it keeps happening.