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",
    "phone_number": "+5587989075555"
  },
  "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",
    "phone_number": "+5587989075555"
  },
  "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

Response

200 - application/json

Success

Estrutura de uma instância registrada na API.