This document is generated by Apidog. Apidog: All-in-one workspace for API design, document, debug, test, mock

Hold envelope

POST

https://api.signater.com/v1/ecm/envelopes/{envelopeId}/hold

Envelope

Last modified:2025-03-29 12:47:42

Holds an existing envelope using its unique identifier, changing its status to 'hold'. Once holded, all signers will be prevented from approving or rejecting the envelope. This action effectively pauses the envelope's approval process, and it can be published at a later time if needed.

Request

Authorization

Add parameter in header

x-api-token

Example:

x-api-token: ********************

Path Params

envelopeId

string <uuid>

required

Envelope ID

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Responses

🟢204No Content

Envelope held successfully

This response does not have a body.

🟠400Bad Request

🟠401Unauthorized

🟠403Forbidden

🟠404Record Not Found

Modified at 2025-03-29 12:47:42

Unschedule envelope publication

Cancel envelope