Assign Conversation

This endpoint allows you to assign a conversation to an agent or a team.

Settings:

URL	https://online.99digital.co.il/api/v1/accounts/{account_id}/conversations/{conversation_id}/assignments
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
conversation_id	The numeric id of the conversation	yes

Request body Parameters:

Parameter	type	Description	Required
assignee_id	integer	Id of the agent to whom the conversation is to be assigned	no
team_id	integer	Id of the Team. If the assignee_id is present, this parameter would be ignored	no

Request body example:

{
  "assignee_id": 0,
  "team_id": 0
}

Response:

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

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	Indicates whether the availability status of agent is configured to go offline automatically when away
confirmed	Indicates whether the agent 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	Indicates whether an agent can see all conversations in the account
thumbnail	Agent thumbnail

Created with the Personal Edition of HelpNDoc: Full-featured EBook editor