WhatsApp Group Settings Update Webhook Examples

Settings Updated

When WhatsApp group settings are successfully updated, you will receive a webhook with the following payload structure:

{
  "id": "evt_group_settings_123",
  "type": "whatsapp.group.settings_update",
  "apiVersion": "v2",
  "createTime": "2026-05-13T00:00:00.000Z",
  "whatsappGroup": {
    "tenantId": "tenant-id",
    "wabaId": "123456789012345",
    "field": "group_settings_update",
    "type": "group_settings_update",
    "requestId": "REQ_2",
    "status": "updated",
    "groupId": "[email protected]",
    "subject": "Updated Purchase Inquiry",
    "description": "Updated group description.",
    "settings": [
      {
        "name": "group_subject",
        "text": "Updated Purchase Inquiry",
        "updateSuccessful": true
      },
      {
        "name": "group_description",
        "text": "Updated group description.",
        "updateSuccessful": true
      }
    ],
    "webhookTime": "2026-05-13T00:00:00.000Z"
  }
}

Settings Update Failed

When a WhatsApp group settings update fails or partially fails, you will receive a webhook with the following payload structure:

{
  "id": "evt_group_settings_124",
  "type": "whatsapp.group.settings_update",
  "apiVersion": "v2",
  "createTime": "2026-05-13T00:00:00.000Z",
  "whatsappGroup": {
    "tenantId": "tenant-id",
    "wabaId": "123456789012345",
    "field": "group_settings_update",
    "type": "group_settings_update",
    "requestId": "REQ_SETTINGS",
    "status": "failed",
    "groupId": "[email protected]",
    "subject": "New subject",
    "settings": [
      {
        "name": "group_subject",
        "text": "New subject",
        "updateSuccessful": false,
        "errors": [
          {
            "code": 131201,
            "title": "Invalid group subject"
          }
        ]
      }
    ],
    "webhookTime": "2026-05-13T00:00:00.000Z"
  }
}

Payload Description

type: Always whatsapp.group.settings_update for group settings events
whatsappGroup: Contains the group settings update result details
- field: Always group_settings_update
- type: Always group_settings_update
- requestId: The request ID returned by the asynchronous group settings API operation
- status: The normalized settings update status, either updated or failed
- groupId: The WhatsApp group ID
- subject and description: The group text settings when present
- settings: Per-setting update results. name can be profile_picture, group_subject, or group_description
- settings[].updateSuccessful: Indicates whether the individual setting update succeeded
- settings[].errors: Errors returned by WhatsApp for the individual setting