Skip to main content
POST
/
v1
/
whatsapp
/
groups
cURL
curl --request POST \
  --url https://api.buildwithchirp.com/v1/whatsapp/groups \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "whatsappPhoneNumberId": "wapn_2DbBs7GWhGvVNJGrDXr5RG0",
  "subject": "Customer Support",
  "description": "Support channel for premium customers",
  "joinApprovalMode": "auto_approve"
}
'
{
  "group": {
    "id": "<string>",
    "metaGroupId": "<string>",
    "subject": "<string>",
    "description": "<string>",
    "joinApprovalMode": "auto_approve",
    "inviteLink": "<string>",
    "suspended": true,
    "totalParticipantCount": 123,
    "whatsappPhoneNumberId": "<string>",
    "createdAt": "<string>"
  }
}

Authorizations

​
Authorization
string
header
required

App API key (format: sk_live_app_* or sk_test_app_*) for app-level operations

Body

application/json
​
whatsappPhoneNumberId
string
required

ID of the WhatsApp phone number to create the group from

Example:

"wapn_2DbBs7GWhGvVNJGrDXr5RG0"

​
subject
string
required

Group subject (1-60 characters)

Required string length: 1 - 60
Example:

"Customer Support"

​
description
string

Group description (max 2048 characters)

Maximum string length: 2048
Example:

"Support channel for premium customers"

​
joinApprovalMode
enum<string>

How join requests are handled

Available options:
auto_approve,
approval_required
Example:

"auto_approve"

Response

Group created successfully

​
group
object
required