---
title: "Partial update branch"
method: PATCH
path: "/branches/{id}/"
tags: ["Branches"]
---

# Partial update branch

`PATCH /branches/{id}/`

Endpoint for partially updating an existing branch.

## Path parameters

- `id` string, required

## Headers

- `X-Wafeq-Idempotency-Key` string

## Request body

- PatchedBranch — A ModelSerializer that takes additional arguments for "fields", "omit" and "expand" in order to control which fields are displayed, and whether to replace simple values with complex, nested serializations
  - `address` CommonDualLangModel
    - `ar` string — The value in the Arabic language.
    - `en` string, required — The value in the English language.
  - `building_number` string — Building number or identifier of the branch location.
  - `city` CommonDualLangModel
    - `ar` string — The value in the Arabic language.
    - `en` string, required — The value in the English language.
  - `district` CommonDualLangModel
    - `ar` string — The value in the Arabic language.
    - `en` string, required — The value in the English language.
  - `id` string — The unique identifier of the branch.
  - `is_active` boolean — Indicates whether the branch is currently active (True) or inactive (False).
  - `legacy_id` string — [Deprecated] The legacy identifier of the branch.
  - `name` CommonDualLangModel
    - `ar` string — The value in the Arabic language.
    - `en` string, required — The value in the English language.
  - `phone` string — Contact phone number for the branch.
  - `postal_code` string — Postal code or ZIP code of the branch location.
  - `state` string — Emirate for UAE organizations. Read-only field.

## Response `200`

- Branch — A ModelSerializer that takes additional arguments for "fields", "omit" and "expand" in order to control which fields are displayed, and whether to replace simple values with complex, nested serializations
  - `address` CommonDualLangModel, required
    - `ar` string — The value in the Arabic language.
    - `en` string, required — The value in the English language.
  - `building_number` string, required — Building number or identifier of the branch location.
  - `city` CommonDualLangModel, required
    - `ar` string — The value in the Arabic language.
    - `en` string, required — The value in the English language.
  - `district` CommonDualLangModel, required
    - `ar` string — The value in the Arabic language.
    - `en` string, required — The value in the English language.
  - `id` string, required — The unique identifier of the branch.
  - `is_active` boolean — Indicates whether the branch is currently active (True) or inactive (False).
  - `legacy_id` string, required — [Deprecated] The legacy identifier of the branch.
  - `name` CommonDualLangModel, required
    - `ar` string — The value in the Arabic language.
    - `en` string, required — The value in the English language.
  - `phone` string, required — Contact phone number for the branch.
  - `postal_code` string, required — Postal code or ZIP code of the branch location.
  - `state` string, required — Emirate for UAE organizations. Read-only field.

---

[API](https://skmtc.net/wafeq/apis/wafeq-public-api.md) · [All operations](https://skmtc.net/wafeq/apis/wafeq-public-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/wafeq/wafeq-public-api/revisions/36816b4fce7f/schema)