Skip to content
ver .md original

Etiquetas

Taxonomia organizacional para Formulários, Automações e Check-ins. Requer elegibilidade de Etiquetas (recurso habilitado). CRUD em Configurações, atribuição a entidades, filtragem em listagens. Convidados negados.

GET/v1/labels/entitlement/Chave de APICLI Auth

Elegibilidade de etiquetas

Indica se o chamador tem acesso a Etiquetas (recurso habilitado para a organização e o chamador não é convidado). Sempre retorna flags de elegibilidade — nunca bloqueia a resposta. Sem recurso e convidados recebem entitled=false com códigos de motivo.

Resposta

{
  "entitled": "boolean",
  "feature": "string",
  "reason": "string | null (feature_not_enabled | guest_not_allowed | organization_required)",
  "is_guest": "boolean",
  "can_create": "boolean",
  "can_manage_all": "boolean",
  "can_hard_delete": "boolean",
  "can_manage": "boolean (same as can_create when entitled)"
}

Erros

StatusQuando
401Credencial ausente, inválida ou expirada
429Limitado — cabeçalho Retry-After presente
curl -sS 'https://api.dailybot.com/v1/labels/entitlement/' \
  -H 'X-API-KEY: $DAILYBOT_API_KEY'

Testar

Este é um ajudante apenas de cópia — a requisição não é enviada do seu navegador. Cole o comando no seu terminal para executá-lo.

  • Chame isto antes de construir UI de Etiquetas ou fluxos de atribuição. Convidados sempre recebem is_guest=true e entitled=false.
GET/v1/labels/Chave de APICLI AuthPaginação limit-offset

Listar etiquetas da organização

Lista paginada de Etiquetas organizacionais para Configurações e seletores. Requer elegibilidade de Etiquetas (recurso habilitado). Cada linha inclui usage canônico: {forms, automations, checkins, total}.

Parâmetros de consulta

NomeTipoObrigatórioDescrição
searchstringOpcionalSubstring sem distinção de maiúsculas no nome da etiqueta.
owner_user_idsstring (CSV)OpcionalFiltra por UUIDs de criadores (máx. 50).
is_archivedbooleanOpcionalQuando true, lista etiquetas arquivadas. Padrão false.
orderstringOpcionalCampo de ordenação: name, usage, last_applied_at, created_at. Padrão name.
is_ascendbooleanOpcionalDireção de ordenação. Padrão ascendente para name.
limitintegerOpcionalTamanho da página. Padrão 20, mín. 1, máx. 100.
offsetintegerOpcionalOffset de paginação. Padrão 0.

Resposta

{
  "count": "integer",
  "next": "string | null",
  "previous": "string | null",
  "results": "array<Label>"
}

Erros

StatusQuando
401Credencial ausente, inválida ou expirada
403feature_not_available, permission_denied, guest_not_allowed
429Limitado — cabeçalho Retry-After presente
curl -sS 'https://api.dailybot.com/v1/labels/?order=usage&is_ascend=false&limit=50' \
  -H 'X-API-KEY: $DAILYBOT_API_KEY'

Testar

Este é um ajudante apenas de cópia — a requisição não é enviada do seu navegador. Cole o comando no seu terminal para executá-lo.

POST/v1/labels/Chave de APICLI Auth

Criar uma etiqueta

Cria uma Etiqueta organizacional. Requer elegibilidade de Etiquetas (recurso habilitado) e permissão can_create. Nomes são únicos sem distinção de maiúsculas por organização.

Corpo da requisição

{
  "name": "string (required)",
  "color": "string (hex, optional, default system color)",
  "description": "string | null (optional)"
}

Resposta

{
  "uuid": "string",
  "name": "string",
  "color": "string",
  "description": "string | null",
  "is_archived": "boolean",
  "usage": "{forms, automations, checkins, total}",
  "permissions": "{can_edit, can_archive, can_delete}"
}

Erros

StatusQuando
400validation_error, invalid_color
401Credencial ausente, inválida ou expirada
403feature_not_available, permission_denied, guest_not_allowed
409duplicate_name — já existe uma etiqueta com este nome
429Limitado — cabeçalho Retry-After presente
curl -sS -X POST 'https://api.dailybot.com/v1/labels/' \
  -H 'X-API-KEY: $DAILYBOT_API_KEY' \
  -H 'Content-Type: application/json' \
  -d '{"name": "Release", "color": "#4F46E5"}'

Testar

Este é um ajudante apenas de cópia — a requisição não é enviada do seu navegador. Cole o comando no seu terminal para executá-lo.

GET/v1/labels/{label_uuid}/Chave de APICLI Auth

