POST
/
wa
/
instances
curl --request POST \
  --url https://api.zapsterapi.com/v1/wa/instances \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "name": "Bot SDR",
  "lookup_key": "ins_8j7wlxmpjlixx9mux5",
  "metadata": {
    "customer_id": "123456",
    "customer_name": "Joãozinho"
  },
  "settings": {
    "call_rejection": "all",
    "delay_per_word": true,
    "delete_chat_after_sent": true,
    "message_delay": {
      "enabled": true,
      "max": 10,
      "min": 1
    },
    "presence_behavior": "only_composing",
    "read_confirmation": "never"
  },
  "webhooks": {
    "events": [
      [
        "message.received"
      ]
    ],
    "url": "<string>"
  }
}'
{
  "created_at": "2024-10-03T21:56:22.620Z",
  "id": "xy9rexnkwobmgg3tehgvs",
  "metadata": {
    "customer_id": "123456",
    "customer_name": "Joãozinho"
  },
  "name": "MyNewInstance2",
  "owner": {
    "display_name": null,
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  },
  "qrcode": null,
  "settings": {
    "call_rejection": "all",
    "delay_per_word": true,
    "delete_chat_after_sent": true,
    "message_delay": {
      "enabled": true,
      "max": 10,
      "min": 1
    },
    "presence_behavior": "only_composing",
    "read_confirmation": "never"
  },
  "status": "disconnected",
  "webhooks": [
    {
      "enabled": true,
      "events": [
        "message.received"
      ],
      "id": "2nenz69l0xbf0m3uu9tfo",
      "name": "Webhook Name",
      "test_mode": false,
      "test_url": null,
      "url": "https://webhook.mydomain.com"
    }
  ],
  "lookup_key": "ins_8j7wlxmpjlixx9mux5"
}

Authorizations

​
Authorization
string
header
required

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

Body

application/json
​
name
string

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

Maximum length: 64
Example:

"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 length: 36
Example:

"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.

Example:
{
  "customer_id": "123456",
  "customer_name": "Joãozinho"
}
​
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.

Response

200 - application/json
Success

Estrutura de uma instância registrada na API.

​
created_at
string
required

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

Example:

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

​
id
string
required

Identificador único da instância.

Example:

"xy9rexnkwobmgg3tehgvs"

​
metadata
object
required

Metadados adicionais armazenados como chave e valor.

Example:
{
  "customer_id": "123456",
  "customer_name": "Joãozinho"
}
​
name
string
required

Nome da instância.

Example:

"MyNewInstance2"

​
owner
object
required

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

​
settings
object
required

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

​
status
enum<string>
required

Status atual da instância

Available options:
connected,
disconnected,
offline
Example:

"disconnected"

​
webhooks
object[]
required

Lista de webhooks configurados para esta instância.

Configuração de um webhook associado à instância.

​
qrcode
string | null

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

Example:

null

​
lookup_key
string

Identificador de pesquisa criado anteriormente.

Example:

"ins_8j7wlxmpjlixx9mux5"

Listando InstânciasDados da Instância