Skip to content

Set Dialer Preferences

PUT
/dialer/settings/preferences

CONTACTS NOBODY DIRECTLY - but call_dnc_contacts decides WHO MAY BE CALLED.

Setting it true lets the dialer call numbers on a do-not-call list. That is a COMPLIANCE decision, not a convenience toggle, and it applies to every subsequent dial for this rep.

PATCH semantics despite the verb: only fields you send are changed, and omitted ones keep their stored value. The verb is the app’s.

Authorizations

Parameters

Header Parameters

X-Target-Org-Id
Any of:
string

Request Body required

Mirrors UserPreferencesRequest minus org_id.

call_dnc_contacts decides whether the dialer will call numbers on a do-not-call list. It is a compliance switch, not a convenience one.

object
auto_rotate_numbers
Any of:
boolean
call_dnc_contacts
Any of:
boolean
parallel_count
Any of:
integer
skip_voicemails
Any of:
boolean
user_email
required
string

Responses

200

Successful Response

object
data
required

An open envelope for one dialer result.

Open because voice owns the shape of a session, a call stub and a queue stat, and it grows them without a contract bump here. A dropped field would otherwise turn an added upstream field into a removed public one.

object
key
additional properties
any
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