Sign in
marketing-guidelines

Update Requirement

Change a requirement's wording, guidance or scope by recording a new revision.

Nothing already written is altered. The previous wording stays readable in the history.

patch/marketing/guidelines/requirements/{requirement_id}

Path parameters

requirement_idstring uuid required

Request body

base_revision_numberinteger nullable
requirement_textstring nullable
judging_guidancestring nullable
collateral_typesMarketingCollateralType[] nullable
marketing_team_idsstring[] nullable
trigger_termsstring[] nullable
change_notestring nullable

Response

Successful Response

requirement_idstring uuid required
file_idstring uuid required
filenamestring nullable required
decomposition_idstring uuid required
ordinalinteger required
revision_numberinteger required
state'active' | 'disabled' | 'archived' | 'superseded' required

Whether a requirement is in the working library, and if not, why not.

All four are recorded as revisions, so every one of them is reversible and readable.

ARCHIVED and SUPERSEDED are deliberately distinct: ARCHIVED is a person deciding this obligation does not apply to them, SUPERSEDED is a newer decomposition of the same guideline taking over. A regeneration must never overwrite the first with the second — that would erase a human decision.

requirement_textstring required
judging_guidancestring nullable required
collateral_typesMarketingCollateralType[] nullable required
marketing_team_idsstring[] nullable required
source_collateral_termsstring[] nullable required
trigger_termsstring[] required
unresolved_collateral_termsstring[] required
section_labelstring nullable required
titlestring nullable required
source_pageinteger nullable required
change_kind'extracted' | 'edited' | 'disabled' | 'enabled' | 'archived' | 'restored' | 'superseded' required

What a revision was for.

Redundant with comparing a revision to its predecessor, and that is the point: the reason a change was made is the part a diff cannot recover.

change_notestring nullable required
updated_atstring date-time required
updated_by_emailstring nullable required
has_human_editsboolean required
downvotesinteger nullable

Changes

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