Skip to main content
POST

Authorizations

X-Auth-Client
string
header
required

Your workspace client id.

X-Auth-Secret
string
header
required

Your sandbox client secret. The playground accepts sandbox keys only, sends the secret straight from your browser to the API, and needs your IP on the key's whitelist. In your own integration, sign requests with HMAC instead of sending the secret.

Path Parameters

customerId
string<uuid>
required

ID of the customer.

Body

application/json
sandbox
object

Sandbox keys only; refused on live.

Response

OK

Successful responses are wrapped in this envelope, and so are errors a handler answers itself (request body and field validation, some not-found and conflict cases, ORG_NOT_ACTIVE): success is false and error carries a code and message. Errors raised by authentication and by the services behind a handler are a Problem instead.

success
boolean
required

true on success

timestamp
string<date-time>
required

When the response was written.

data
object

The payload; its shape is given per operation. Omitted when there is none.

error
object
message
string

Human-readable summary; omitted when empty.

request_id
string

Set on error envelopes: the request's correlation id (req_ followed by a UUID), the same value as the X-Correlation-ID response header. Quote it to support.