Criar Instância

Cria uma nova instância do WhatsApp vinculada à sua conta empresarial.

POST /instances

Exemplo Mínimo (Payload)

{
  "name": "Suporte Técnico"
}

Exemplo Completo (Payload)

{
  "name": "Suporte Técnico"
}

O nome da instância é de uso interno para sua organização no painel. Você pode alterá-lo a qualquer momento sem afetar as conexões ativas.

Headers

Authorization string header required 06/04/2026

Token no formato Bearer <token_empresa>.

Content-Type string header required 06/04/2026

Defina como application/json.

Body Payload

application/json

name string body required 06/04/2026

Nome amigável para identificar a conexão.

Response Schema

application/json

success boolean required 06/04/2026

Indica se a requisição obteve sucesso.

error string | null required 06/04/2026

Mensagem de erro caso success seja falso.

data object | null required 06/04/2026

Detalhes da instância criada (pode ser null em alguns casos).

Atributos do Objeto

instance_id string (uuid) 06/04/2026

ID único da instância criada (UUIDv7).

instance_token string 06/04/2026

Token de acesso exclusivo da instância criada.

status enum 06/04/2026

Status atual da conexão (inicia como DISCONNECTED).

{
  "success": true,
  "data": {
    "instance_id": "019e059f-...",
    "instance_token": "7o6DCwb8eS3WkdomVCOa...",
    "status": "DISCONNECTED"
  },
  "error": null
}

{
  "success": false,
  "data": null,
  "error": "Token de acesso inválido ou ausente."
}

{
  "success": false,
  "data": null,
  "error": "O campo name é obrigatório."
}