Skip to main content
POST
/
v0
/
tags
/
{id}
/
archive
Archive a tag
curl --request POST \
  --url https://api.avidoai.com/v0/tags/{id}/archive \
  --header 'x-api-key: <api-key>' \
  --header 'x-application-id: <api-key>'
{
  "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",
    "applicationId": "456e4567-e89b-12d3-a456-426614174000",
    "status": "ACTIVE",
    "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

Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
Example:

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

Response

Successfully archived tag

Successful response containing the tag data

​
data
Tag · object
required

A tag that can be applied to documents for organization