Create a new tag

Creates a new tag with the provided information.

POST /v0/tags

JavaScript

JavaScript

import Avido from 'avido';

const client = new Avido({
  apiKey: process.env['AVIDO_API_KEY'], // This is the default and can be omitted
  applicationID: process.env['AVIDO_APPLICATION_ID'], // This is the default and can be omitted
});

const tag = await client.tags.create({ name: 'API Documentation' });

console.log(tag.data);

201

{
  "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",
    "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

Body

application/json

Request body for creating a new tag

name · string · required

Name of the tag

Minimum string length: 1

Example:

"API Documentation"

color · string · default: #3B82F6

Hex color code for the tag

Pattern: ^#[0-9A-Fa-f]{6}$

Example:

"#3B82F6"

description · string

Optional description of the tag

Example:

"Tag for API-related documentation"

Response

201

application/json

Tag created successfully

Successful response containing the tag data

data · Tag · object · required

A tag that can be applied to documents for organization

Show child attributes