Chatwoot Integration

Configure Chatwoot

Updates the Chatwoot integration configuration. Fields use the chatwoot_ prefix. Integration in beta.

PUThttps://api.zapzapapi.com/api/v1/{instanceId}/chatwoot/config

Authentication with the x-api-key and x-api-secret headers.

Parameters

NameTypeInRequiredDescription
chatwoot_enabledselectbodyYesEnable integration
chatwoot_urltextbodyNoChatwoot URL (without trailing slash)
chatwoot_access_tokentextbodyNoChatwoot access token
chatwoot_account_idnumberbodyNoChatwoot account ID
chatwoot_inbox_idnumberbodyNoChatwoot inbox ID
chatwoot_ignore_groupsselectbodyNoIgnore groups
chatwoot_sign_messagesselectbodyNoSign messages
chatwoot_create_new_conversationselectbodyNoAlways create a new conversation

Request example

curl

curl -X PUT "https://api.zapzapapi.com/api/v1/{instanceId}/chatwoot/config" \
  -H "x-api-key: YOUR_API_KEY" \
  -H "x-api-secret: YOUR_API_SECRET" \
  -H "Content-Type: application/json" \
  -d '{"chatwoot_enabled":true}'

Node.js

const res = await fetch("https://api.zapzapapi.com/api/v1/{instanceId}/chatwoot/config", {
  method: "PUT",
  headers: {
    "x-api-key": "YOUR_API_KEY",
    "x-api-secret": "YOUR_API_SECRET",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "chatwoot_enabled": true
  }),
});
console.log(await res.json());

Python

import requests

res = requests.put(
    "https://api.zapzapapi.com/api/v1/{instanceId}/chatwoot/config",
    headers={"x-api-key": "YOUR_API_KEY", "x-api-secret": "YOUR_API_SECRET"},
    json={"chatwoot_enabled":True},
)
print(res.json())

Response example

JSON

{
  "message": "Chatwoot config updated successfully"
}

Values are illustrative; the fields follow the real response format.

Other endpoints in this category

See the full reference

Get your API keys

Create your account, connect a number in minutes and start using the API. R$15 per active number/month, with a welcome credit when you create the account, subject to the current campaign.