Skip to main content
PATCH
Update a branch

Authorizations

Authorization
string
header
required

Authorization: Basic base64(partner_key:secret_key).

Credentials are issued by a klikit operator. The plaintext secret_key is shown once at issuance and cannot be retrieved later — store it securely. If lost, ask your operator to rotate the secret to receive a new one. The old secret stops working immediately on rotation; there is no overlap window.

Path Parameters

id
integer
required

Body

application/json

Mirrors core's BranchCreateUpdateReq. business_id is overwritten by the forwarder. phone must be E.164 (+<country><digits>). available_times follows the same weekday-keyed shape as section availability.

title
string
required
Required string length: 1 - 255
address
string
required
Required string length: 5 - 255
phone
string
required

E.164

lat
number
required
lon
number
required
country_id
enum<integer>
required

Numeric country id used inside BranchCreateRequest.country_id and a few other resolver calls. Only ids with configured = 1 are listed — anything outside this list is rejected upstream.

Available options:
1,
2,
3,
4,
5,
6,
7,
8,
9,
10,
11,
12,
23,
30,
38,
43,
59,
64,
75,
101,
151,
167,
168,
182
city_id
integer
required

Must belong to the supplied country_id — core validates the pair against the cities table and the gateway returns 502 downstream_unavailable on a join miss. See CityId for the per-country city list.

currency_id
enum<integer>
required

Numeric currency id used inside BranchCreateRequest.currency_id. Each id is paired with the matching ISO 4217 code partners already use inside PriceMap (the string key under each provider entry).

Available options:
1,
2,
3,
4,
5,
6,
7,
8,
9,
10,
11,
12,
13,
14,
15,
16,
17,
18,
19,
20,
21,
22,
23,
24
day_availability
integer[]
required
Required array length: 1 - 7 elements
Required range: 0 <= x <= 6
subscription_type
integer
required
available_times
object
required

Weekly schedule keyed by weekday number as a string: "0" = Sunday … "6" = Saturday. Every day must have at least one slot. To make a section dark for a day, set disabled: true and pass any placeholder slot (the disabled flag wins).

Example:
custom_vat_config
boolean
required
secondary_phone
string | null
brand_ids
integer[]
kitchen_equipment_ids
integer[]
brand_list_changed
boolean
default:false
kitchen_equipment_list_changed
boolean
default:false
populate_menu_for_new_brand
boolean
default:false
vat_enabled
boolean | null
vat_inclusive
boolean | null
vat_label
string | null
vat_calculation_pre_discount
boolean | null
vat_percentage
number | null
prioritize_item_level_vat
boolean | null
order_cleanup_time
integer

Cleanup window in minutes.

manual_order_auto_accept_enabled
boolean
default:false
is_shift_enabled
boolean
default:false
is_driver_progress_enabled
boolean
default:false
marketplace_enabled
boolean | null
webshop_otp_required
boolean | null
bir_config_enabled
boolean | null
price_group_id
integer | null

Pricing group this branch sells at (see listPriceGroups). Update semantics: a PATCH body that omits this field CLEARS an existing assignment (branch reverts to base prices) — once a branch is on a group, include price_group_id in every branch update you send.

Response

Branch updated.

Canonical response wrapper. Every response — success or error — carries the request_id so you can quote one id to klikit support to correlate a request end-to-end.

request_id
string
required
Example:

"req_4d1b7e3f-..."

data
any

Endpoint-specific payload on success.

error
object

Machine-readable error code + human message. The code is stable across releases — switch on code in your client code rather than parsing the message text.

Common codes you will encounter as a partner: