WAwafeq
Branches

Update branch

Changed on

Endpoint for updating an existing branch.

put/branches/{id}/

Request

  • Base URL
    https://api.wafeq.com/v1
  • URL
    https://api.wafeq.com/v1/branches/{id}/
  • Auth
    API key in header Authorization

Path parameters

idstring required

Headers

X-Wafeq-Idempotency-Keystring

Client-provided UUID to uniquely identify a request

Request body

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.

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.

Changes

  • b8f5e10134b4Revision changes
    • breaking

      added to the request property allOf list (media type: application/json)

    • breaking

      added to the request property allOf list (media type: application/x-www-form-urlencoded)

    • breaking

      added to the request property allOf list (media type: multipart/form-data)

    • breaking

      added to the request property allOf list (media type: application/json)

    • breaking

      added to the request property allOf list (media type: application/x-www-form-urlencoded)

    • breaking

      added to the request property allOf list (media type: multipart/form-data)

    • breaking

      added to the request property allOf list (media type: application/json)

    • breaking

      added to the request property allOf list (media type: application/x-www-form-urlencoded)

    • breaking

      added to the request property allOf list (media type: multipart/form-data)

    • breaking

      added to the request property allOf list (media type: application/json)

    • breaking

      added to the request property allOf list (media type: application/x-www-form-urlencoded)

    • breaking

      added to the request property allOf list (media type: multipart/form-data)

    • warning

      removed from the request property allOf list (media type: application/json)

    • warning

      removed from the request property allOf list (media type: application/x-www-form-urlencoded)

    • warning

      removed from the request property allOf list (media type: multipart/form-data)

    • warning

      removed from the request property allOf list (media type: application/json)

    • warning

      removed from the request property allOf list (media type: application/x-www-form-urlencoded)

    • warning

      removed from the request property allOf list (media type: multipart/form-data)

    • warning

      removed from the request property allOf list (media type: application/json)

    • warning

      removed from the request property allOf list (media type: application/x-www-form-urlencoded)

    • warning

      removed from the request property allOf list (media type: multipart/form-data)

    • warning

      removed from the request property allOf list (media type: application/json)

    • warning

      removed from the request property allOf list (media type: application/x-www-form-urlencoded)

    • warning

      removed from the request property allOf list (media type: multipart/form-data)

    • info

      added to the response property allOf list for the response status

    • info

      added to the response property allOf list for the response status

    • info

      added to the response property allOf list for the response status

    • info

      added to the response property allOf list for the response status

    • info

      removed from the response property allOf list for the response status

    • info

      removed from the response property allOf list for the response status

    • info

      removed from the response property allOf list for the response status

    • info

      removed from the response property allOf list for the response status