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
    • Send Interactive Buttons
      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
    • Assign Conversation
  • Tags API
    • Tag a conversation
      POST
    • Create Tag
      POST
    • Delete Tag
      DELETE
    • Update Tag
      PUT
    • List Tags
      GET
  • Outbound IVR
    • Create Outbound IVR
    • Get Outbound IVR Request
  • Outbound IVR Flows
    • Create Outbound IVR Flow
    • List Outbound IVR Flows
    • Get Outbound IVR Flow
    • Update Outbound IVR Flow
    • Delete Outbound IVR Flow
  • Tasks API
    • Create Task
    • List Tasks
    • Get Task
    • Update Task
    • Delete Task
    • List Task Properties
    • Create Task Property
    • List Task Projects
    • Create Task Project
    • Get Task Project
    • Rename Task Project
    • Delete Task Project
    • List Task Sections
    • Create Task Section
    • List Tasks By Conversation
    • Move Task
    • Schedule Task
    • Assign Task
    • Set Task Due Date
    • Complete Task
    • Reopen Task
    • Set Task Section
    • Move Task Project
    • Rename Task Section
    • Delete Task Section
    • Move Task Section
    • Update Task Property
    • Delete Task Property
    • Set Task Property Value
    • List Task Comments
    • Create Task Comment
    • Edit Task Comment
    • Delete Task Comment
    • Set Task Reminder
  • Teams API
    • Create Team
    • Get Team
    • Update Team
    • Delete Team
    • Add Team Members
    • Update Team Member Conversation Access
    • Remove Team Member
    • List Teams
    • List Team Member Options
    • List Team Assignment Targets
    • Assign Conversation to Team
  • Partner API
    • 2. Register customer
      • 1) Create registration
      • Update registration details
      • Resend mobile code
      • 2) Verify mobile code
      • 3) Send email code
      • 4) Verify email code
      • 5) Complete registration → workspace + workspace key
      • Issue another workspace key
    • 3. Subscribe (plan & balance)
      • Add wallet balance (top-up) → payment link
      • Plans you can sell (find the Builder plan ID)
      • Get wallet balance
      • Create quote (plan) → payment link
      • Get quote status (poll for payment)
    • 4. Phone number
      • Assign number (after payment)
      • Available numbers
      • List the workspace's channels
    • 5. Contract
      • Replaced: use Get activation link
      • Replaced: number status is on the channel
      • Get activation link
    • 6. AI agent (SIP)
      • Connect the number to your AI agent
      • Disconnect your AI agent
    • 7. Calls & events
      • Not available yet: list calls
      • Not available yet: set events webhook
  • Call Webhook
  • WhatsApp Message Webhook
  • Schemas
    • Call Webhook
    • WhatsApp Message Webhook
    • ServiceAccountTemplateDto
    • OutboundIvrOption
    • ConversationDto
    • RegistrationDetails
    • CreateTagDto
    • AbpError
    • ServiceAccountTemplateParameterDto
    • OutboundIvrQuestionStepProps
    • ChannelConversationDto
    • UpdateTagDto
    • TaskPropertyValue
    • CreateRegistration
    • ServiceAccountCreateTaskDto
    • TemplateParameterDto
    • OutboundIvrStep
    • OtpCode
    • TagDto
    • PagedResultOfTagDto
    • TaskActivityPropertySnapshot
    • ConversationTimelineDto
    • ApiCredential
    • ParameterValueDto
    • CreateOutboundIvrRequest
    • TaskActivitySnapshot
    • SaveOutboundIvrFlow
    • ChannelNotFoundError
    • OutboundIvrFlow
    • Quote
    • AiSummaryDto
    • TaskActivityDto
    • ReplyInfoDto
    • OutboundIvrAnswer
    • TaskSummaryDto
    • InternalThreadDto
    • OutboundIvrStatus
    • TaskDto
    • LocationMessageDto
    • OutboundIvrResult
    • PagedResultOfTaskDto
    • AssignationInfoDto
    • TaskPropertyDefinitionDto
    • PagedResultOfConversationDto
    • OutboundIvrAudioType
    • OutboundIvrRequest
    • PagedResultOfConversationTimelineDto
    • TaskProjectDto
    • TaskSectionDto
    • OutboundIvrWebhookPayload
    • PagedResultOfTaskProjectDto
    • PagedResultOfTaskSectionDto
    • UpdateTaskDto
    • MoveTaskDto
    • SetTaskSectionDto
    • SetTaskScheduleDto
    • AssignTaskDto
    • SetTaskDueDateDto
    • NameDto
    • MoveBeforeDto
    • TaskPropertyOptionDto
    • CreateTaskPropertyDto
    • UpdateTaskPropertyDto
    • TaskCommentDto
    • WriteTaskCommentDto
    • PagedResultOfTaskCommentDto
    • SetTaskReminderDto
  1. Tags API

Update Tag

PUT
/v1/tags/service-account/id
Updates an existing tag's name, icon, description, or pinned status. Only the fields you include are changed — any field left out keeps its current value.
Notes:
If you try to rename a tag to a name that's already used by another tag in the workspace, the request fails with a clear error.
If the tag ID doesn't exist, or belongs to a different workspace, you'll get a "not found" error.
Sending an empty value for name, icon, or description is treated the same as not sending it at all — these fields can only be set to a new value, they cannot currently be cleared back to empty through this endpoint.
isPinned is the one exception — it behaves as a true optional field (omit it to leave unchanged; send false to actually unpin).

Request

Authorization
OAuth 2.0
Client Credentials
Add the parameter
Authorization
to Headers
,whose value is to concatenate the Token after the Bearer.
Example:
Authorization: Bearer ********************
Token URL: https://api.voxa.sa/connect/token
Scopes:
VoxaAPI-Access Voxa API as a service account
or
Body Params application/jsonRequired

Examples

Responses

🟢200OK
application/json
Tag updated successfully.
Bodyapplication/json

🟠401Unauthorized
🟠403Forbidden
🟠404Record Not Found
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request PUT 'https://api.voxa.sa/v1/tags/service-account/id' \
--header 'Content-Type: application/json' \
--data '{
    "name": "VIP Customer",
    "isPinned": false
}'
Response Response Example
{
    "id": "3a1ebef0-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
    "name": "VIP Customer",
    "icon": "⭐",
    "isPinned": false,
    "creationTime": "2026-06-22T10:00:00Z"
}
Modified at 2026-06-22 16:07:58
Previous
Delete Tag
Next
List Tags
Built with