Skip to main content
PATCH
Update an agent

Authorizations

Authorization
string
header
required

An org API key: Authorization: Bearer phk_…

Headers

If-Match
string | null

The ETag from your last read: the change is made only if the resource still has it, otherwise 412. Optional, except that a change replacing a list needs it (428 without it).

Phonely-Organization
string | null

Optional. Must be the key's org.

Path Parameters

id
string
required

The agent's ID.

Body

application/json

The agent's new name.

name
string
required

The name shown in the web app: 1 to 50 characters, without spaces at either end, which are dropped. It needn't be unique.

Required string length: 1 - 50

Response

Successful Response

An agent: a voice agent that answers and places the organization's calls.

id
string
required

The agent's ID.

name
string | null
required

The name shown in the web app. null when the agent has none.

object
string
default:agent
required

The type of this object, always agent.

Allowed value: "agent"
phone_number
string | null
required

The agent's primary phone number in E.164, such as +14155550100. null when it has none, or when its primary line is a SIP address.