Skip to main content
PUT
/
communities
/
{id}
/
settings
/
locked
Set community locked mode
curl --request PUT \
  --url https://api.wsapi.chat/communities/{id}/settings/locked \
  --header 'Content-Type: application/json' \
  --header 'X-Api-Key: <api-key>' \
  --header 'X-Instance-Id: <x-instance-id>' \
  --data '
{
  "enabled": true
}
'
{
  "status": 400,
  "detail": "invalid request body"
}

Authorizations

​
X-Api-Key
string
header
required

Instance or customer-level API key. Either the instance's own API key or the customer's API key is accepted. Must be paired with the X-Instance-Id header to identify the target instance.

Headers

​
X-Instance-Id
string
default:{{instanceId}}
required

The ID of the WhatsApp instance to use

Path Parameters

​
id
string
required

Community JID

Body

application/json
​
enabled
boolean

Response

Setting updated