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

Body Params application/jsonRequired

Examples

Responses

🟢200OK

application/json

Tag updated successfully.

Bodyapplication/json

🟠401Unauthorized

🟠403Forbidden

🟠404Record Not Found

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 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

Delete Tag

List Tags