Skip to main content
PATCH
/
v1
/
partner
/
brands
/
{id}
Update a brand
curl --request PATCH \
  --url https://api.dev.shadowchef.co/v1/partner/brands/{id} \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "title": "PA-Smoke Brand v2",
  "logo": "/images/placeholder.png",
  "banner": "/images/placeholder.png",
  "branch_ids": [
    1062,
    1136
  ],
  "branch_list_changed": true
}
'
{
  "request_id": "req_4d1b7e3f-...",
  "data": "<unknown>",
  "error": {
    "code": "auth_invalid_credential",
    "message": "<string>",
    "details": "<unknown>"
  }
}

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 BrandCreateUpdateReq. business_id is rewritten from the partner credential, so any value sent in the body is ignored. On update, set branch_list_changed: true whenever branch_ids differs from the current set so the upstream re-runs the many-to-many wiring.

​
title
string
required
Required string length: 1 - 255
​
banner
string
required
​
branch_ids
integer[]
​
branch_list_changed
boolean
default:false
​
populate_menu_for_new_branch
boolean
default:false
​
qr_content
string | null
Maximum string length: 250
​
qr_label
string | null
Maximum string length: 250
​
docket_custom_logo
string | null
​
docket_custom_logo_print_enabled
boolean | null
​
cuisine_ids
integer[]
​
is_virtual
boolean | null
​
marketplace_enabled
boolean | null

Response

Brand 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:

CodeHTTPMeaning
auth_missing401Authorization header absent / malformed
auth_invalid_credential401partner_key or secret_key did not verify
auth_revoked403Credential is revoked
auth_forbidden403Credential not authorized for the requested scope
request_invalid400Body / query parameters failed validation
request_missing_idempotency_key400Write endpoint called without Idempotency-Key
request_invalid_range400Date range > 90 days
resource_not_found404Order / store / mapping does not exist
resource_unmapped404Stock / availability call referenced an unknown SKU
state_invalid_transition409Order PATCH not allowed by current state
state_idempotency_conflict409Same Idempotency-Key reused with a different body
rate_limit_exceeded429Per-credential rate cap hit
downstream_unavailable502An internal klikit dependency is unreachable