Pular para o conteúdo principal
POST
/
tags
Criar uma definição de tag
curl --request POST \
  --url https://api.altostrat.io/tags \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "key": "Status do Site",
  "color": "#4CAF50",
  "mandatory_on": [
    "site"
  ]
}'
{
  "id": "tag_01E8Z4Q6J7B6A5P4E3D2C1B0A9",
  "key": "Região",
  "color": "#3F51B5",
  "mandatory_on": [
    "site"
  ],
  "created_at": "2025-10-29T12:00:00Z",
  "updated_at": "2025-10-29T12:30:00Z"
}

Authorizations

Authorization
string
header
required

Um token bearer é necessário para todas as requisições da API.

Body

application/json

Os detalhes da definição de tag a ser criada.

key
string
required

O nome de exibição para a categoria da tag.

Maximum length: 100
Example:

"Segmento de Cliente"

color
string
required

Um código de cor hexadecimal para exibição na interface do usuário.

Example:

"#FF9800"

mandatory_on
enum<string>[]

Uma lista de tipos de recursos para os quais esta tag é obrigatória.

Response

A definição de tag foi criada com sucesso.

id
string

O identificador único para a definição da tag.

Example:

"tag_01E8Z4Q6J7B6A5P4E3D2C1B0A9"

key
string

O nome de exibição para a categoria da tag (ex: "Região", "Prioridade").

Example:

"Região"

color
string

Um código de cor hexadecimal usado para exibição na interface do usuário.

Example:

"#3F51B5"

mandatory_on
enum<string>[]

Uma lista de tipos de recursos onde esta tag deve ser aplicada.

created_at
string<date-time>

O timestamp de quando a definição da tag foi criada.

Example:

"2025-10-29T12:00:00Z"

updated_at
string<date-time>

O timestamp de quando a definição da tag foi atualizada pela última vez.

Example:

"2025-10-29T12:30:00Z"