Update a branch

Admin only. Patches a branch’s name, city, address, VAT number, flag, or currency. Closing a branch is done by setting is_active false, and the code itself is fixed once the branch exists.

PUT/api/v1/branches/{branchId}

Authorization

AuthorizationBearer token (JWT) · headerrequired

JWT from POST /api/v1/auth/login sent as Authorization Bearer.

Path parameters

branchIdstringrequired

The branch being updated.

Request body

requiredapplication/json

namestring

citystring

vat_numberstring

addressstring

is_activeboolean

currency_codestring

Responses

200

Branch updated

idstringrequired

codestringrequired

namestringrequired

citystringrequired

vat_numberstringrequired

addressstringrequired

currency_codestringrequired

image_urlstringrequired

is_activebooleanrequired

is_deletedintegerrequired

min -9007199254740991 · max 9007199254740991

created_atstringrequired

updated_atstringrequired

400

No valid fields to update, or the currency is unknown

detailstringrequired

401

Not authenticated

detailstringrequired

403

Caller is not an admin

detailstringrequired

404

Branch not found

detailstringrequired

Try it

Server

Base URLCustom base URLOverrides the selected server when set.

Authorization

Bearer token (JWT)Remember on this deviceInclude my values in samples

Parameters

branchIdpath*The branch being updated.

Bodyapplication/json

namestringcitystringvat_numberstringaddressstringis_activebooleancurrency_codestring

Request

curl -X PUT 'http://localhost:8000/api/v1/branches/string' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Content-Type: application/json' \
  -d '{
  "name": "string",
  "city": "string",
  "vat_number": "string",
  "address": "string",
  "is_active": true,
  "currency_code": "string"
}'

const response = await fetch("http://localhost:8000/api/v1/branches/string", {
  method: "PUT",
  headers: {
    "Authorization": "Bearer YOUR_TOKEN",
    "Content-Type": "application/json"
  },
  body: "{\n  \"name\": \"string\",\n  \"city\": \"string\",\n  \"vat_number\": \"string\",\n  \"address\": \"string\",\n  \"is_active\": true,\n  \"currency_code\": \"string\"\n}"
});

import requests

response = requests.put(
    "http://localhost:8000/api/v1/branches/string",
    headers={
        "Authorization": "Bearer YOUR_TOKEN",
        "Content-Type": "application/json"
    },
    data="{\n  \"name\": \"string\",\n  \"city\": \"string\",\n  \"vat_number\": \"string\",\n  \"address\": \"string\",\n  \"is_active\": true,\n  \"currency_code\": \"string\"\n}",
)

Response

{
  "id": "string",
  "code": "string",
  "name": "string",
  "city": "string",
  "vat_number": "string",
  "address": "string",
  "currency_code": "string",
  "image_url": "string",
  "is_active": true,
  "is_deleted": -9007199254740991,
  "created_at": "string",
  "updated_at": "string"
}

{
  "detail": "string"
}

{
  "detail": "string"
}

{
  "detail": "string"
}

{
  "detail": "string"
}