Skip to main content
PUT
/
v0
/
tags
/
{id}
Update an existing tag
curl --request PUT \
  --url https://api.avidoai.com/v0/tags/{id} \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --header 'x-application-id: <api-key>' \
  --data '
{
  "name": "Updated API Documentation",
  "color": "#10B981",
  "description": "Updated description for API-related documentation"
}
'
{
  "data": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "name": "API Documentation",
    "color": "#3B82F6",
    "createdAt": "2024-01-05T12:34:56.789Z",
    "modifiedAt": "2024-01-05T12:34:56.789Z",
    "orgId": "org_123456789",
    "description": "Tag for API-related documentation"
  }
}

Authorizations

​
x-api-key
string
header
required

Your unique Avido API key

​
x-application-id
string
header
required

Your unique Avido Application ID

Path Parameters

​
id
string<uuid>
required

The unique identifier of the tag

Example:

"123e4567-e89b-12d3-a456-426614174000"

Body

application/json

Request body for updating an existing tag

​
name
string

Name of the tag

Minimum string length: 1
Example:

"Updated API Documentation"

​
color
string

Hex color code for the tag

Example:

"#10B981"

​
description
string | null

Optional description of the tag

Example:

"Updated description for API-related documentation"

Response

Tag updated successfully

Successful response containing the tag data

​
data
Tag · object
required

A tag that can be applied to documents for organization