Brief

Update the site brief

Edits the site brief and leaves what you do not send alone. Send at least one of: head (fields to change; null clears an optional field, purpose can only be replaced), body (replaces the free text), goal and notes (replace their sections), rules (add or change rules & guidelines, matched by id), removeRules (delete lines by id) and appendHandoff (adds a line to the hand-off log). notes is a string (the free-form notes) or { design, content, seo } (per-section notes; null clears one). rules patch-merges by id (omitted fields keep stored values; check: null clears). A site's first brief write must include head.purpose (5–280 characters).

A locked rule can only be changed, removed, locked or unlocked by a person in the dashboard: any other caller gets 403 rule_locked or lock_is_for_people. The X-Dotsy-Brief-Actor header is ignored.

With ?page=<content key> the same call edits that page's brief instead (head, body, goal, notes). The page must exist.

put/api/v1/sites/{slug}/brief

Request

  • Base URL: https://api.dotsy.ai
  • URL: https://api.dotsy.ai/api/v1/sites/{slug}/brief
  • Auth: one of:
    • HTTP bearer
    • HTTP bearer

Path parameters

slugstring required
Example:acme-studio

Site slug or site id (UUID). An old slug answers 301/308 and a site id 307 to the canonical slug path.

Query parameters

pagestring

A page's content key (for example pricing.html). Reads or writes that page's brief instead of the site brief. Must be a normal content key: not empty, not reserved, no .., no leading or trailing /.

Request body

OR

Response

Saved. The merged brief.

OR

Changes

No recorded changes to this operation across all 1 revision of this API.