Atualizar metadados do formulário

PATCH

/v1/flows/{id}/start-form/{startFormId}

Atualiza os metadados do formulário inicial já existente: título, cor de fundo, texto do botão de criação, descrição, logotipo e a fase inicial associada.

Os campos createButtonLabel e backgroundColor devem ser sempre enviados explicitamente nesta chamada, mesmo quando seus valores não estão mudando — não há um valor padrão assumido pelo servidor. Omitir createButtonLabel retorna erro 400; omitir backgroundColor faz a API redefinir a cor para o padrão da plataforma, descartando a cor personalizada da empresa sem qualquer aviso. Recomendamos sempre consultar o formulário atual antes desta chamada e repassar os valores vigentes desses dois campos.

Diferente da criação inicial do formulário, o title enviado aqui é respeitado pela API.

Esta chamada é voltada à atualização de metadados do formulário. Para adicionar, editar ou remover campos, utilize o endpoint dedicado de atualização de campos deste domínio.

Requisição

Parâmetros de Caminho

Parâmetros Bodyapplication/jsonNecessário

Examples

Respostas

🟢200Formulário atualizado

application/json

Os metadados do formulário foram atualizados com sucesso.

Bodyapplication/json

🟠400Payload inválido

Request Example

Shell

JavaScript

Java

Swift

curl --location --request PATCH '/v1/flows//start-form/' \
--header 'Content-Type: application/json' \
--data '{
    "title": "string",
    "description": "string",
    "logoUrl": "string",
    "backgroundColor": "string",
    "createButtonLabel": "string",
    "startFormPhaseId": "string",
    "fields": [
        {}
    ]
}'

Response Example

200 - Exemplo 1

{
    "id": "string",
    "title": "string",
    "description": "string",
    "logoUrl": "string",
    "backgroundColor": "string",
    "createButtonLabel": "string",
    "startFormPhaseId": "string",
    "flowId": "string"
}

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

Página anterior

Definir regras condicionais do formulário

Próxima página

Consultar formulário inicial