POST /v1/consumers/{consumer_ref}/requirement-sets/{version}/publish
Publish with applies_to, grace_period_days, effective_on.
PARAMETERS
NAME
TYPE
REQUIRED
DESCRIPTION
consumer_ref
string
yes
version
string
yes
Idempotency-Key
string
no
Optional, and the preferred way to make a retry safe. Send one on every POST and PUT; a replay returns the original response with idempotent_replay true and creates nothing new. POST /documents also accepts an idempotency_key form field as an alias; the header wins when both are sent
applies_to
enum
yes
new (engagements opened from now on) or all_active (every active engagement for the consumer) One of: new, all_active.
grace_period_days
integer
no
effective_on
string
no
RESPONSE
FIELD
TYPE
DESCRIPTION
consumer_ref
string
key
string
The requirement set (lineage) this version belongs to. Default default. At most one version per key may be published at a time
version
integer
status
enum
draft, published, superseded.
applies_to
enum
new (engagements opened from now on) or all_active (every active engagement for the consumer) One of: new, all_active.
effective_on
string
reverification_cadence
enum
Set-level default; overridable per rule (Rule.reverification_cadence) and per engagement
expiry_lead_days
integer
Set-level default; overridable per rule (Rule.expiry_lead_days) and per engagement
review_states
string[]
4.5.1: an alternative satisfied by occupational accident for an insured in one of these states still passes, flagged state_review_required
rules
object[]
Compiled rules, included when fetching one version
Errors: 400, 401, 403, 404, 409, 422, 429, 500. Every error body carries error.code, error.message, and error.request_id.