Skip to main content
POST
Set group locked status

Authorizations

Authorization
string
header
required

Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.

Headers

X-Device-Id
string

Device identifier for multi-device support. Required when multiple devices are registered. If only one device is registered, it will be used as the default. Can also be provided as device_id query parameter.

Example:

"my-device-id"

Body

application/json
group_id
string
required

The group ID

Example:

"120363024512399999@g.us"

locked
boolean
required

Whether to lock the group (true) or unlock it (false)

Example:

true

Response

OK

code
string
Example:

"SUCCESS"

message
string
Example:

"Success"

results
string
Example:

null