Skip to content

Reconcile a collection's records with its stored files

POST
/voice/collections/{collection_id}/sync

SPENDS NOTHING. Drops records whose file is gone and adds records for files that have none. Try dry_run=true first. Voice 404s another tenant’s collection. (The every-organisation sync/all is not published.)

Authorizations

Parameters

Path Parameters

collection_id
required

Collection id.

integer
>= 1

Collection id.

Query Parameters

dry_run

Report what would change without changing it.

boolean

Report what would change without changing it.

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