v1

latestOpenAPI 3.0.02026-07-2491237338.9 KB
WhatsApp Groups

Update group settings

Updates a WhatsApp group's settings, such as subject or description.

The request is processed asynchronously. Use webhooks to receive the final settings update result.

patch/whatsapp/{businessPhoneNumber}/groups/{groupId}/settings

Path parameters

businessPhoneNumberstring required
Example:+16315551111

The WhatsApp business phone number in E.164 format.

groupIdstring required
Example:120363345678901234@g.us

WhatsApp group ID.

Request body

subjectstring

The group subject.

descriptionstring

The group description.

Example request

{
  "subject": "New Purchase Inquiry",
  "description": "Group for purchase inquiries."
}

Response

The group settings update request is successfully accepted.

requestIdstring

The request ID for tracking the asynchronous operation in webhooks.

status'pending'

The asynchronous request status.

Example response

{
  "requestId": "REQ_1",
  "status": "pending"
}