Inquirly

Assign Conversation

POST

/api/v1/accounts/{account_id}/conversations/{conversation_id}/assignments

Conversation Assignment

Assign a conversation to an agent or a team

Request Example

Shell

JavaScript

Java

Swift

curl --location --request POST '/api/v1/accounts//conversations//assignments' \
--header 'Content-Type: application/json; charset=utf-8' \
--data-raw '{
    "assignee_id": 0,
    "team_id": 0
}'

Response Example

200 - Example 1

{
    "id": 0,
    "uid": "string",
    "name": "string",
    "available_name": "string",
    "display_name": "string",
    "email": "string",
    "account_id": 0,
    "role": "agent",
    "confirmed": true,
    "custom_attributes": {},
    "accounts": [
        {
            "id": 0,
            "name": "string",
            "role": "administrator"
        }
    ]
}

Request

Path Params

account_id

string

required

conversation_id

string

required

Body Params application/json; charset=utf-8

assignee_id

number

optional

Id of the assignee user

team_id

number

optional

Id of the team. If the assignee_id is present, this param would be ignored

Examples

Responses

🟢200OK

application/json; charset=utf-8

Success

Body

number

optional

uid

string

optional

name

string

optional

available_name

string

optional

display_name

string

optional

string

optional

account_id

number

optional

role

enum<string>

optional

Allowed values:

agentadministrator

confirmed

boolean

optional

custom_attributes

object

optional

Available for users who are created through platform APIs and has custom attributes associated.

accounts

array[object (account) {3}]

optional

number

optional

Account ID

name

string

optional

Name of the account

role

enum<string>

optional

The user role in the account

Allowed values:

administratoragent

🟠401Unauthorized

🟠404Record Not Found

Toggle Priority

List Labels