Criar instância

Amb. de Desenv.

http://localhost:3000

POST

/instances

Cria uma instância para o cliente autenticado.

Use esta rota para cadastrar a instância antes de conectar ao WhatsApp.
Neste passo, envie apenas um nome para identificação.
Se optar por pareamento via código (connectionType = "code"), informe o phoneNumber na rota de connect.

Requisição

Authorization

Adicionar parâmetro em header

x-api-key

Exemplo:

x-api-key: ********************

Parâmetros Header

Parâmetros Bodyapplication/jsonNecessário

Examples

Respostas

🟢201Criado

application/json

The request has succeeded and a new resource has been created as a result.

Body

🟠400Requisição Inválida

🟠401Não Autorizado

Request Example

Shell

JavaScript

Java

Swift

curl --location --request POST 'http://localhost:3000/instances' \
--header 'x-api-key: <api-key>' \
--header 'Content-Type: application/json' \
--data-raw '{
    "name": "Atendimento Principal"
}'

Response Example

201 - Instância criada

{
    "instanceId": "018f47ac-7a5b-7cc2-9f9a-9b8d7f6e5d4c",
    "status": "disconnected"
}

Modificado em 2026-04-17 20:31:44

Página anterior

Listar instâncias

Próxima página

Atualizar nome da instância