Skip to main content
PATCH
Set a voice line

Authorizations

Authorization
string
header
required

Access token issued by gs.service.id. Its access_identity claim carries team_sid, actor_sid and actor_type, and that team scope is authoritative.

Team-SID
string
header
required

Team scope for tokens that do not carry one. Ignored when the token already names a team.

Path Parameters

sid
string
required

The agent (ub_ag_…).

Required string length: 18
Pattern: ^ub_ag_

Body

application/json

Request body of update_agent_voice.

length
string | null

How long its replies run ("2 to 3 sentences"); null lets the line go.

Maximum string length: 160
questions
string | null

How it asks ("one, at the end"); null lets the line go.

Maximum string length: 160
register
string | null

The register ("du with agencies, Sie when they wrote Sie"); null lets the line go.

Maximum string length: 160
sign_off
string | null

How it signs off ("VG, Julia"); null lets the line go.

Maximum string length: 160

Response

update success envelope.

success
enum<boolean>
required
Available options:
true
operation
enum<string>
required
Available options:
update
item
object
required
updated_fields
string[]
required
previous_values
object
required
meta
object
required
kept_fields
string[]

The fields this write did not change because the person's own value stands on them (stamped person); read the item for what landed.