Update start form metadata

PATCH

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

Updates the metadata of an existing start form: title, background color, create-button text, description, logo and the associated start phase.

The createButtonLabel and backgroundColor fields must always be sent explicitly on this call, even when their values are not changing — there is no default value assumed by the server. Omitting createButtonLabel returns a 400 error; omitting backgroundColor causes the API to reset the color to the platform default, discarding the company's custom color without any warning. We recommend always reading the current form before this call and passing back the current values of these two fields.

Unlike the initial creation call, the title sent here is respected by the API.

This call is meant for updating the form's metadata. To add, edit or remove fields, use this domain's dedicated field-update endpoint.

Requisição

Parâmetros de Caminho

Parâmetros Bodyapplication/jsonNecessário

Examples

Respostas

🟢200Form updated

application/json

The form's metadata was updated successfully.

Bodyapplication/json

🟠400Invalid payload

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

Set start form conditional rules

Próxima página

Get start form