Update Agent

put

https://api.beauthenticx.com/Agent/{AgentId}

Updates information about an existing agent in your organization.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

⚠️
Note on hierarchy assignments:
Providing osms is a full replacement, not a merge. To add a new hierarchy to an existing list, include all current hierarchy IDs plus the new one. Assigning to a child node automatically includes all nodes in its parent chain.

Path Params

AgentId

uuid

required

UUID of the agent to update

Body Params

firstName

string | null

The first name of the agent

lastName

string | null

The last name of the agent

agentEmail

string | null

The email of the agent

agentCode

string | null

Your organization's internal identifier for this agent. Used to match agents when uploading interactions

isActive

boolean | null

Set to false to deactivate the agent

osms

array of uuids | null

Replaces the agent's full list of hierarchy assignments. If omitted, existing assignments are preserved. Assigning to a child node automatically includes all nodes in its parent chain

osms

userId

string | null

UUID of a platform user to link to this agent. Pass the string "remove" to unlink the currently associated user

managerId

string | null

The ID of this agent's manager. Pass the string "remove" to unlink the currently associated manager-user from the agent-user

startDate

string | null

The date this agent started employment

Responses

400

A UserId was provided that corresponded to an inactive or non existent user

404

If your organization has no agent with that specific id

Language

Credentials

OAuth2

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

Note on hierarchy assignments:

200Returns the updated agent