Remove Conversation Tag
Remove a tag from a conversation. Supply its conversation_id in the path and the tag name in the name query parameter.
Tags belong to the conversation's contact, so the tag is removed from the contact and its other conversations. The tag itself is not deleted from your workspace. Removing a tag the contact does not have succeeds without changes. Tags require a Pro plan; on other plans the request returns 403.
Returns 200 OK with the conversation, contact and tag name.
DELETE https://developers.chatway.app/api/v1/conversations/{conversation_id}/tagsExample request
curl -X DELETE "https://developers.chatway.app/api/v1/conversations/0f46c0a1-8938-40e3-b2b5-bb56f569fcab/tags?name=vip" \
-H "X-API-KEY: your_api_key"Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
name | query | Yes | string | Name of the tag to remove. Example: vip |
conversation_id | path | Yes | string | Conversation ID Example: 0f46c0a1-8938-40e3-b2b5-bb56f569fcab |
Responses
200
application/json
message (string, required)data (object, required)conversation_id (string, required)contact_id (string, required)tag (string, required)
422
403
Tags require a Pro plan
application/json
message (string, required)
404
Conversation not found
application/json
message (string, required)
Examples
Response 200 example
{
"message": "Tag removed.",
"data": {
"conversation_id": "0f46c0a1-8938-40e3-b2b5-bb56f569fcab",
"contact_id": "9b0c5fe6-35ad-459d-b6ba-4288191f84f1",
"tag": "vip"
}
}