Skip to content

Create a custom call disposition

POST
/voice/dispositions

Create an org-level custom disposition (max 10 per org).

Voice enforces the cap, the preset color palette, and case-insensitive name uniqueness against both system and existing custom dispositions - errors surface as 400/409 with voice’s own detail message.

Authorizations

Parameters

Header Parameters

X-Target-Org-Id
Any of:
string

Request Body required

Body for creating an org-level custom disposition. Org admin only (enforced by voice; see the router docstring above).

object
color
required

Hex value from voice’s preset palette (e.g. ‘#10b981’). Invalid values 400.

string
description
Any of:
string
<= 200 characters
is_connected
required

Whether this outcome counts as a live connection in analytics.

boolean
name
required
string
>= 1 characters <= 40 characters

Responses

201

Successful Response

object
data
required
object
color
required
string
description
Any of:
string
id
required
integer
is_connected
required
boolean
key
required

Stable value to use in filters/writes, e.g. “custom_42”.

string
name
required
string
pagination
Any of:
object
has_next
required

Whether there are more pages

boolean
limit
required

Items per page

integer
next_cursor
Any of:
string
page
required

Current page number (1-indexed)

integer
total
required

Total number of items

integer

422

Validation Error

object
detail
Array<object>
object
loc
required
Array
msg
required
string
type
required
string