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

Required. Omitting this header returns 400 idempotency_key_required and changes nothing; a value outside the pattern returns 400 idempotency_key_invalid. 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}$

Body

application/json
name
string
required

Trimmed, case-sensitive label. Built-in names are reserved.

Required string length: 1 - 100
mappedDispositions
enum<string>[]
required

Ordered built-in mappings. The first mapping drives CRM, DNC and automation. Duplicates are removed in order.

Required array length: 1 - 19 elements
Available options:
NotDisposed,
LeftVoicemail,
Busy,
Gatekeeper,
NoAnswer,
BadNumber,
NotInService,
Positive,
Neutral,
Negative,
AnsweringMachine,
WrongNumber,
NotInterested,
DoNotCall,
NotAvailable,
Sold,
MeetingBooked,
NoShow,
PresentedNoSale

Response

Successful operation.

id
integer
required

Stable custom disposition definition ID.

Required range: x >= 1
workspaceId
string
required

Workspace that owns this shared definition.

name
string
required

Trimmed, case-sensitive label. Built-in names are reserved.

Required string length: 1 - 100
mappedDispositions
enum<string>[]
required

Ordered built-in mappings. The first mapping drives CRM, DNC and automation. Duplicates are removed in order.

Required array length: 1 - 19 elements
Available options:
NotDisposed,
LeftVoicemail,
Busy,
Gatekeeper,
NoAnswer,
BadNumber,
NotInService,
Positive,
Neutral,
Negative,
AnsweringMachine,
WrongNumber,
NotInterested,
DoNotCall,
NotAvailable,
Sold,
MeetingBooked,
NoShow,
PresentedNoSale
createdAt
string<date-time>
required
updatedAt
string<date-time>
required