Developers
Acessar miCore Começar
Gestão do Core Base

Tags

Cadastro de tags compartilhado pelas tarefas dos quadros e pelos vídeos do Streaming.

O que é

Tags é o cadastro de etiquetas da empresa, compartilhado pelas tarefas dos quadros e pelos vídeos do Streaming. Ele é a lista de sugestões; na tarefa, a tag é o nome, em texto livre.

O que dá para fazer hoje

  • Listar o cadastro, com busca e filtro de situação.
  • Criar e renomear tags, sem repetir nome.
  • Ativar e desativar.
  • Marcar tarefas com tags e buscar tarefas por tag (pela API de tarefas).

Importante

  • É um cadastro da base: não depende de módulo contratado, só da permissão Tags.
  • Desativar ou renomear não muda as tarefas que já usam o nome.

Disponibilidade na API

Endpoints de Tags

Mantenha o cadastro de tags compartilhado pelas tarefas e pelos vídeos. Os exemplos abaixo são gerados pelo contrato OpenAPI oficial.

GET /api/v1/tags

Lista o cadastro de tags

Exige `tags:read` e ver Tags. Cadastro compartilhado pelas tarefas dos quadros e pelos vídeos do Streaming; é a lista de sugestões. Ordem pelo nome.

Parâmetros

NomeTipoObrigatórioDescrição
activequerybooleanNãotrue só ativas; false só desativadas.
searchquerystringNãoParte do nome.
per_pagequeryintegerNão—

Exemplo de requisição

cURL
curl "$MICORE_BASE_URL/tags" \
  -H "Authorization: Bearer $MICORE_TOKEN" \
  -H "Accept: application/json"

Exemplo de resposta JSON

Resposta · 200
{
    "data": [
        {
            "id": 12,
            "name": "Campanha de Natal",
            "active": true,
            "created_at": "2026-11-10T10:00:00-03:00",
            "updated_at": "2026-11-10T10:00:00-03:00"
        }
    ],
    "links": [],
    "meta": []
}

Respostas possíveis

200 Página de tags401 Token ausente, inválido, expirado ou revogado403 Escopo, assinatura, módulo ou permissão insuficiente422 Dados inválidos429 Cota por minuto da credencial excedida503 O domínio não pôde ser associado com segurança a um tenant
POST /api/v1/tags

Cria uma tag no cadastro

Exige `tags:write` e criar em Tags. Nome repetido (sem diferenciar maiúsculas) responde 422 em `name`.

Parâmetros

NomeTipoObrigatórioDescrição
Idempotency-KeyheaderstringSimIdentificador único da mutação, com 8 a 100 caracteres. O resultado fica reutilizável por 24 horas e a chave não pode ser reutilizada depois de expirar.

Corpo da requisição

CampoTipoObrigatórioDescrição
namestringSimAté 255 caracteres.

Exemplo de requisição

cURL
curl -X POST "$MICORE_BASE_URL/tags" \
  -H "Authorization: Bearer $MICORE_TOKEN" \
  -H "Accept: application/json" \
  -H "Idempotency-Key: board-request-0001" \
  -H "Content-Type: application/json" \
  -d '{"name":"string"}'

Exemplo de resposta JSON

Resposta · 201
{
    "data": {
        "id": 12,
        "name": "Campanha de Natal",
        "active": true,
        "created_at": "2026-11-10T10:00:00-03:00",
        "updated_at": "2026-11-10T10:00:00-03:00"
    }
}

Respostas possíveis

201 Tag criada (ou reapresentada pela mesma chave idempotente)401 Token ausente, inválido, expirado ou revogado403 Escopo, assinatura, módulo ou permissão insuficiente409 Chave em processamento ou reutilizada com outro conteúdo422 Dados inválidos429 Cota por minuto da credencial excedida503 O domínio não pôde ser associado com segurança a um tenant
GET /api/v1/tags/{tag}

