Update a brand through the APIBeta
Which brand fields a PATCH request can change, the limits, and what it cannot touch.
Beta. The Brand API is in beta. Fields can still be added to version 1, and any breaking change will ship as a new version (/api/v2) rather than change v1.
PATCH /api/v1/brands/{brand} changes a brand. The token needs the brands:write scope. Send a JSON body with at least one field. Fields you leave out stay as they are.
Fields you can change
Field | Notes |
|---|---|
| Up to 120 characters. |
| Up to 500 characters. |
| Up to 6,000 characters. |
| Up to 80 characters each. |
| The year the company was founded. |
| The brand's website address. |
| Up to 200 characters each. |
| A color in |
|
|
|
|
|
|
| An object with |
| The page title for search results, up to 160 characters. |
| The description for search results, up to 320 characters. |
| The heading above the team, up to 40 characters. |
What you cannot change
The slug and the id.
Files, such as logos, banners and collection files.
Passwords. Setting
accesstopublicremoves an existing password, but the API never sets one.Domains.
Example
curl -X PATCH \
-H "Authorization: Bearer $TARKLE_TOKEN" \
-H "Content-Type: application/json" \
-d '{"summary":"Business banking for SMEs","tracking":{"ga4":"G-XXXXXXXXXX"}}' \
https://tarkle.com/api/v1/brands/aspireA field that is not allowed, a value that is too long or a body with no fields returns 400 with the code invalid_request and a message that says what to fix.