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 GroupUpdate Contact Group

Update Contact Group

Modify an existing group's data

Reading time: 1 minute

Update Contact Group

Modify an existing group's data.

PATCH{{base_url}}/contact-groups/{id}

Path Parameters

ParameterTypeRequiredDescription
idintegerYesGroup ID

Request Body (JSON)

ParameterTypeRequiredDescription
namestringNoUpdated group name
statusintegerNoGroup status: 1 = active, 0 = inactive

Partial Update: You can send only the fields you want to update.

Example Request

Example Requestbash
curl -X PATCH "{{base_url}}/contact-groups/1" \
-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": "Updated Customers",
  "status": 1
}'

Example Response

Response200 OK
{
"status": true,
"message": "Group updated successfully",
"data": {
  "id": 1,
  "name": "Updated Customers",
  "status": 1,
  "updated_at": "2024-01-20T14:30:00Z"
}
}

Related

← Back to Contact Groups
View Guide
View