Agents

Update Agent

Update an existing agent.

put/agents/{id}

Path parameters

idstring required

The ID of the agent to update.

The ID of the agent to update.

Request body

namestring required

The display name of the agent.

fullNamestring required

The full name of the agent.

sendInviteboolean

Whether this update should send a new email invite to the agent.

Response

Returns the updated agent.

idstring required

The ID of the agent.

type'agent' required

The type of object the attached ID corresponds to.

namestring required

The display name of the agent.

fullNamestring required

The full name of the agent.

phoneNumberstring

The phone number of the agent.

organizationIdstring required

The ID of the organization the agent belongs to.

groupIdstring required

The ID of the group the agent belongs to.

createdAtstring required

An ISO-8601 string representing the date the agent was created.

Changes