Sign in
latestOpenAPI 3.1.02026-08-13233474.8 KB

e920ac8ed225

Agents

Create Agent

Create a new agent. This will send an email invite to the agent being created if they are not already a Hustle user.

post/agents

Request body

namestring required

The display name of the agent.

fullNamestring required

The full name of the agent.

emailstring email required

The email of the agent - This will be used by the agent to log in.

groupIdstring required

The ID of the group the agent will belong to.

Response

Returns the created 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.