Inquirly

Update Agents in Inbox

PATCH

/api/v1/accounts/{account_id}/inbox_members

Inboxes

All agents except the one passed in params will be removed

Request Example

Shell

JavaScript

Java

Swift

curl --location --request PATCH '/api/v1/accounts//inbox_members' \
--header 'Content-Type: application/json; charset=utf-8' \
--data-raw '{
    "inbox_id": "string",
    "user_ids": [
        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,
        "availability_status": "available",
        "auto_offline": true,
        "custom_attributes": {}
    }
]

Request

Path Params

account_id

string

required

Body Params application/json; charset=utf-8

inbox_id

string

required

The ID of the inbox

user_ids

array[integer]

required

IDs of users to be added to the inbox

Examples

Responses

🟢200OK

application/json; charset=utf-8

Success

Body

Array of all active agents

array of:

integer

optional

uid

string

optional

name

string

optional

available_name

string

optional

display_name

string

optional

string

optional

account_id

integer

optional

role

enum<string>

optional

Allowed values:

agentadministrator

confirmed

boolean

optional

availability_status

enum<string>

optional

The availability status of the agent computed by Chatwoot.

Allowed values:

availablebusyoffline

auto_offline

boolean

optional

Whether the availability status of agent is configured to go offline automatically when away.

custom_attributes

object

optional

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

🟠403Forbidden

🟠404Record Not Found

🟠422Parameter Error

Add a New Agent

Remove an Agent from Inbox