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 Group

Contact Groups

Comprehensive API for managing contact groups and organizing contacts

Reading time: 2 minutes

Contact Groups

Comprehensive management of contact groups to efficiently organize contacts.

Contact Group Operations

List Contact Groups

Display all contact groups with search and pagination support

View Guide
View

Create Contact Group

Create a new group to organize contacts

View Guide
View

Update Contact Group

Modify an existing group's data

View Guide
View

Delete Contact Group

Delete a contact group from the system

View Guide
View

Important Notes

šŸ’”

Status

  • status: 1 = Active (can be used)
  • status: 0 = Inactive (hidden)
  • Status can be changed at any time
āš ļø

Deletion

  • Deleting group does not delete contacts
  • Contacts will remain but without a group
  • It's recommended to move contacts to another group before deletion
āœ…

Best Practices

  • Use clear and distinctive group names
  • Organize groups by category (customers, suppliers, employees)
  • Review groups regularly and clean up unused groups

Use Cases

Create Group and Classify Customers

// 1. Create group
const group = await createContactGroup({
  name: "VIP Customers",
  status: 1
});
 
// 2. Link contacts to group
const contact = await createContact({
  name: "Ahmed Mohammed",
  phone: "96650000000",
  contact_group_id: group.data.id
});

Filter Contacts by Group

GET /contacts?contact_group_id=1&phone_number_id=123456

Error Codes

CodeDescriptionCauseSolution
400Bad RequestInvalid dataCheck sent data
404Not FoundGroup not foundVerify group ID
409ConflictDuplicate group nameUse a different name
422Validation ErrorValidation errorReview error message

Related Sections

Contacts

Manage contacts associated with groups

View Guide
View

Branches

Organize contacts by branches

View Guide
View

Technical Support

Need help?

  • šŸ“§ Email: support@awalchat.com
  • šŸ’¬ Live Chat: Available in dashboard
  • šŸ“± WhatsApp: Contact us directly via WhatsApp
  • šŸ“š Examples: See Code Examples