Create Agent

post

https://api.beauthenticx.com/Agent

Adds an agent to your organization.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Common next steps after a POST /Agent/ call:

Use AgentCode when uploading interactions via /Media/Upload/ or /TextMedia/Upload/ to ensure they are attributed to this agent
Link the agent to a user account via PUT /Agent/ if not done at creation

Body Params

firstName

string

required

length ≥ 1

The first name of the new agent you intend to add

lastName

string

required

length ≥ 1

The last name of the new agent you intend to add

agentEmail

string

required

length ≥ 1

The email of the new agent you intend to add

agentCode

string | null

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

osms

array of uuids | null

List of hierarchy node Id values (UUIDs) to assign this agent to. The agent is also automatically assigned to all nodes in each assigned node's parent chain

osms

userId

string | null

The Id of a platform user to link to this agent. Must be an active user in your organization

managerId

string | null

The ID of this agent's manager

startDate

string | null

The date this agent started employment

Responses

400

A user id was provided but did not correspond to an existing, active, user in your organization

200Returns the newly created agent