Obter uma etiqueta

Obtém uma Etiqueta organizacional por UUID, incluindo contagens de uso e permissões do chamador.

Parâmetros de rota

NomeTipoObrigatórioDescrição
label_uuidstring (uuid)Obrigatório

Resposta

{
  "uuid": "string",
  "name": "string",
  "color": "string",
  "description": "string | null",
  "is_archived": "boolean",
  "usage": "{forms, automations, checkins, total}",
  "created_by": "object | null",
  "last_applied_at": "string (ISO 8601) | null",
  "permissions": "{can_edit, can_archive, can_delete}"
}

Erros

StatusQuando
401Credencial ausente, inválida ou expirada
403feature_not_available, permission_denied, guest_not_allowed
404not_found — etiqueta não pertence à organização do chamador
429Limitado — cabeçalho Retry-After presente
curl -sS 'https://api.dailybot.com/v1/labels/{label_uuid}/' \
  -H 'X-API-KEY: $DAILYBOT_API_KEY'

Testar

Este é um ajudante apenas de cópia — a requisição não é enviada do seu navegador. Cole o comando no seu terminal para executá-lo.

  • permissions.can_delete é por etiqueta (o chamador pode hard-delete esta Etiqueta). Distinto de can_hard_delete em GET /v1/labels/entitlement/, que é o flag elevado no nível da organização.
PATCH/v1/labels/{label_uuid}/Chave de APICLI Auth

Atualizar uma etiqueta

Atualização parcial de uma Etiqueta (name, color, description, is_archived). Requer can_edit na etiqueta.

Parâmetros de rota

NomeTipoObrigatórioDescrição
label_uuidstring (uuid)Obrigatório

Corpo da requisição

{
  "name": "string (optional)",
  "color": "string (optional hex)",
  "description": "string | null (optional)",
  "is_archived": "boolean (optional)"
}

Resposta

{
  "uuid": "string",
  "name": "string",
  "color": "string",
  "is_archived": "boolean",
  "usage": "{forms, automations, checkins, total}"
}

Erros

StatusQuando
400validation_error, invalid_color
401Credencial ausente, inválida ou expirada
403permission_denied
404not_found
409duplicate_name
429Limitado — cabeçalho Retry-After presente
curl -sS -X PATCH 'https://api.dailybot.com/v1/labels/{label_uuid}/' \
  -H 'X-API-KEY: $DAILYBOT_API_KEY' \
  -H 'Content-Type: application/json' \
  -d '{"color": "#059669"}'

Testar

Este é um ajudante apenas de cópia — a requisição não é enviada do seu navegador. Cole o comando no seu terminal para executá-lo.

DELETE/v1/labels/{label_uuid}/Chave de APICLI Auth

Excluir permanentemente uma etiqueta

Exclui permanentemente uma Etiqueta. Requer papel elevado (can_hard_delete). Retorna 409 se a etiqueta ainda estiver vinculada a itens — arquive ou desvincule primeiro.

Parâmetros de rota

NomeTipoObrigatórioDescrição
label_uuidstring (uuid)Obrigatório

Erros

StatusQuando
401Credencial ausente, inválida ou expirada
403permission_denied
404not_found
409label_in_use — a etiqueta está vinculada a um ou mais itens
429Limitado — cabeçalho Retry-After presente
curl -sS -X DELETE 'https://api.dailybot.com/v1/labels/{label_uuid}/' \
  -H 'X-API-KEY: $DAILYBOT_API_KEY'

Testar

Este é um ajudante apenas de cópia — a requisição não é enviada do seu navegador. Cole o comando no seu terminal para executá-lo.

POST/v1/labels/{label_uuid}/archive/Chave de APICLI Auth

Arquivar uma etiqueta

Arquiva uma Etiqueta (is_archived=true). Idempotente. Etiquetas arquivadas não podem ser atribuídas novamente, mas podem permanecer em itens existentes.

Parâmetros de rota

NomeTipoObrigatórioDescrição
label_uuidstring (uuid)Obrigatório

Resposta

{
  "uuid": "string",
  "name": "string",
  "is_archived": "true"
}

Erros

StatusQuando
401Credencial ausente, inválida ou expirada
403permission_denied
404not_found
429Limitado — cabeçalho Retry-After presente
curl -sS -X POST 'https://api.dailybot.com/v1/labels/{label_uuid}/archive/' \
  -H 'X-API-KEY: $DAILYBOT_API_KEY'

Testar

Este é um ajudante apenas de cópia — a requisição não é enviada do seu navegador. Cole o comando no seu terminal para executá-lo.

  • Use PATCH com is_archived=false no detalhe da etiqueta para restaurar uma etiqueta arquivada.
