---
title: "Update Supplier Branch"
method: PATCH
path: "/supplier_provider/{supplier_provider_uid}/branches/{branch_uid}"
---

# Update Supplier Branch

`PATCH /supplier_provider/{supplier_provider_uid}/branches/{branch_uid}`

## Request

- Base URL: `https://dc-region.zuperpro.com/api`
- URL: `https://dc-region.zuperpro.com/api/supplier_provider/{supplier_provider_uid}/branches/{branch_uid}`
- Auth: API key in header `x-api-key`

Updates a supplier branch saved in Zuper: its name, the job account used for orders, whether it is active, and whether it is the favorite (default) branch. Only the fields listed in the body schema are applied; other branch fields (address, email, delivery method, payment term) are validated but ignored, and the job account is not re-checked with the supplier. `favorite_supplier_vendor` defaults to `false`, so omitting it clears the favorite flag on this branch; sending `true` clears it on every other saved branch of the same supplier type. Deactivating the favorite branch, or setting `favorite_supplier_vendor: false` when no other branch of that supplier type is favorite, fails with 409. Admin only: the API key must belong to an admin user; other roles receive 405 Access Denied. The provider must exist and be `CONNECTED`; otherwise the request fails with 404 (unknown provider) or 403 (not connected or reconnect required).

## Path parameters

- `supplier_provider_uid` string, required
- `branch_uid` string, required

## Request body

- object
  - `branch` object, required: Required. Fields to update.
    - `branch_name` string: Updates both the vendor name and the stored branch name.
    - `preferred_job_account_number` string: Job account used when ordering from this branch (a number is also accepted). Not re-checked with the supplier.
    - `preferred_job_account_name` string
    - `is_active` boolean: Activate or deactivate the branch. The favorite branch cannot be deactivated.
    - `favorite_supplier_vendor` boolean: Make this the favorite branch. Omitting it clears the flag on this branch.

## Response `200`

200

- object
  - `type` 'success'
  - `title` string
  - `message` string
  - `data` object
    - `branch_uid` string

## Other responses

- `400`: 400
- `403`: 403
- `404`: 404
- `405`: 405
- `409`: 409

## Changes

- **2026-11-03** `3c21bc232e16`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/zuper/apis/zuper-pro-api/changes/supplier_provider/:supplier_provider_uid/branches/:branch_uid/patch.md)

---

[API](https://skmtc.dev/zuper/apis/zuper-pro-api.md) - [All operations](https://skmtc.dev/zuper/apis/zuper-pro-api/llms.txt) - [OpenAPI document](https://skmtc.dev/zuper/apis/zuper-pro-api/revisions/3c21bc232e16?raw)
