Parameters
| Name | Type | Required | Description |
|---|---|---|---|
brandId | string | Yes | Brand ID from ocoya_list_brands. |
description | string | No | What the brand does. |
url | string or null | No | Website. Normalised as Ocoya does (ocoya.com becomes https://ocoya.com). An empty string or null clears it. |
tone | string[] | No | Up to 3 of Friendly, Professional, Playful, Warm, Bold, Witty, Inspiring, Calm, Expert, Casual. |
guidelines | string or null | No | Extra writing guidelines, up to 2000 characters. |
keywords | string[] | No | SEO keywords, up to 20. Lowercased and de-duplicated. Search volumes stay for keywords you keep. |
hashtags | string[] | No | Hashtags, up to 200. Stored lowercase without #, so #Small Business becomes smallbusiness. |
colors | string[] | No | Hex colors such as #1a2b3c, up to 8. |
Only the fields you send change. A list replaces the current one, so to add a keyword, send the current keywords from ocoya_get_brand plus the new one.
Request example
{
"name": "ocoya_update_brand",
"arguments": {
"brandId": "cmayvq3hk00017apshay5qezu",
"tone": ["Friendly", "Expert"],
"hashtags": ["socialmedia", "smallbusiness"]
}
}Returns
Returns the updated brand profile, in the same shape as ocoya_get_brand, with the new brand score.
The values are checked the same way as on the Brand page. A value the page would not accept, such as a fourth tone, an unknown tone or 2001 characters of guidelines, fails with a message and nothing is saved.
Only brand owners and admins can update a brand, as in Ocoya. The tool needs the brand:write scope: a connection approved before this scope existed has to be reconnected. This tool changes existing content in Ocoya.