GET/v1/labels/{label_uuid}/items/Chave de APICLI AuthPaginação limit-offset

Listar itens com uma etiqueta

Lista paginada de Formulários, Automações e Check-ins associados a uma Etiqueta. Consciente de visibilidade — retorna apenas itens que o chamador pode ver (modal de itens associados em Configurações).

Parâmetros de rota

NomeTipoObrigatórioDescrição
label_uuidstring (uuid)Obrigatório

Parâmetros de consulta

NomeTipoObrigatórioDescrição
typestringOpcionalFiltra por tipo: forms, automations, checkins.
searchstringOpcionalBusca sem distinção de maiúsculas no nome do item.
limitintegerOpcionalTamanho da página. Padrão 20, máx. 100.
offsetintegerOpcionalOffset de paginação.

Resposta

{
  "count": "integer",
  "next": "string | null",
  "previous": "string | null",
  "results": "array<{type, uuid, name, active, archived, assigned_at}>"
}

Erros

StatusQuando
401Credencial ausente, inválida ou expirada
403feature_not_available, permission_denied
404not_found
429Limitado — cabeçalho Retry-After presente
curl -sS 'https://api.dailybot.com/v1/labels/{label_uuid}/items/?type=forms' \
  -H 'X-API-KEY: $DAILYBOT_API_KEY'

Testar

Este é um ajudante apenas de cópia — a requisição não é enviada do seu navegador. Cole o comando no seu terminal para executá-lo.

Etiquetas organizacionais

As Etiquetas do Dailybot são uma taxonomia compartilhada da organização para Formulários, Automações (workflows) e Check-ins. Exigem que o recurso esteja habilitado para a organização; convidados são negados.

Visão do produto: /hc/account/organization/labels/.

CLI e Agent Skill: Use dailybot label … ou o sub-skill dailybot-labels (dailybot-cli >= 3.9.0). Ver /pt/developers/cli e /pt/developers/agent-skill.

Elegibilidade

Chame GET /v1/labels/entitlement/ antes de construir UI de Etiquetas. A resposta sempre devolve flags (nunca bloqueia a resposta):

Campo Significado
entitled Recurso habilitado e o chamador não é convidado
is_guest Chamador é convidado (sempre negado)
can_create Pode criar etiquetas
can_manage_all Gestão elevada (admins)
can_hard_delete Hard-delete elevado (flag de elegibilidade no nível da org; distinto de permissions.can_delete por etiqueta)

Sem recurso: entitled: false com reason: feature_not_enabled. Convidados: entitled: false com reason: guest_not_allowed.

Forma LabelSummary

Linhas compactas em listagens de entidades, detalhe de Formulários e respostas de atribuição usam LabelSummary:

{
  "uuid": "label-uuid",
  "name": "Release",
  "color": "#4F46E5",
  "is_archived": false
}

Objetos completos de /v1/labels/ também expõem usage: {forms, automations, checkins, total}, permissions e campos de auditoria.

Atribuir etiquetas

Endpoints de atribuição usam POST (não PUT):

Domínio Substituição em uma entidade Lote
Formulários POST /v1/forms/{uuid}/labels/ POST /v1/forms/labels/batch/
Check-ins POST /v1/checkins/{uuid}/labels/ POST /v1/checkins/labels/batch/
Automações POST /v1/workflows/{uuid}/labels/ POST /v1/workflows/labels/batch/

Corpo de substituição: {"label_uuids": ["…", "…"]}. Lote: {"entity_uuids": ["…"], "label_uuids": ["…"], "mode": "add"|"remove"|"replace"}.

Filtrar listagens

Param Notas
labels UUIDs separados por vírgulas (máx. 50). Pelo menos uma das etiquetas selecionadas (OR / match-any). Requer elegibilidade.
featured true / false — Featured privado do chamador.
prioritize_featured true — linhas Featured primeiro.

Se o enriquecimento da listagem estiver indisponível, os params de enriquecimento respondem 503 com dashboard_enrichment_temporarily_unavailable. Ver /pt/developers/errors.

Códigos de erro frequentes

Código HTTP Quando
feature_not_available 403 Recurso não habilitado
guest_not_allowed 403 Convidado
permission_denied 403 Papel insuficiente
duplicate_name 409 Nome duplicado
archived_label 400 Atribuir etiqueta arquivada
label_limit_exceeded 400 Atribuição/lote excederia o limite de Etiquetas por entidade
invalid_color 400 Cor create/PATCH não é hex válido
label_in_use 409 Hard-delete com atribuições
not_found 404 Etiqueta ou entidade desconhecida

Relacionado