Sign in

v1

latestOpenAPI 3.0.02026-07-2491237338.9 KB
WhatsApp Groups

Create a group

Creates a WhatsApp group for the specified business phone number.

The request is processed asynchronously. Use webhooks to receive the final group lifecycle result.

post/whatsapp/{businessPhoneNumber}/groups

Path parameters

businessPhoneNumberstring required
Example:+16315551111

The WhatsApp business phone number in E.164 format.

Request body

subjectstring required

The group subject.

descriptionstring

The group description.

joinApprovalMode'approval_required' | 'auto_approve'

WhatsApp group join approval mode.

  • approval_required: New members must be approved before joining.
  • auto_approve: New members can join without approval.

Example request

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

Response

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