Adicionar etiqueta personalizada a uma empresa

PATCH

/documents/labels/{companyId}

Adiciona uma etiqueta personalizada ao conjunto de etiquetas da empresa. Informe no corpo o nome da etiqueta em label. A etiqueta é criada sem subetiquetas e sem metadados, com custom igual a true, e passa a aparecer na listagem de etiquetas da empresa. Nome já existente no conjunto devolve 400 (Esta etiqueta já existe!); a comparação diferencia maiúsculas, minúsculas e acentos. label ausente, vazio ou com tipo diferente de texto devolve 422. Empresa inexistente, ou sem conjunto de etiquetas, devolve 400. Requer autenticação via Bearer JWT ou header x-api-key.

Requisição

Authorization

Forneça seu token bearer no cabeçalho

Authorization

ao fazer requisições para recursos protegidos.

Exemplo:

Authorization: Bearer ********************

Parâmetros de Caminho

Parâmetros Header

Parâmetros Bodyapplication/jsonNecessário

Examples

Respostas

🟢200

application/json

Etiqueta adicionada

Bodyapplication/json

🟠400BadRequest

🟠401Unauthorized

🟠404NotFound

🟠429TooManyRequests

🔴500InternalError

🟠400Etiqueta não adicionada

🟠422Dados inválidos

Request Example

Shell

JavaScript

Java

Swift

curl --location --request PATCH '/documents/labels/' \
--header 'x-api-key: SUA_CHAVE_DE_API' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
    "label": "Contratos de arrendamento"
}'

Response Example

200 - Sucesso

{
    "items": {
        "label": "Contratos de arrendamento",
        "custom": true
    }
}

Modificado em 2026-10-13 09:47:06

Página anterior

Listar etiquetas de uma empresa

Próxima página

Remover etiqueta personalizada de uma empresa