marketing-guideline-sets

Add Guideline Set Document

Changed on

Put one document into the set, leaving the rest of its membership alone.

A pair with the DELETE below, and neither is PUT /{id}. That route replaces the whole set — name, description, guidance, documents and live pages — which is right for the form where somebody is composing the lot by hand and wrong for a chip somebody clicked: a one-click remove that resent the whole set would overwrite whatever another tab had changed since the page loaded, and would delete and re-insert every website row to no purpose. _add_members already exists for exactly this reason on the reading path.

Idempotent. A document already in the set keeps the role it has, for the reason _add_members gives: a collision here is a race with another edit, and the first edit's answer is the safer one to keep.

post/marketing/guideline-sets/{guideline_set_id}/documents

Request

  • Base URL
    https://api.kobaltlabs.com (the document declares no server; this is the origin it was published from)
  • URL
    https://api.kobaltlabs.com/marketing/guideline-sets/{guideline_set_id}/documents
  • Auth
    none declared

Path parameters

guideline_set_idstring uuid required

Request body

file_idstring uuid required
role'primary' | 'supporting' required

What one document contributes to a guideline set.

PRIMARY documents are read for obligations: every requirement traces to exactly one of them, and MarketingGuidelineRequirement.file_id names it. SUPPORTING documents — a brand book, a glossary, a claims-substantiation memo — are read for context and produce no requirement of their own.

The distinction is not presentational. It decides which documents a product line drags into gather_candidates, so filing a glossary as primary is how a definitions list becomes a hundred obligations nobody wrote, and filing a standards document as supporting is how its rules quietly stop being checked.

Response

Successful Response

guideline_set_idstring uuid required
namestring required
descriptionstring nullable required
extraction_guidancestring nullable
preset_idsstring[] required
active_requirement_countinteger required
total_requirement_countinteger required
proposed_requirement_countinteger

Changes