Etiquetas
As etiquetas agrupam os documentos e aparecem nos filtros da listagem da tela Documentos. Um documento pode ter várias etiquetas. Na tela Detalhe do documento, digite o nome da etiqueta para escolher uma já existente ou criar uma nova.
Endpoints
| Método | Caminho | Descrição |
|---|---|---|
| GET | /digital-signature/documents/{document_uuid}/tags | Lista as etiquetas do documento |
| GET | /digital-signature/documents/{document_uuid}/tags/{id} | Consulta uma etiqueta do documento |
| PUT | /digital-signature/documents/{uuid}/tags | Substitui as etiquetas do documento |
| GET | /digital-signature/documents/tags/suggestions | Sugestões de etiquetas da empresa |
GET /digital-signature/documents/{document_uuid}/tags
Lista as etiquetas vinculadas ao documento. Cada item é um vínculo entre o
documento e uma etiqueta, com o tag_id da etiqueta.
Resposta (200): lista de vínculos.
GET /digital-signature/documents/{document_uuid}/tags/{id}
Consulta um vínculo de etiqueta do documento.
Resposta (200): o vínculo.
PUT /digital-signature/documents/{uuid}/tags
Substitui as etiquetas do documento pelas enviadas. Enviar uma lista vazia remove todas as etiquetas do documento. Nomes repetidos são ignorados. Um nome que já existe na empresa, sem diferenciar maiúsculas de minúsculas, usa a etiqueta existente. Um nome novo cria a etiqueta na empresa.
Corpo (JSON)
| Campo | Obrigatório | Tipo | Descrição |
|---|---|---|---|
| tags | Não | Lista de textos | Nomes das etiquetas do documento |
Resposta (200): lista com os nomes das etiquetas do documento depois da alteração.
{ "tags": ["Contratos", "2026"] }
GET /digital-signature/documents/tags/suggestions
Sugestões de etiquetas do catálogo da empresa, para o campo de busca de etiquetas.
Parâmetros de URL
| Parâmetro | Obrigatório | Descrição |
|---|---|---|
| q | Não | Trecho do nome da etiqueta. Sem ele, traz as etiquetas em ordem alfabética |
Resposta (200): lista com até 20 nomes de etiqueta.