Skip to main content
PUT
/
account
/
instances
/
{id}
/
settings
Update instance settings
curl --request PUT \
  --url https://wsapi.chat/account/instances/{id}/settings \
  --header 'Content-Type: application/json' \
  --header 'X-Api-Key: <api-key>' \
  --data '
{
  "useCustomDefaults": true,
  "pullMode": true,
  "webhookUrl": "<string>",
  "eventSigningSecret": "<string>",
  "historySync": true,
  "eventFilters": [
    "<string>"
  ]
}
'
{
  "status": 400,
  "detail": "invalid request body"
}

Authorizations

​
X-Api-Key
string
header
required

Customer API key. Only the customer-level key is accepted for /account/* endpoints. No X-Instance-Id header is required.

Path Parameters

​
id
string
required

Body

application/json
​
useCustomDefaults
boolean
​
pullMode
boolean
​
webhookUrl
string | null
​
eventSigningSecret
string | null
​
historySync
boolean
​
eventFilters
string[] | null

Response

Settings updated