Edit a twin, optionally with a new writing-style document

PUT

/voice/twins/{agent_id}

• Production
• QA

SPENDS NOTHING beyond storage. Partial update: only the fields sent change. Multipart because voice binds every field as a form field so the optional writing-style document can travel with them. 404 when the twin is not this organisation’s.

Authorizations

• BearerAuth

Parameters

Path Parameters

agent_id

required

Twin agent id.

string

Twin agent id.

Header Parameters

X-Target-Org-Id

Any of:

string

string

null

null

Request Body

object

assertiveness

Any of:

number

number

null

null

avatar_url

Any of:

string

string

null

null

background

Any of:

string

string

null

null

calendar

Any of:

string

string

null

null

company_name_pronunciation

Any of:

string

string

null

null

conciseness

Any of:

number

number

null

null

description

Any of:

string

string

null

null

inbound_instructions

Any of:

string

string

null

null

linkedin_data

Any of:

string

string

null

null

linkedin_url

Any of:

string

string

null

null

name

Any of:

string

string

null

null

outbound_instructions

Any of:

string

string

null

null

outbound_voicemail_prompt

Any of:

string

string

null

null

persona

Any of:

string

string

null

null

phone

Any of:

string

string

null

null

role

Any of:

string

string

null

null

tone

Any of:

number

number

null

null

use_company_knowledge

Any of:

boolean

boolean

null

null

voice

Any of:

string

string

null

null

writing_style_file

Any of:

string

string format: binary

null

null

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:

PaginationMeta

object

has_next

required

Whether there are more pages

boolean

limit

required

Items per page

integer

next_cursor

Any of:

string

string

null

null

notes

Any of:

Array<string>

Array<string>

null

null

page

required

Current page number (1-indexed)

integer

total

required

Total number of items

integer

total_available

Any of:

integer

integer

null

null

total_is_lower_bound

Any of:

boolean

boolean

null

null

null

null

422

Validation Error

object

detail

Array<object>

object

loc

required

Array

msg

required

string

type

required

string