1. Tags API
Hatif
  • Rate Limiting
  • Account API
    • Service Login
      POST
  • Channels API
    • Get Channels
      GET
  • Support API
    • Upload Image, Video, or PDF
      POST
    • Upload Audio File
      POST
  • Whatsapp API
    • Send Text
      POST
    • Send Template
      POST
    • Send Image
      POST
    • Send Audio
      POST
    • Send Video
      POST
    • Send File
      POST
    • List Templates (Service Account)
      GET
  • Contact
    • Set Property Value on Contact
      PUT
    • Search Contacts
      POST
    • Delete Property Value on Contact
      DELETE
    • Create Contact
      POST
    • Update Contact
      PUT
    • Get Contacts
      GET
    • Get Contact By Id
      GET
    • Create Bulk Contacts vCards
      POST
    • Contacts History
      GET
  • Contact Properties
    • List Contact Properties
    • Contact Properties Statistics
    • Create Contact Property
    • Update Contact Property
    • Delete Contact Property
  • Workspace API
    • Get Workspace Users
  • Conversations API
    • Get Conversation Timeline
    • List Conversations
    • Create Conversation
    • Assign Conversation
    • Get Conversation
  • Outbound IVR API
    • Create Outbound IVR
  • Tags API
    • Tag a conversation
      POST
    • Create Tag
      POST
    • Delete Tag
      DELETE
    • Update Tag
      PUT
    • List Tags
      GET
  • Conversations - Service Account
  • Call Webhook
  • WhatsApp Message Webhook
  • Schemas
    • Call Webhook
    • WhatsApp Message Webhook
    • ServiceAccountTemplateDto
    • ConversationDto
    • CreateTagDto
    • ServiceAccountTemplateParameterDto
    • ChannelConversationDto
    • UpdateTagDto
    • TemplateParameterDto
    • TagDto
    • ParameterValueDto
    • ConversationTimelineDto
    • PagedResultOfTagDto
    • ChannelNotFoundError
    • AiSummaryDto
    • ReplyInfoDto
    • InternalThreadDto
    • LocationMessageDto
    • AssignationInfoDto
    • PagedResultOfConversationDto
    • PagedResultOfConversationTimelineDto
  1. Tags API

Tag a conversation

POST
/v2/conversations/service-account/conversationId/tags
Sets the full list of tags on a conversation. This is a full replace, not incremental — any tag currently attached but not included in TagIds is removed, and any new tag ID is attached.
IntentWhat to send
Set tagsArray of all desired tag IDs
Add a tagFetch current tags, append the new ID, resend the full list
Remove one tagFetch current tags, drop that ID, resend the remaining list
Clear all tagsEmpty array []
Use GET /v1/tags/service-account to list all available tags and their IDs.
Response: 200 OK with an empty body. To verify the updated state, call GET /v2/conversations/service-account/{conversationId} afterward.

Request

Path Params

Body Params application/json

Examples

Responses

🟢200OK
application/json
Tags updated successfully. Empty body — call GET /v2/conversations/service-account/{conversationId} to verify the updated state.
Bodyapplication/json

🟠401Unauthorized
🟠403Forbidden
🟠404Record Not Found
Request Request Example
Shell
JavaScript
Java
Swift
cURL
curl --location 'https://api.voxa.sa/v2/conversations/service-account/conversationId/tags' \
--header 'Content-Type: application/json' \
--data '{
    "TagIds": [
        "3a1d7c...............",
        "3a1acd..............."
    ]
}'
Response Response Example
200 - Example 1
{}
Modified at 2026-07-27 12:05:18
Previous
Create Outbound IVR
Next
Create Tag
Built with