Skip to main content
POST

Authorizations

X-API-Key
string
header
required

Path Parameters

businessPhoneNumber
string
required

The WhatsApp business phone number in E.164 format.

Example:

"+16315551111"

Body

application/json
subject
string
required

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."

joinApprovalMode
enum<string>

Defaults to auto_approve when omitted.

Available options:
approval_required,
auto_approve
Example:

"auto_approve"

Response

The group creation 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"