For AI agents: a machine-readable documentation index for this API is available at /llms.txt. Every page is also available as Markdown: append ".md" to the URL or send an "Accept: text/markdown" request header.

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.