Hey, human!
HTTP/2 200 OK content-type: text/markdown; charset=utf-8 vary: accept, user-agent x-agent: [ai_agent]
Loading the agent response…
Update a brand
Changes the brand fields you send and leaves the rest alone. Send at least one field; unknown fields are refused. The slug, passwords and domains cannot be changed here. A team member's photo and a guideline section's images can be sent by address (photo_url, images: [{url, kind, caption}]): they are fetched after the text is saved, and the answer's pictures list says which worked; a picture that fails never undoes the text. Pictures can also be removed with removeBrandFile. Setting access to public on a brand that is not public yet needs confirm_public: true, otherwise the call is refused with 400 confirmation_required. Returns the whole brand after the change. Needs brands:write.
What you provide
- Summaryoptional
- Storyoptional
- Sizeoptional
- Company typeoptional
- Year foundedoptional: A four digit year, or empty to clear
- Urloptional: A public website address, or empty to clear. Same as website
- Websiteoptional: Same as url
- Twitteroptional
- Facebookoptional
- Instagramoptional
- Linkedinoptional
- Youtubeoptional
- Githuboptional
- Socialoptional
- Primary coloroptional
- Colorsoptional: primary, secondary and the extra colors. additional replaces the whole extra list (up to 30); sending only one of secondary or additional keeps the other as it is
- Print valuesoptional: CMYK and Pantone values per color hex, as GET returns them (up to 40)
- Auto logo variantsoptional: Make black and white logo downloads automatically
- Fontsoptional: headline and body font, each { source: google | adobe, name } or null to clear. A Google name must be a Google Fonts family (checked). Adobe also needs css (the family's CSS name) and tracking.adobe_kit. A custom font is a file uploaded in the app; the API does not set one.
- Teamoptional: The people section: a heading (up to 30 characters) and up to 24 members. A photo is kept for a member you send again; photo_url sets or replaces it
- Pressoptional: Articles written about the brand
- Guidelinesoptional: Guideline sections (up to 20). Existing section images stay for a section you send again with its id; images adds more
- Download approvaloptional
- Seooptional
- Meta titleoptional
- Meta descriptionoptional
- Team titleoptional
- Trackingoptional: Google Analytics 4 id (G-...), Tag Manager id (GTM-...), Search Console token and Adobe Fonts project. Only the keys sent change
- Nameoptional
- Industryoptional
- Accessoptional: public also removes the password. restricted needs a contact or organization assigned first
- Confirm publicoptional: Must be true when access changes to public on a brand that is not public yet; otherwise the call is refused (400 confirmation_required)
- Is draftoptional
Do this with AI
I want to update a brand. Use the Tarkle API. Read the reference for this operation and follow it exactly: https://project-03b42162.restlessdocs.com/endpoint/updatebrand.md Authenticate with your API key as a Bearer token in the Authorization header. Then make the request for me and tell me what came back.
Paste this into Claude, Cursor, or any AI assistant and it will do it for you.
https://tarkle.com/api/v1/brands/{brand}curl --request PATCH \
--url https://tarkle.com/api/v1/brands/brand \
--header 'Authorization: Bearer $API_KEY' \
--header 'Content-Type: application/json' \
--header 'X-Workspace-Key: X-Workspace-Key' \
--data '
{
"summary": "summary",
"story": "story",
"size": "",
"company_type": "",
"year_founded": "year_founded",
"url": "url",
"website": "website",
"twitter": "twitter",
"facebook": "facebook",
"instagram": "instagram",
"linkedin": "linkedin",
"youtube": "youtube",
"github": "github",
"social": {
"twitter": "twitter",
"facebook": "facebook",
"instagram": "instagram",
"linkedin": "linkedin",
"youtube": "youtube",
"github": "github"
},
"primary_color": "primary_color",
"colors": {
"primary": "primary",
"secondary": "secondary",
"additional": [
{
"name": "name",
"value": "value"
}
]
},
"print_values": {},
"auto_logo_variants": true,
"fonts": {
"headline": null,
"body": null
},
"team": {
"title": "title",
"members": [
{
"id": "id",
"name": "name",
"title": "title",
"photo_url": "photo_url"
}
]
},
"press": [
{
"id": "id",
"url": "url",
"title": "title",
"description": "description",
"image": "image",
"source": "source"
}
],
"guidelines": [
{
"id": "id",
"title": "title",
"text": "text",
"images": [
{
"id": "id",
"url": "url",
"kind": "image",
"caption": "caption"
}
]
}
],
"download_approval": true,
"seo": {
"title": "title",
"description": "description"
},
"meta_title": "meta_title",
"meta_description": "meta_description",
"team_title": "team_title",
"tracking": {
"ga4": "ga4",
"gtm": "gtm",
"search_console": "search_console",
"adobe_kit": "adobe_kit"
},
"name": "name",
"industry": "Arts and Entertainment",
"access": "public",
"confirm_public": true,
"is_draft": true
}
'Path parameters
brandstringrequiredBrand id (uuid) or slug
Query parameters
workspace_keystringThe same key as the X-Workspace-Key header, for clients that cannot set headers. Send one of the two, or both with the same value (different values are 400 conflicting_workspace)
Header parameters
X-Workspace-KeystringrequiredThe 8-character key of the workspace this call acts on; GET /workspaces lists the keys a token can use. A workspace id is refused (400 workspace_key_required)
Idempotency-KeystringMakes a write safe to repeat. Send a random value (a UUID is fine) of up to 255 visible characters. A repeat of the same request gets the first answer again, with the header `Idempotent-Replayed: true`, and does nothing twice. The same key for a different request is 422 `idempotency_key_reused`; the same request while the first one is still running is 409 `idempotency_in_progress`. A 5xx or 429 is not remembered, so retrying it runs the request again. Keys last 24 hours and belong to the account that created the token.
Body
application/jsonrequiredsummarystringstorystringsizestringcompany_typestringyear_foundedstringA four digit year, or empty to clear
urlstringA public website address, or empty to clear. Same as website
websitestringSame as url
twitterstringfacebookstringinstagramstringlinkedinstringyoutubestringgithubstringtwitterstringfacebookstringinstagramstringlinkedinstringyoutubestringgithubstringprimary_colorstringprimary, secondary and the extra colors. additional replaces the whole extra list (up to 30); sending only one of secondary or additional keeps the other as it is
primarystringsecondarystring | nullprint_valuesobjectCMYK and Pantone values per color hex, as GET returns them (up to 40)
auto_logo_variantsbooleanMake black and white logo downloads automatically
headline and body font, each { source: google | adobe, name } or null to clear. A Google name must be a Google Fonts family (checked). Adobe also needs css (the family's CSS name) and tracking.adobe_kit. A custom font is a file uploaded in the app; the API does not set one.
The people section: a heading (up to 30 characters) and up to 24 members. A photo is kept for a member you send again; photo_url sets or replaces it
titlestringArticles written about the brand
idstringurlstringrequiredA public page address
titlestringdescriptionstringimagestringA public image address shown with the article
sourcestringGuideline sections (up to 20). Existing section images stay for a section you send again with its id; images adds more
idstringtitlestringtextstringPlain text: blank line between paragraphs, '- ' for bullets, '## ' for a heading
Pictures to add to the section, fetched after the text is saved (an entry without url is ignored, so a read can be sent back)
download_approvalbooleantitlestringdescriptionstringmeta_titlestringmeta_descriptionstringteam_titlestringGoogle Analytics 4 id (G-...), Tag Manager id (GTM-...), Search Console token and Adobe Fonts project. Only the keys sent change
ga4stringgtmstringsearch_consolestringadobe_kitstringnamestringindustrystringaccessstringpublic also removes the password. restricted needs a contact or organization assigned first
confirm_publicbooleanMust be true when access changes to public on a brand that is not public yet; otherwise the call is refused (400 confirmation_required)
is_draftboolean