Add New Branch

Creates a branch.

This is a v2 native-entity endpoint served from the /v2/api/entity base and authenticated with a Bearer token. Requires the Branches plugin to be enabled on the account. The request body is a flat JSON object.

Only three fields are accepted: name, code, and status. This endpoint stores only these fields — id, name, status, created, modified, and code. Other branch attributes (phone numbers, address, city, state, country, assigned staff, SMTP account, map location) are not available through this endpoint.

No server-side field validation is applied. No field is strictly required — a create with any subset of fields returns 200. In practice always send name and code (they map to non-nullable columns; when omitted they are stored as empty values, not rejected). status defaults to 1 (Active).

On success the response is { "message": <localized text>, "id": <new id> }.

The status value is one of:

Value	Meaning
`1`	Active
`2`	Inactive
`3`	Suspended

curl --location '/branch' \ --header 'Accept: application/json' \ --header 'Authorization: Bearer ' \ --header 'apikey: ' \ --header 'Content-Type: application/json' \ --data '{ "name": "Riyadh Branch", "code": "00004", "status": 1 }'

Request

Responses