Skip to content

Edit a custom call disposition

PATCH
/voice/dispositions/{disposition_id}

Edit a custom disposition. Only supplied fields change.

is_connected is locked by voice once any call already references the disposition (would retroactively re-classify historical calls) - that 409 is forwarded as-is. A disposition belonging to another org 404s (voice’s _load_disposition_for_org checks the stored row’s org against X-Org-Id before allowing the edit).

Authorizations

Parameters

Path Parameters

disposition_id
required

Custom disposition id.

integer

Custom disposition id.

Header Parameters

X-Target-Org-Id
Any of:
string

Request Body required

Body for editing a custom disposition. Only supplied fields change.

is_connected is locked by voice once any call already references the disposition (changing it would retroactively re-classify historical calls) - forwarded as-is and voice’s 409 surfaces to the caller.

object
color
Any of:
string
description
Any of:
string
<= 200 characters
is_connected
Any of:
boolean
name
Any of:
string
>= 1 characters <= 40 characters

Responses

200

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
notes
Any of:
Array<string>
page
required

Current page number (1-indexed)

integer
total
required

Total number of items

integer
total_available
Any of:
integer
total_is_lower_bound
Any of:
boolean

422

Validation Error

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