Skip to content

ProcessRetentionLeaseRequest

PUT /processes/{processType}/{processId}/retention-lease: retain a run.

Kind: an object, used in requests.

FieldTypeRequiredDescription
notestring | nullOptional: 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.
{
"note": "..."
}
  • runs.retain (PUT /processes/{processType}/{processId}/retention-lease)