Change an agent's job, mailbox or connection

Before you call

Credential

Authorization: Bearer $KEY

Scope

agents:write

Graphql

Mutation.agentsAgentUpdate

Sdk

agents.agent.update

Cli

agents agent update

Parameters

• idstring (uuid)required
  In the path

Request bodyapplication/json, required

• namestring
  At most 80 characters.
• jobstring
  At most 200 characters.
• remitstring
  At most 2000 characters.
• mailboxstring or null
• connectionIdstring (uuid) or null
• phoneConnectionIdstring (uuid) or null
• voicestring or null
• tonestring
  One of: warm, plain, formal.
• signaturestring
  At most 500 characters.
• serviceslist of string
• accentstring or null

Responses

• 200application/json
  Success

  object

• 400application/json
  The request was malformed
  • errorstringrequired
  • messagestring
• 401application/json
  No valid credential
  • errorstringrequired
  • messagestring
• 403application/json
  The credential lacks the scope, origin or address
  • errorstringrequired
  • messagestring
• 429application/json
  Over the key's rate limit; see Retry-After
  • errorstringrequired
  • messagestring