Skip to main content
PUT
/
api
/
{session}
/
groups
/
{id}
/
settings
/
security
/
info-admin-only
Update group admins only info settings
curl --request PUT \
  --url https://{host}/api/{session}/groups/{id}/settings/security/info-admin-only \
  --header 'Content-Type: application/json' \
  --header 'apikey: <api-key>' \
  --data '{
  "adminsOnly": true
}'
{
  "success": true,
  "message": "Configuration updated successfully"
}

​
Description

This endpoint allows configuring if only admins can edit group information (name, description, picture).

​
URL Parameters

​
session
string
required
WhatsApp unique session ID
​
id
string
required
ID of the group in format 120363XXXXX@g.us

​
Body

{
  "locked": true
}

​
Body Parameters

PropertyTypeRequiredDescription
lockedboolean✅ Yestrue to restrict editing to admins only, false to allow all participants

​
Response

{
  "success": true,
  "message": "Configuration updated successfully"
}

​
Status Codes

  • 200 - Configuration updated successfully
  • 400 - Invalid parameters
  • 401 - Unauthorized
  • 403 - No permission (admins only)
  • 404 - Group not found

​
Usage Example

curl -X PUT https://api.wappfy.com.br/api/my-session/groups/120363XXXXX@g.us/settings/security/info-admin-only \
  -H "Content-Type: application/json" \
  -d '{
    "locked": true
  }'

Authorizations

​
apikey
string
header
required

Your Wappfy API key (get it at dash.wappfy.com.br)

Path Parameters

​
id
string
required

ID do Grupo

Body

application/json
​
adminsOnly
boolean
default:true
required
⌘I