Delete Branch
Permanently delete a branch from the system
Reading time: 1 minute
Delete Branch
Permanently delete a branch from the system.
DELETE
{{base_url}}/branches/{id}Path Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
id | integer | Yes | Branch ID |
Important Warning:
Deletion is permanent and cannot be undone! The following will occur:
- ā Branch will be permanently deleted
- ā All associated contacts will be unlinked
- ā All attached files will be deleted
It is recommended to backup before deletion.
Example Request
Example Requestbash
curl -X DELETE "{{base_url}}/branches/3" \
-H "Accept: 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"Example Response
Response200 OK
{
"status": true,
"message": "Branch deleted successfully"
}Error Codes
| Code | Description | Cause | Solution |
|---|---|---|---|
| 404 | Not Found | Branch not found | Verify branch ID |
| 409 | Conflict | Branch has associated data | Remove associations first |
Related
ā Back to Branches
View Guide