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 Branch

Branches

Comprehensive API for managing business branches in the system

Reading time: 2 minutes

Branches

Comprehensive management of multiple business branches with support for organization and classification.

Overview

Branch management allows you to:

  • āœ… Organize your business into multiple branches
  • āœ… Assign contacts to specific branches
  • āœ… Track orders by branch
  • āœ… Manage contact groups for each branch

Branch Operations

List Branches

Display all branches with search and pagination support

View Guide
View

Create Branch

Add a new branch with all details

View Guide
View

Update Branch

Modify an existing branch's data

View Guide
View

Delete Branch

Permanently delete a branch from the system

View Guide
View

Best Practices

āœ… Recommended Practices

  • Use clear and distinctive branch names
  • Add complete contact information
  • Update data regularly
  • Use favorite branch for main branch
  • Add logo/image for each branch

āŒ Practices to Avoid

  • Don't use generic names like "Branch 1"
  • Don't leave contact fields empty
  • Don't delete branches with associated data
  • Don't use large files (> 10MB)
  • Don't forget to link contact groups

Integration with Other APIs

Linking Branches with Contacts

Link with Contactsjavascript
// 1. Create branch
const branch = await createBranch({
name: "Riyadh Branch",
phone: "966500000000"
});

// 2. Create contact linked to branch
const contact = await createContact({
name: "Ahmed Mohammed",
phone: "966501234567",
branch_id: branch.data.id
});

Linking Branches with Orders

Link with Ordersjavascript
// Update order and link to branch
const order = await updateOrder(orderId, {
branch_id: branchId,
status: "processing"
});

Related Sections

Contacts

Manage contacts associated with branches

View Guide
View

Contact Groups

Organize contacts into groups

View Guide
View

Orders

Manage orders by branch

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