Edit Branch

Updates an existing branch. This posts to the same /v2/api/entity/branch path as create; the record to update is identified by the id in the request body. If id is omitted a new branch is created instead.

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.

This is a partial merge, not a full overwrite. Only the fields you include in the body are changed; any field you omit is left untouched. The updatable fields are name, code, and status. Only these fields can be updated — 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.

On success the response is { "message": <localized text>, "id": <id> }. The success message is the same text returned by create, so it does not distinguish an update from an insert.

The status value is one of:

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

curl --location --globoff 'https://.daftara.com/v2/api/entity/branch' \ --header 'Accept: application/json' \ --header 'Authorization: Bearer ' \ --header 'apikey: ' \ --header 'Content-Type: application/json' \ --data '{ "id": 1, "name": "Riyadh Branch (Main)", "status": 1 }'

Request

Responses