Envelopes

Unarchive an envelope

Brings an archived envelope back into the default document list.

Unlike every other state-changing action here, this one has no state precondition: an envelope that was never archived is already where the caller asked for it, so any status answers success and archivedAt comes back null. The only failure is an envelope this workspace does not own, which answers 404 exactly as an unknown id does.

No request body. Honors Idempotency-Key.

post/envelopes/{envelopeId}/unarchive

Request

  • Base URL: https://inkseal.net/api/v1
  • URL: https://inkseal.net/api/v1/envelopes/{envelopeId}/unarchive
  • Auth: HTTP bearer

Headers

Idempotency-Keystring

Makes this mutation retry-safe. 1 to 255 printable ASCII characters (0x20 to 0x7e), trimmed before use. The key is scoped to the workspace and the credential that sent it. Reusing it with a different method, path, or payload answers 422 idempotency_key_reuse. A completed attempt replays its stored status and body with an Idempotent-Replay: true response header; 5xx, 429, and non-JSON answers leave the key retryable. A concurrent request holding the 90 second lease answers 409 idempotency_in_progress. Records are retained 24 hours.

Response

The envelope is back in the default list; archivedAt is null.

Example response

{
  "data": {
    "id": "Jd3kR8sVqW2nX5cY7bLmP",
    "status": "pending",
    "archivedAt": "2026-08-25T14:00:00.000Z"
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.