Aplicar etiqueta ao envelope

Sandbox

https://api.sandbox.supersign.com.br

POST

/v4/api/envelopes/{envelopeId}/tags

Aplica uma etiqueta da conta. Reaplicar uma que já está aplicada não muda nada. O limite é de 3 etiquetas: a quarta responde 409 ENVELOPE_TAG_LIMIT. Etiqueta ou recurso inexistente, de outra conta ou fora da visibilidade responde 404. Exige o cabeçalho Idempotency-Key.

Requisição

Parâmetros de Caminho

Parâmetros Header

Parâmetros Bodyapplication/jsonNecessário

Examples

Respostas

🟢204Sem Conteúdo

Sem conteúdo

Headers

Esta resposta não possui corpo.

🟠400Requisição Inválida

🟠401Não Autorizado

🟠403Proibido

🟠404Registo Não Encontrado

🟠409

🟠422Erro de Parâmetro

🟠429

🔴503Serviço Indisponível

Request Example

Shell

JavaScript

Java

Swift

curl --location 'https://api.sandbox.supersign.com.br/v4/api/envelopes//tags' \
--header 'Idempotency-Key: 7d3f1c52-9a4b-4e6d-8f20-5b1c9e3a7d41' \
--header 'Content-Type: application/json' \
--data '{
    "tagId": "7b9d1e2f-6a3c-4f5b-8d7e-2c3d4e5f6a7b"
}'

Response Example

400 - Idempotency-Key ausente

{
    "error": {
        "code": "IDEMPOTENCY_KEY_REQUIRED",
        "message": "Idempotency-Key header is required"
    }
}

Modificado em 2026-10-05 16:47:09

Página anterior

Relatório de uso por grupo

Próxima página

Remover etiqueta do envelope