Configure phone

POST

/v1/flows/{flowId}/phone-config

Registers the WhatsApp Business phone number that will be used to send the automatic messages configured on the flow's phases.

This configuration is a mandatory prerequisite: it must be completed before creating the messaging configuration (messaging-config) of any phase in the flow. Without a registered phone, a messaging rule that uses the WhatsApp channel fails when created, because the API cannot find the number referenced in channels[].setup.phoneId.

The phone registration is tied to the company (tenant), not to an individual flow — a company that already has a phone configured on another flow automatically shares that registration. For this reason, the call is idempotent: if the phone is already registered for the company, the API responds successfully indicating that the record already existed, without returning an error. It is safe to call this endpoint more than once.

Requisição

Parâmetros de Caminho

Parâmetros Bodyapplication/jsonNecessário

Examples

Respostas

🟢200Phone configured

application/json

The phone was successfully configured for the company, or was already registered previously.

Bodyapplication/json

🟠403Missing permission

Request Example

Shell

JavaScript

Java

Swift

curl --location '/v1/flows//phone-config' \
--header 'Content-Type: application/json' \
--data '{
    "phones": [
        {
            "numberId": "string",
            "token": "string"
        }
    ]
}'

Response Example

200 - Exemplo 1

{
    "alreadyExists": true,
    "phones": [
        {
            "numberId": "string",
            "token": "string"
        }
    ]
}

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