Create automatic document configuration

POST

/v1/flows/{flowId}/phases/{phaseId}/auto-document-config

Creates the automatic document generation configuration of a phase, linking one or more templates (documents) that will be used to generate the document automatically as the card advances through the process.

This call only works as a creation: each phase allows at most one configuration. If an automatic document configuration already exists for the given flow and phase, the API returns an error stating that a configuration already exists — even including the identifier of the existing configuration. To change the title or the linked templates of an existing configuration, the current configuration must be removed before creating a new one.

Requisição

Parâmetros de Caminho

Parâmetros Bodyapplication/jsonNecessário

Examples

Respostas

🟢201Configuration created

application/json

Illustrative example of the response, reflecting the sent payload plus the generated identifier.

Bodyapplication/json

🔴500Configuration already exists

Request Example

Shell

JavaScript

Java

Swift

curl --location '/v1/flows//phases//auto-document-config' \
--header 'Content-Type: application/json' \
--data '{
    "title": "string",
    "documents": [
        {
            "templateId": "string",
            "name": "string"
        }
    ]
}'

Response Example

201 - Exemplo 1

{
    "id": "string",
    "title": "string",
    "documents": [
        "string"
    ]
}

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

Página anterior

Documents — Overview

Próxima página

Delete automatic document configuration