Update a requirement definition

Partially updates a requirement definition. Only the fields provided in the request body are modified (JSON Merge Patch).

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

Unique identifier of the RequirementDefinition (template)

Body Params

Partial update to a requirement definition (JSON Merge Patch). Only the provided fields are modified.

string
string
string

Repoint this definition at a different backing data-source template. A material change: it publishes a new version under transition. Rejected with 422 for a type that has no data source, and 404 for a template the calling account does not own. Omit to leave unchanged; resending the current value is a no-op.

boolean

Whether a payer or payee may manually renew instances of this definition. A material change: it publishes a new version under transition.

boolean
deprecated

Deprecated legacy write field. The V3 gateway rejects this field.

integer

Changes the day count while retaining an omitted stored strategy. DaysAfterComplete requires at least 30 days. If no stored strategy exists, a supplied day count defaults to DaysAfterComplete.

string
enum

How the expiration date is derived. An omitted strategy retains the stored value. A strategy other than None requires a day count, either supplied in this update or retained from the definition.

Allowed:
string

Author note recorded with the version this update creates (when the update is material). Surfaced on the definition and in versionHistory.

boolean
deprecated

Deprecated legacy write field. The V3 gateway rejects this field.

boolean
deprecated

Deprecated legacy write field. The V3 gateway rejects this field.

string
enum
Defaults to NeverRequired

Controls whether terminal-success from a backing Action completes the instance directly or parks it for payer review. NeverRequired completes directly; AlwaysRequired parks at PendingPayerReview with blockedReason: AwaitingPayerReview; OnFail parks only when the backing resource reaches a terminal-success state that still needs payer adjudication because the validation result is inconclusive or failed.

Allowed:
source
object
deprecated

Deprecated legacy write field. The V3 gateway rejects this field.

passingValues
array of strings
deprecated

Deprecated legacy write field. The V3 gateway rejects this field.

passingValues
policy
object
deprecated

Deprecated legacy write field. The V3 gateway rejects this field.

metadata
object

Free-form key-value pairs. Max 50 keys; key length at most 40 characters; value length at most 500 characters. Where a list endpoint declares metadata filtering, it uses the QueryQL namespace via filter[metadata.{key}][eq]=value or filter[metadata.{key}][in][]=value. Endpoints that do not declare the dynamic Metadata filter do not support Metadata filtering.

transition
object

Rollout instruction for a material template update. Defaults to the safest behavior: only new instances pick up the new definition and the change waits until renewal. The server decides whether an update is material; immaterial updates do not increment version or reopen existing instances.

Headers
string
length between 1 and 255
^[\x21-\x7e]{1,255}$

Optional idempotency token for authenticated POST and PATCH requests. Reusing the same key and body returns the cached response for 24 hours, except credential operations that explicitly document a 409 because one-time secret material is never cached; reusing it with a different body returns 409 IdempotencyKeyConflict. Use 1-255 printable ASCII characters.

string
^(?:[A-Za-z0-9_.]{22}|[a-f0-9]{24})$

Select the Account for an Account-scoped operation. A direct ServiceAccount API key MUST supply this header, and the target must be within the ServiceAccount owner's or Authorization grant's Account boundary. A Person bearer may select an Account on which it has an active Stakeholder, and an Account session may select its bound Account (or a descendant only when the session explicitly includes descendants).

string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

Language
Credentials
Bearer
JWT
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json
application/problem+json