HomeUser GuidesAPI Reference
Get Started
HomeAPI Reference
Authentication
Branches
Contact Groups
Contacts
Conversations
Error HandlingInvoices
Messages
Orders
Rate LimitingSDKs & Code ExamplesTemplatesTicketsAPI VersioningWABA NumbersWebhooks
User GuideAPI ReferenceCreate Contact GroupCreate Contact Group

Create Contact Group

Create a new group to organize contacts

Reading time: 1 minute

Create Contact Group

Create a new group to organize contacts.

POST{{base_url}}/contact-groups

Request Body (JSON)

ParameterTypeRequiredDescriptionDefault
namestringYesGroup name (max 255 characters)-
statusintegerYesGroup status: 1 = active, 0 = inactive1

Status:

  • status: 1 - Group is active and can be used
  • status: 0 - Group is inactive and hidden

Example Request

Example Requestbash
curl -X POST "{{base_url}}/contact-groups" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "X-Awal-Signature-256: sha256=abc..." \
-H "X-Timestamp: 1704124800" \
-H "X-Domain: your-workspace" \
-H "X-Client-ID: your-client-id" \
-d '{
  "name": "VIP Customers",
  "status": 1
}'

Example Response

Response201 Created
{
"status": true,
"message": "Group created successfully",
"data": {
  "id": 2,
  "name": "VIP Customers",
  "status": 1,
  "contacts_count": 0,
  "created_at": "2024-01-15T10:30:00Z"
}
}

Related

← Back to Contact Groups
View Guide
View