Skip to main content
PATCH
Update a signature request

Authorizations

Authorization
string
header
required

Cognito-issued JWT access token. Send it as Authorization: Bearer <token>.

Path Parameters

signatureRequestId
string
required

Body

application/json

Only the status field can be patched. Each value is an action, not a stored status: rejected rejects the request. wetInk marks it for wet-ink signing, removing it from e-signature. pending moves a request marked for wet-ink signing back to e-signature, as long as its signed scan has not been uploaded. wetInkUploaded confirms the signed scan was uploaded to the URL from GET /v2/requests/{signatureRequestId}/uploadUrl. What wetInk does next depends on your workflow. If QC comes before signing, it finishes the request immediately, and the mark is final. If QC comes after signing, the request waits for its signed scan to be uploaded. pending and wetInkUploaded are only allowed when QC comes after signing.

status
enum<string>
required

The action to apply to the signature request.

Available options:
rejected,
wetInk,
pending,
wetInkUploaded

Response

Signature request updated successfully.

Response for a patched signature request. It echoes the action that was applied.

id
string
required

Unique identifier for the signature request.

status
enum<string>
required

The action that was applied.

Available options:
rejected,
wetInk,
pending,
wetInkUploaded
rejected_on
string<date-time>

The timestamp when the signature request was rejected. Only set for rejected.

wetInkOn
string<date-time>

The timestamp when the signature request was marked for wet-ink signing. Set for wetInk and wetInkUploaded.

wetInkUploadedOn
string<date-time>

The timestamp when the signed wet-ink scan upload was confirmed. Only set for wetInkUploaded.