KOkobaltlabs
marketing-guidelines

Get Requirement History

Changed on

Every version of this requirement, newest first.

get/marketing/guidelines/requirements/{requirement_id}/history

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/guidelines/requirements/{requirement_id}/history
  • Auth
    none declared

Path parameters

requirement_idstring uuid required

Response

Successful Response

revision_idstring uuid required
revision_numberinteger required
state'active' | 'disabled' | 'archived' | 'superseded' | 'proposed' required

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

All of them are recorded as revisions, so every one 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
trigger_termsstring[] required
change_kind'extracted' | 'edited' | 'disabled' | 'enabled' | 'archived' | 'restored' | 'superseded' | 'proposed' | 'approved' 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
createdstring date-time required
created_by_emailstring nullable required
superseded_atstring date-time nullable required

Changes

  • 425d5b8a3c17Revision changes
    • warning

      added the new approved enum value to the / response property for the response status

    • warning

      added the new proposed enum value to the / response property for the response status

    • warning

      added the new proposed enum value to the / response property for the response status