Gerar documento a partir de template

POST

/v1/cards/{cardId}/templates/{templateId}/generate

Gera o documento (arquivo .docx preenchido) a partir de um template e dos dados de um card específico.

O payload segue uma convenção própria de nomenclatura de campos: dentro de fields.clients[], cada campo é identificado por uma chave key composta pelo nome do grupo pai e do campo filho, no formato grupoPai.campoFilho (por exemplo, fiadores.nome) — nunca pelo identificador (id) do campo, que é rejeitado pela API. O mesmo vale para fields.generalSections[]: cada campo usa key, title, type e value, sem id. Além disso, cada item de clients[] exige name e index além de clientId e fields, e cada item de generalSections[] exige title e index além de section e fields.

Recomendamos consultar previamente o endpoint de campos do card (GET .../templates/{templateId}/fields) para obter a estrutura exata a ser preenchida antes de montar este payload.

Requisição

Parâmetros de Caminho

Parâmetros Bodyapplication/jsonNecessário

Examples

Respostas

🟢200Documento gerado

application/json

Exemplo ilustrativo da resposta, refletindo o documento gerado a partir do template.

Bodyapplication/json

🟠400Payload inválido

Request Example

Shell

JavaScript

Java

Swift

curl --location '/v1/cards//templates//generate' \
--header 'Content-Type: application/json' \
--data '{
    "fileName": "string",
    "fields": {
        "clients": [
            {
                "clientId": "string",
                "name": "string",
                "index": 0,
                "fields": [
                    {
                        "key": "string",
                        "title": "string",
                        "type": "string",
                        "value": null
                    }
                ]
            }
        ],
        "generalSections": [
            {
                "section": "string",
                "title": "string",
                "index": 0,
                "fields": [
                    {
                        "key": "string",
                        "title": "string",
                        "required": true,
                        "type": "string",
                        "value": null
                    }
                ]
            }
        ],
        "general": [
            "string"
        ],
        "opinion": null,
        "images": [
            "string"
        ]
    }
}'

Response Example

200 - Exemplo 1

{
    "id": "string",
    "fileName": "string",
    "fileDownloadUrl": "string"
}

Modificado em 2026-07-28 20:38:32

Página anterior

Consultar campos para geração do documento

Próxima página

Consultar template por ID