Skip to content

Mark every voicemail read

PATCH
/voice/voicemails/read-all

Bulk-clear unread voicemail. Read the assigned_to note first.

Declared BEFORE /voicemails/{voicemail_id}/read: read-all is a literal that the parameter route could otherwise capture as a voicemail id, and that route parses an integer, so the failure would be a 422 rather than an obvious 404.

Authorizations

Parameters

Query Parameters

sdr_email
required

Who is marking them read. Recorded against each row.

string

Who is marking them read. Recorded against each row.

assigned_to
Any of:
string

Narrow to one rep’s voicemails. OMITTING THIS CLEARS THE WHOLE ORGANISATION’S unread state, not just this rep’s.

Header Parameters

X-Target-Org-Id
Any of:
string

Responses

200

Successful Response

object
data
required

One voice object - a collection, an agent, a route, a chat.

Open-shaped: voice adds fields to these bodies on its own release cadence and a dropped-or-added key must not be a 500 in this service.

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
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