Criar etiquetas pré-definidas de uma empresa

POST

/documents/labels/{companyId}

Cria o conjunto de etiquetas pré-definidas da empresa, usadas para classificar pastas e arquivos dos documentos de clientes. O corpo é a lista de etiquetas, e cada etiqueta pode ter subetiquetas (subLabels) e metadados. A empresa só pode ter um conjunto: se ele já existir, a resposta é 400 (Etiquetas pré-definidas já criadas anteriormente para essa empresa!). O cadastro de empresa já cria esse conjunto com as etiquetas padrão da plataforma; para incluir uma etiqueta num conjunto existente, use a rota de adicionar etiqueta personalizada. 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

🟢201

application/json

Etiquetas criadas

Bodyapplication/json

🟠400BadRequest

🟠401Unauthorized

🟠404NotFound

🟠429TooManyRequests

🔴500InternalError

🟠400Etiquetas já criadas

Request Example

Shell

JavaScript

Java

Swift

curl --location '/documents/labels/' \
--header 'x-api-key: SUA_CHAVE_DE_API' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '[
    {
        "label": "IR",
        "custom": false,
        "metadata": [],
        "subLabels": [
            {
                "label": "Recibo",
                "metadata": []
            },
            {
                "label": "Declaração",
                "metadata": []
            }
        ]
    },
    {
        "label": "SCR",
        "custom": false,
        "metadata": [],
        "subLabels": []
    }
]'

Response Example

201 - Sucesso

{
    "message": "Etiquetas pré-definidas criadas"
}

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

Página anterior

Listar documentos de um cliente

Próxima página

Listar etiquetas de uma empresa