Skip to main content
PATCH

Authorizations

X-API-Key
string
header
required

Path Parameters

businessPhoneNumber
string
required

The WhatsApp business phone number in E.164 format.

Example:

"+16315551111"

groupId
string
required

WhatsApp group ID.

Example:

"120363345678901234@g.us"

Body

Contains the group settings to update. At least one of subject or description is required.

subject
string

The group subject.

Maximum string length: 128
Example:

"New Purchase Inquiry"

description
string

The group description.

Maximum string length: 2048
Example:

"Group for purchase inquiries."

Response

The group settings update request is successfully accepted.

Response for asynchronous WhatsApp group operations.

requestId
string

The request ID for tracking the asynchronous operation in webhooks.

Example:

"REQ_1"

status
enum<string>

The asynchronous request status.

Available options:
pending
Example:

"pending"