Inbox
The Inbox resource allows you to Retrieve and Update conversations and tags. The following actions can be performed on this resource...
Retrieve All Conversations
By default, the first set of 250 conversations will be returned, but you can modify this number with limit and offset values in the query string. The max limit for a single request is 10,000. You can also retrieve your data with pagination. You do this by passing the page and pageSize query string parameters. Page determines which page number to bring back and pageSize determines the number of conversations to bring back in that page.
When retrieving multiple conversations, you may want to include additional criteria in the query string to filter the results by. Any field that is included in the resources is available for use as a filter. These are exact matches; they are case-sensitive and do not allow wildcards.
Example Response:
{
"data": [
{
"_id": "6744a2ba587c8f2cf4028786",
"_brand_id": 1234567983,
"_contact_id": 111111,
"status": "open",
"_last_message_id": "6744a2ba97274144ab0cc232",
"last_message": "Great Thanks!",
"last_message_direction": "incoming",
"last_message_sent": "2024-11-25 16:15:54",
"_assigned_to_user_id": 3333,
"created": "2024-11-25 16:15:54",
"updated": "2024-11-26 18:48:11",
"_inbox_tag_ids": [
4,
5
]
}
]
}
Retrieve a Specific Conversation
Retrieves a single conversation with the Conversation ID equal to {id}.
Example Response:
{
"_id": "6744a2ba587c8f2cf4028786",
"_brand_id": 1234567983,
"_contact_id": 111111,
"status": "open",
"_last_message_id": "6744a2ba97274144ab0cc232",
"last_message": "Great Thanks!",
"last_message_direction": "incoming",
"last_message_sent": "2024-11-25 16:15:54",
"_assigned_to_user_id": 3333,
"created": "2024-11-25 16:15:54",
"updated": "2024-11-26 18:48:11",
"_inbox_tag_ids": [
4,
5
]
}
Edit a Specific Conversation
Allows you to edit an existing conversation. You can target an existing conversation by passing the Conversation ID in your PUT request. At least one of the arguments below is required.
Arguments
| PARAMETER | DESCRIPTION |
|---|---|
| _assigned_to_user_id | Assign conversation to user |
| _inbox_tag_ids[] | Tag conversation |
| status | Update status of conversation (open, pending, closed) |
| unread | Mark conversation as read/unread |
Example Request:
{
"data": [
{
"_id": "6744a2ba587c8f2cf4028786",
"_brand_id": 1234567983,
"_contact_id": 111111,
"status": "open",
"_last_message_id": "6744a2ba97274144ab0cc232",
"last_message": "Great Thanks!",
"last_message_direction": "incoming",
"last_message_sent": "2024-11-25 16:15:54",
"_assigned_to_user_id": 3333,
"created": "2024-11-25 16:15:54",
"updated": "2024-11-26 18:48:11",
"_inbox_tag_ids": [
4,
5
]
}
]
}
Retrieve Inbox Tags
By default, the first set of 250 inbox tags will be returned, but you can modify this number with limit and offset values in the query string. The max limit for a single request is 10,000. You can also retrieve your data with pagination. You do this by passing the page and pageSize query string parameters. Page determines which page number to bring back and pageSize determines the number of inbox tags to bring back in that page.
When retrieving multiple inbox tags, you may want to include additional criteria in the query string to filter the results by. Any field that is included in the resources is available for use as a filter. These are exact matches; they are case-sensitive and do not allow wildcards.
Example Response:
{
"data": [
{
"inbox_tag_id": 4,
"_brand_id": 3,
"name": "Nashville",
"description": null,
"color": "#e69138",
"untag_on_thread_close": 0,
"created": "2024-10-31 15:23:00"
}
]
}
Retrieve a Specific Inbox Tag
Retrieves a single inbox tag with the Inbox Tag ID equal to {id}.
Example Response:
{
"inbox_tag_id": 4,
"_brand_id": 3,
"name": "Nashville",
"description": null,
"color": "#e69138",
"untag_on_thread_close": 0,
"created": "2024-10-31 15:23:00"
}
Edit a Specific Inbox Tag
Allows you to edit an existing inbox tag. You can target an existing inbox tag by passing the Inbox Tag ID in your PUT request. At least one of the arguments below is required.
Arguments
| PARAMETER | DESCRIPTION |
|---|---|
| name | Name of the Inbox Tag. |
| description | Description of your inbox tag. |
| active | Indicate whether the Link is active (1 or 0). |
Example Request:
{
"inbox_tag_id": 4,
"_brand_id": 3,
"name": "Nashville",
"description": “Visited Nashville Store”,
"color": "#e69138",
"untag_on_thread_close": 0,
"created": "2024-10-31 15:23:00"
}
Delete Inbox Tag
Delete an inbox tag with the Inbox Tag ID equal to {id}.
Example Response:
[]