Skip to main content
cURL

Authorizations

Authorization
string
header
required

Issued in Developers. Workspace/owner/scopes come from credential, never acting-user headers. API keys cannot manage API credentials.

Headers

Idempotency-Key
string
required

Persist one key for this logical operation before sending it. Reuse the same value only with the same method, path and body after a timeout. A changed request returns 409 idempotency_conflict; a matching retry returns the original response.

Pattern: ^[A-Za-z0-9._:-]{1,200}$

Path Parameters

id
string<uuid>
required

Subscription UUID returned by registration or listing. It must belong to the credential making this request.

Body

application/json
active
boolean
required

Use false to pause delivery. Setting true requires a previously verified receiver.

Response

The subscription active state was updated, or the saved response for the same operation was replayed.

id
string<uuid>
required

Subscription UUID chosen by the client when creating it.

name
string
required

Integration label.

url
string
required

HTTPS receiver URL.

events
enum<string>[]
required

Subscribed event types.

Available options:
contact.created,
contact.updated,
contact.deleted,
list.created,
list.updated,
list.deleted,
list.membership_updated,
call.created,
call.updated,
call.deleted,
call.completed,
call.disposition_updated,
recording.available,
transcript.available,
contact.access_revoked,
list.access_revoked
active
boolean
required

Whether delivery is enabled. Creating or replacing configuration pauses delivery until verification.

verifiedAt
string<date-time> | null
required

Time of the most recent successful verification, or null.

createdAt
string<date-time>
required

Subscription creation time in UTC.