ProcessRetentionLeaseRequest
PUT /processes/{processType}/{processId}/retention-lease: retain a run.
Kind: an object, used in requests.
Fields
Section titled “Fields”| Field | Type | Required | Description |
|---|---|---|---|
note | string | null | Optional: why the run is being retained (shown with the lease). Trimmed; empty is the same as none. Ignored when the run already has its own lease — a retain never rewrites an existing lease. |
Example
Section titled “Example”{ "note": "..."}Where it’s used
Section titled “Where it’s used”runs.retain(PUT /processes/{processType}/{processId}/retention-lease)