Cartat WhatsApp API
  • 🚛Get Started
  • 💼Use case
  • 📲WhatsApp API
    • 📶instance
      • ⚙️Settings
        • Get Settings
        • Set Settings
      • Get Instance Info
      • Initialize Instance
      • Link WhatsApp using QR
      • Get QR string
      • Get Instance Status
      • Restart Instance
      • Logout
      • Destroy
    • 📤Messages
      • Send Text
      • Send Media
    • 📬Chats
      • Chats
      • Chats/{chat_id}
      • Chats By Lable ID
    • 🏷️Labels
      • Labels
    • 🔢Contacts
      • Contacts
Powered by GitBook
On this page
  1. WhatsApp API
  2. instance
  3. Settings

Set Settings

To set settings to your instance

if you need to set instance settings such as webhook URL or other settings use this point

To set settings to your instance

POST https://api.cartat.net/instance/settings

Headers

Name
Type
Description

Accept*

application/json

Content-Type*

application/json

Authorization*

Bearer {{token}}

Request Body

Name
Type
Description

archive

true

True/False

set to true to put any sent message

to the archive on WhatsApp automatically.

webhook[is_active]

true

True/False

to active/deactivate webhook events

webhook[ack_events]

true

True/False

to active/deactivate read indicators events, eg: when messages are read, the ack event will trigger.

webhook[webhook_url]

https://ex.com

URL

the webhook URL that you will receive events on it

you can use test endpoint on

webhook[instance_events]

true

True/False

webhook[messages_events]

true

True/False

to active/deactivate receiving messages events, when a new message arrived we will send the message payload to your webhook URL

{
    "archive": true,
    "webhook": {
        "is_active": true,
        "ack_events": true,
        "webhook_url": "https://webhook.site",
        "instance_events": true,
        "messages_events": true
    }
}

settings explain

PreviousGet SettingsNextGet Instance Info

Last updated 1 year ago

you can find your access token

to active/deactivate receiving instance events such as qr, ready, etc ...

📲
📶
⚙️
here
reference

archive

True/False

set to true to put any sent message

to the archive on WhatsApp automatically.

webhook->is_active

True/False

to active/deactive webhook events

webhook->ack_events

True/False

to active/deactive read indecators events, eg: when message are read, the ack event will trigger.

webhook->webhook_url

URL

the webhook URL that you will receive events on it

webhook->instance_events

True/False

webhook->messages_events

True/False

to active/deactive receiving messages events, when new message arrived we will send the message payload to your webhook URL

to active/deactive receiving instance events such as : qr, ready etc ...

reference