Conversation Tags
Conversation tags are labels used to categorize and filter conversations in your Oktopost Inbox. Use these endpoints to list, retrieve, update, and delete tag definitions.
List Tags
Retrieve all conversation tags for the account.
Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
| q | String | No | Search term to filter tags by name. |
| _page | Integer | No | Page number for pagination. |
| _count | Integer | No | Number of results per page (max 20). |
| _order | String | No | Sort field and direction, e.g. name,1 for ascending by name. |
Example Request
curl -i https://api.oktopost.com/v2/conversation-tagExample Result
{
"Result": true,
"Items": [
{
"Id": "etg000000000001",
"Value": "Support"
},
{
"Id": "etg000000000002",
"Value": "VIP"
}
],
"Total": 2
}Get Tag
Retrieve a single conversation tag by ID.
Example Request
curl -i https://api.oktopost.com/v2/conversation-tag/etg000000000001Example Result
{
"Result": true,
"Tag": {
"Id": "etg000000000001",
"Value": "Support"
}
}Update Tag
Rename an existing conversation tag.
Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
| tag | String | Yes | The new tag name (max 64 characters). |
Example Request
curl -i https://api.oktopost.com/v2/conversation-tag/etg000000000001 -X POST \
-d tag="Customer Support"Example Result
{
"Result": true
}Delete Tag
Delete a conversation tag. The tag will be removed from all conversations it was assigned to.
Example Request
curl -i https://api.oktopost.com/v2/conversation-tag/etg000000000001 -X DELETEExample Result
{
"Result": true
}Conversations
Manage Inbox items including direct messages, post comments, mentions, and replies from connected profiles. Use these endpoints to list, view, update, and act on any conversation in your Oktopost Inbox.
Canned Responses
Canned responses are reusable reply templates that help your team respond to conversations quickly and consistently. Use these endpoints to list, retrieve, and create canned responses.