EaserixDocs
DevelopersAPI referenceSignRetention

Set the workspace retention policy

retentionDays omitted or null means keep forever. Once set, a terminal document (completed/declined/cancelled/expired) older than retentionDays past its terminal timestamp is flagged for purge and given graceDays before it is actually deleted.

View as Markdown
PUT
/v1/retention-policy

Authorization

bearer
AuthorizationBearer <token>

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

application/json

curl -X PUT "https://example.com/v1/retention-policy" \  -H "Content-Type: application/json" \  -d '{}'
{  "policy": {    "retentionDays": 0,    "graceDays": 0,    "updatedAt": "2019-08-24T14:15:22Z",    "updatedBy": "string"  }}

The caller's workspace retention policy

No policy configured yet reports the same "keep forever" default a fresh one would (retentionDays: null, graceDays: 14) — a workspace never has to opt in to get default behavior.

Per-recipient engagement detail for one document

First viewed, signed, time to sign, and who is currently blocking (sequential/parallel/group-aware, reusing the same turn-order logic the signing flow itself uses) — for one document. firstViewedAt is exactly that: the recipient's first open, since the platform never records a repeat view. timeToSignSeconds falls back to sentAt→signedAt when viewedAt is null (e.g. the owner signed this recipient in person), reported via timeToSignBasis ("fromView"|"fromSend") so the two are never silently mixed.