Exibe uma tag

Exige `tags:read`.

Exemplo de requisição

cURL
curl "$MICORE_BASE_URL/tags/{tag}" \
  -H "Authorization: Bearer $MICORE_TOKEN" \
  -H "Accept: application/json"

Exemplo de resposta JSON

Resposta · 200
{
    "data": {
        "id": 12,
        "name": "Campanha de Natal",
        "active": true,
        "created_at": "2026-11-10T10:00:00-03:00",
        "updated_at": "2026-11-10T10:00:00-03:00"
    }
}

Respostas possíveis

200 Tag encontrada401 Token ausente, inválido, expirado ou revogado403 Escopo, assinatura, módulo ou permissão insuficiente404 Recurso não encontrado429 Cota por minuto da credencial excedida503 O domínio não pôde ser associado com segurança a um tenant
PATCH /api/v1/tags/{tag}

Renomeia uma tag

Exige `tags:write` e editar em Tags. O nome novo não pode repetir outra tag. Tarefas que já usam o nome antigo continuam com ele (a tag da tarefa é texto).

Corpo da requisição

CampoTipoObrigatórioDescrição
namestringSimAté 255 caracteres.

Exemplo de requisição

cURL
curl -X PATCH "$MICORE_BASE_URL/tags/{tag}" \
  -H "Authorization: Bearer $MICORE_TOKEN" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{"name":"string"}'

Exemplo de resposta JSON

Resposta · 200
{
    "data": {
        "id": 12,
        "name": "Campanha de Natal",
        "active": true,
        "created_at": "2026-11-10T10:00:00-03:00",
        "updated_at": "2026-11-10T10:00:00-03:00"
    }
}

Respostas possíveis

200 Tag renomeada401 Token ausente, inválido, expirado ou revogado403 Escopo, assinatura, módulo ou permissão insuficiente404 Recurso não encontrado422 Dados inválidos429 Cota por minuto da credencial excedida503 O domínio não pôde ser associado com segurança a um tenant
POST /api/v1/tags/{tag}/activate

Ativa uma tag

Exige `tags:write` e desabilitar em Tags.

Exemplo de requisição

cURL
curl -X POST "$MICORE_BASE_URL/tags/{tag}/activate" \
  -H "Authorization: Bearer $MICORE_TOKEN" \
  -H "Accept: application/json"

Exemplo de resposta JSON

Resposta · 200
{
    "data": {
        "id": 12,
        "name": "Campanha de Natal",
        "active": true,
        "created_at": "2026-11-10T10:00:00-03:00",
        "updated_at": "2026-11-10T10:00:00-03:00"
    }
}

Respostas possíveis

200 Tag ativa401 Token ausente, inválido, expirado ou revogado403 Escopo, assinatura, módulo ou permissão insuficiente404 Recurso não encontrado429 Cota por minuto da credencial excedida503 O domínio não pôde ser associado com segurança a um tenant
POST /api/v1/tags/{tag}/deactivate

Desativa uma tag

Exige `tags:write` e desabilitar em Tags. Sai das sugestões; tarefas e vídeos que já usam o nome continuam com ele.

Exemplo de requisição

cURL
curl -X POST "$MICORE_BASE_URL/tags/{tag}/deactivate" \
  -H "Authorization: Bearer $MICORE_TOKEN" \
  -H "Accept: application/json"

Exemplo de resposta JSON

Resposta · 200
{
    "data": {
        "id": 12,
        "name": "Campanha de Natal",
        "active": true,
        "created_at": "2026-11-10T10:00:00-03:00",
        "updated_at": "2026-11-10T10:00:00-03:00"
    }
}

Respostas possíveis

200 Tag desativada401 Token ausente, inválido, expirado ou revogado403 Escopo, assinatura, módulo ou permissão insuficiente404 Recurso não encontrado429 Cota por minuto da credencial excedida503 O domínio não pôde ser associado com segurança a um tenant