Update brand profile

Updates the brand’s identity and descriptions: name, industry, primary audience, aliases, short and detailed descriptions, key features and main market. These are the same fields the Identity and Descriptions tabs of the Brand Profile page edit, and they land in the same place.

This is a PATCH, not a PUT. Send only the fields you want to change: omit a field to leave it alone, or pass null to clear it. There is no whole-document replace on this API, because one that silently cleared the fields you did not send would be a data-loss bug wearing the right verb.

Requires the write:brand_profile scope, and the workspace must be enabled for API writes.

PATCH /v1/brands/{brand_id}/profile

Authorization

Path parameters

Query parameters

None.

Any parameter you pass returns 400 invalid_request naming the offending key, rather than being ignored silently.

Body

application/json. At least one field is required — an empty body returns 400 invalid_request rather than reporting success for a call that changed nothing.

Every limit matches what the Brand Profile page enforces, so a value written here is one the page can save back.

Request

curl --request PATCH \
  --url 'https://api.askylabs.com/v1/brands/242546de-4cee-4a7d-952e-f6aa60c63ef8/profile' \
  --header 'Authorization: Bearer <api-key>' \
  --header 'Idempotency-Key: <unique-per-attempt>' \
  --header 'Content-Type: application/json' \
  --data '{"industry":"B2B SaaS - AI Search Optimization Platforms","primary_audience":"B2B marketers"}'

import requests
 
url = "https://api.askylabs.com/v1/brands/242546de-4cee-4a7d-952e-f6aa60c63ef8/profile"
 
headers = {"Authorization": "Bearer <api-key>",
    "Idempotency-Key": "<unique-per-attempt>"}
 
payload = {
  "industry": "B2B SaaS - AI Search Optimization Platforms",
  "primary_audience": "B2B marketers"
}
 
response = requests.patch(url, json=payload, headers=headers)
 
print(response.text)

const options = {
  method: 'PATCH',
  headers: {Authorization: 'Bearer <api-key>', 'Idempotency-Key': '<unique-per-attempt>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
  "industry": "B2B SaaS - AI Search Optimization Platforms",
  "primary_audience": "B2B marketers"
})
};
 
fetch('https://api.askylabs.com/v1/brands/242546de-4cee-4a7d-952e-f6aa60c63ef8/profile', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

Response

{
  "data": {
    "profile": {
      "name": "Asky",
      "aliases": ["Asky Labs"],
      "industry": "B2B SaaS - AI Search Optimization Platforms",
      "short_description": "AI search visibility monitoring.",
      "description": "Asky tracks how brands appear across AI search engines…",
      "primary_audience": "B2B marketers",
      "main_market": "Europe",
      "key_features": ["Visibility tracking", "Competitor benchmarks"]
    }
  },
  "request_id": "req_7d21b0af59c34e18b6ac"
}

{
  "error": {
    "code": "token_expired",
    "message": "This API key has expired. Roll it in Settings to get a replacement.",
    "request_id": "req_8f21c0aa47b1490d2e63"
  }
}

{
  "error": {
    "code": "insufficient_scope",
    "message": "This key is restricted to specific brands, and renaming a brand can also rename its workspace. Use a key with access to all brands in the workspace.",
    "request_id": "req_2a71d0ce38f14b9c7d05"
  }
}

{
  "error": {
    "code": "not_found",
    "message": "Not found.",
    "request_id": "req_5b0e77d213a94f6a8ce1"
  }
}

Response fields

The complete profile after the change, so you can put it straight into a cache without a follow-up read. The shape matches the corresponding fields of Get brand profile.

Errors

Notes

Renaming the brand may also rename its workspace, on exactly the same rule the app uses: only when the workspace holds a single active brand, and the workspace becomes "{name} Workspace". A workspace with several brands is left alone, because renaming a shared workspace after one of its brands would be wrong. data.workspace_renamed reports which happened, read back from the database rather than assumed.

Because that reaches an entity above the brand, a key restricted to specific brands may not do it: renaming would let a credential deliberately narrowed to one brand change the workspace it lives in. Such a key gets 403 insufficient_scope with a message naming that reason, and every other field still updates normally. A key with access to all brands behaves exactly like the app.

The workspace rename runs after the brand rename and is reported separately as data.workspace_renamed. false is the normal answer for a multi-brand workspace and needs no action. The brand rename itself always succeeds or the call fails, so a 200 means the brand was renamed either way.

null clears, omission preserves. {"description": null} empties the detailed description; leaving description out entirely keeps whatever is there. For aliases and key_features, both null and [] clear the list.

Not editable here: domains, sitemaps, documentation sources, social profiles, connected social accounts and writing styles. Each either asserts ownership of something outside Asky, schedules crawl work, or holds credentials — none are text edits, so none sit behind this scope. Manage them in the app.

Changing the profile does not re-run anything. Prompt suggestions and alignment read the profile when they next run; updating it does not trigger a refresh, matching the app.

Idempotency-Key is required. Send a unique value per attempt and reuse it when retrying that attempt: a retry replays the original response instead of executing again. See Idempotency.