Get brand website candidates
Lists the websites that may belong to the active brand: the website saved on the brand, the domain of the user's email, and the domains its recent ads link to.
Tool name: get-brand-website-candidates.
Lists the websites that may belong to the active brand: the website saved on the brand, the domain of the user's email, and the domains its recent ads link to. Also says whether the brand already has a style guide. Read-only.
When to use
Before building a brand style guide, to offer the user website options to choose from. Not needed when get-brand-style-guide already returns a confirmed guide.
Access
| Property | Value |
|---|---|
| Required scope | read |
| Publishes | No |
| Read-only | Yes |
| Destructive | No |
| Idempotent | Yes |
| Open world | No |
Input
This tool takes no input.
Output
| Field | Type | Required | Description |
|---|---|---|---|
brandUrl | string | null | Yes | The website saved on the brand. |
emailDomain | string | null | Yes | The domain of the user's email. It may be a personal email provider rather than the brand. |
recentAdDomains | object[] | Yes | Domains the brand's recent ads link to, newest first. |
styleGuide | object | Yes |
REST equivalent
GET /v1/brands/{brandId}/style-guide/website-candidates, Get brand website candidates. CLI: koast get-brand-website-candidates.
Get brand style guide
Returns the active brand's style guide, when the user confirmed it, its logo, fontCss: CSS that loads the guide's fonts in an HTML layout, the website images kept by the last extract-brand-style, and taste: the images the brand's people liked, disliked or picked as references, and agencyAdAccount: whether the brand runs ads on an agency ad account from Koast, whose ads the partner also reviews, with stricter rules than Meta's.
Save brand style guide
Saves the active brand's style guide, replacing any earlier one from the same site: palette, typography, shapes, logo, imagery, voice, and do and don't rules.