Skip to main content
POST
Criação de Instâncias
Ao criar uma instância, você escolhe o tipo de conexão:
  • Não oficial (connection_type: "unofficial"): o padrão. Depois de criar, você conecta via QR code ou código de pareamento.
  • Oficial WABA (connection_type: "waba"): usa a API oficial da Meta. Você precisa fornecer as credenciais no objeto waba.
Para instâncias WABA, existem duas formas de obter as credenciais:
  1. Embedded Signup (recomendado): fluxo OAuth pelo dashboard, sem precisar mexer no Meta Business Manager. Veja o guia passo a passo.
  2. Token manual: você gera um System User Token no Meta Business Manager e passa direto na API. Veja o método avançado.
Quando connection_type é waba, o objeto waba com access_token, phone_number_id e waba_id é obrigatório. Para instâncias não oficiais, esse campo é ignorado.
Para entender as diferenças entre os dois tipos, veja o comparativo WABA vs não oficial.

Autorizações

Authorization
string
header
obrigatório

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Corpo

application/json
connection_type
enum<string>
padrão:unofficial

Tipo de conexão da instância:

  • unofficial (padrão): conexão via QR code ou código de pareamento
  • waba: conexão via API oficial do WhatsApp (Cloud API da Meta)

Quando waba é selecionado, o objeto waba com as credenciais é obrigatório.

Opções disponíveis:
unofficial,
waba
Exemplo:

"unofficial"

waba
object

Credenciais para conexão com a API oficial do WhatsApp (Cloud API da Meta). Obrigatório quando connection_type é waba. Ignorado para instâncias não oficiais.

name
string

Um apelido opcional para sua instância, usado apenas para sua organização.

Maximum string length: 64
Exemplo:

"Bot SDR"

lookup_key
string

Um identificador único opcional de pesquisa que permite associar sua instância a uma estrutura de dados específica. A Zapster API não utiliza esse dado internamente; ele serve exclusivamente para facilitar consultas na API, permitindo localizar registros mais rapidamente por meio deste parâmetro de pesquisa.

Maximum string length: 36
Exemplo:

"ins_8j7wlxmpjlixx9mux5"

metadata
object

Um conjunto de informações adicionais armazenadas como chave e valor. Cada chave é um texto e o valor pode ser um número ou um texto. Esse campo é opcional e pode ser usado para guardar detalhes personalizados.

Para números de telefone, use o formato E.164 (ex: +5587989075555). O sistema validará e formatará automaticamente o número, removendo espaços e hífens.

Exemplo:
settings
object

Objeto opcional de configurações da sua instância.

webhooks
object

Lista de webhooks serão criados assim que a instância finalizar sua criação. Atente-se para a quantidade de webhooks nesta lista, a mesma é baseada no seu plano contratado.

Resposta

200 - application/json

Success

Estrutura de uma instância registrada na API.

created_at
string<date-time>
obrigatório

Data e hora de criação da instância no formato ISO 8601.

Exemplo:

"2024-10-03T21:56:22.620Z"

id
string
obrigatório

Identificador único da instância.

Exemplo:

"xy9rexnkwobmgg3tehgvs"

metadata
object
obrigatório

Metadados adicionais armazenados como chave e valor.

Exemplo:
name
string
obrigatório

Nome da instância.

Exemplo:

"MyNewInstance2"

owner
object
obrigatório

Informações sobre o proprietário da instância.

settings
object
obrigatório

Objeto opcional de configurações da sua instância.

status
enum<string>
obrigatório

Status atual da instância

Opções disponíveis:
connected,
disconnected,
offline
Exemplo:

"disconnected"

webhooks
object[]
obrigatório

Lista de webhooks configurados para esta instância.

connection_type
enum<string>

Tipo de conexão da instância:

  • unofficial: conexão via QR code (padrão)
  • waba: conexão via API oficial do WhatsApp (Cloud API da Meta)
Opções disponíveis:
unofficial,
waba
Exemplo:

"unofficial"

qrcode
string | null

QR Code da instância, caso disponível.

Exemplo:

null

lookup_key
string

Identificador de pesquisa criado anteriormente.

Exemplo:

"ins_8j7wlxmpjlixx9mux5"