Add Agent

Add a new agent to an account.

Settings:

URL	https://online.99digital.co.il/api/v1/accounts/{account_id}/agents
Method	JSON via POST

Authorization:

Header Parameter	Description
api_access_token	user API key

The user API key provides access to endpoints based on the user permissions levels and can be obtained by visiting the profile page.

Path Parameters:

Parameter	Description	Required
account_id	The numeric id of the account	yes

Request body:

Parameter	type	Description	Required
name	string	Full name of the agent	yes
email	string	Email of the agent	yes
role	string	Whether its administrator or agent Enum: `"agent"` `"administrator"`	yes
availability_status	string	The availability setting of the agent Enum: `"available"` `"busy"` `"offline"`	no
auto_offline	boolean	Whether the availability status of agent is configured to go offline automatically when away	no

Response:

{
    "id": 0,
    "account_id": 0,
    "availability_status": "available",
    "auto_offline": true,
    "confirmed": true,
    "email": "string",
    "available_name": "string",
    "name": "string",
    "role": "agent",
    "see_all_conversations": false,
    "thumbnail": ""
}

Response-Explain:

Parameter	Description
id	Agent numeric id
account_id	Account numeric id
availability_status	The availability status of the agent Enum: `"available"` `"busy"` `"offline"`
auto_offline	Whether the availability status of agent is configured to go offline automatically when away
confirmed	whether or not the agent's account has been validated by clicking on the invitation email they received
email	Email of the agent
available_name
name	Full name of the agent
role	Whether its administrator or agent. Enum: `"agent"` `"administrator"`
see_all_conversations	Whether an agent can see all conversations
thumbnail	Agent thumbnail

Created with the Personal Edition of HelpNDoc: Free PDF documentation generator