Skip to main content
PATCH
Batch update agents

Authorizations

Authorization
string
header
required

Use your account ID as the username and your personal access token (PAT) as the password, or pass a Base64-encoded value directly in the Authorization header. For more information, see the personal access tokens guide.

Body

application/json
ids
string<uuid>[]

Unique object identifier

fields
object

Response

200 - application/json

Successful response.

ID
string<uuid>

Unique object identifier.

licenseID
integer

Unique account identifier.

createdAt
string<date-time>

The time of creation.

createdBy
string<uuid>

The creator identifier.

createdByType
enum<string>

The creator type.

Available options:
agent,
client,
system
updatedAt
string<date-time>

The time of last modification.

updatedBy
string<uuid>

The modification author identifier.

roles
enum<string>[]

Agent role

Available options:
owner,
normal,
viewer
teamIDs
string[]

A list of teams that agent is a member of.

email
string

The agent's email.

name
string

The full name.

status
enum<string>

The account status.

Available options:
active,
invited
avatar
string

The avatar URL.

jobTitle
string

The job title.

flags
object
settings
object
autoassignment
boolean

Enable autoassignment for the agent.

autoassignmentTeamIDs
string[]

A list of teams from which an agent can be auto-assigned.

signature
object