Sign in

v1

latestOpenAPI 3.1.12026-07-24260246894.7 KB
Branches

Partial update branch

Endpoint for partially updating an existing branch.

patch/branches/{id}/

Path parameters

idstring required

Headers

X-Wafeq-Idempotency-Keystring

Client-provided UUID to uniquely identify a request

Request body

building_numberstring

Building number or identifier of the branch location.

idstring

The unique identifier of the branch.

is_activeboolean

Indicates whether the branch is currently active (True) or inactive (False).

legacy_idstring

[Deprecated] The legacy identifier of the branch.

phonestring

Contact phone number for the branch.

postal_codestring

Postal code or ZIP code of the branch location.

statestring

Emirate for UAE organizations. Read-only field.

Response

building_numberstring required

Building number or identifier of the branch location.

idstring required

The unique identifier of the branch.

is_activeboolean

Indicates whether the branch is currently active (True) or inactive (False).

legacy_idstring required

[Deprecated] The legacy identifier of the branch.

phonestring required

Contact phone number for the branch.

postal_codestring required

Postal code or ZIP code of the branch location.

statestring required

Emirate for UAE organizations. Read-only field.