---
title: "The stored setup draft, if any"
method: GET
path: "/brands/{brandId}/setup-suggestions"
tags: ["brands"]
---

# The stored setup draft, if any

`GET /brands/{brandId}/setup-suggestions`

## Request

- Base URL: `https://shruwd.io/api/v1`
- URL: `https://shruwd.io/api/v1/brands/{brandId}/setup-suggestions`
- Auth: HTTP bearer

Prompts, each with the page that should answer it, and up to six competitors,
drafted from the brand's homepage and sitemap by `POST`. Reading never drafts. `suggestions` is null until a draft exists.

## Response `200`

The draft, or null.

- object
  - `suggestions` SetupSuggestions, required: A draft for a person to review. Nothing in it is tracked or measured until it is added.
    - `brandId` string, required
    - `sourceUrl` string, nullable, required: The page it was read from. Null when the site could not be fetched and the draft rests on the name and domain.
    - `prompts` object[], required
      - `text` string, required
      - `intent` 'informational' | 'comparison' | 'commercial' | 'navigational' | 'problem', required: Why someone would ask the prompt. `informational` — learning about a topic. `comparison` — weighing named options. `commercial` — choosing what to buy. `navigational` — looking for a specific site or brand. `problem` — fixing something. The intent decides which diagnostic rules apply to the prompt's results.
      - `page` string, nullable, required: The page on the brand's site that should answer it, chosen from the site's own pages. Null when none does. Send it with the prompt when adding it; findings about the question name it.
    - `competitors` object[], required
      - `name` string, required: As answers write it: the brand people name, not a product line.
      - `domain` string, nullable, required: Registrable domain, when the draft was confident of one.
      - `aliases` string[], required: Other exact spellings answers use for the same company. Never a short or common word. Send them with the name when adding the competitor.
      - `contextTerms` string[], required: Only for a name that needs context terms (six characters or fewer, or an ordinary English word); empty otherwise.
    - `generatedAt` string, date-time, required

## Other responses

- `404`: `not_found`: no such resource in this workspace.
- `default`: Every failure has this body.

---

[API](https://skmtc.dev/shruwd/apis/shruwd-api.md) · [All operations](https://skmtc.dev/shruwd/apis/shruwd-api/llms.txt) · [OpenAPI document](https://skmtc.dev/shruwd/apis/shruwd-api/revisions/64a5da079928?raw)