Sign in

v1

latestOpenAPI 3.0.0proprietary2026-07-261695971.5 MB
Signer Document Request

Update a Signer Document Request

Updates a given Signer Document Request. Any parameters not provided are left unchanged. This action is only permitted when the Signature Request is a draft or paused.

patch/signature_requests/{signatureRequestId}/document_requests/{documentRequestId}

Path parameters

signatureRequestIdstring uuid required

The unique identifier for a resource.

Example:9a93d3b5-fb3b-4abf-9e70-26315b33506c

Signature Request Id

documentRequestIdstring uuid required

The unique identifier for a resource.

Example:9a93d3b5-fb3b-4abf-9e70-26315b33506c

Signer Document Request Id

Request body

titlestring

Title of the Signer Document Request.

optionalboolean

Define if the document request is optional for the Signers

Example request

{
  "title": "Proof of address"
}

Response

OK

idstring uuid required

Unique identifier of the Signer Document Request

titlestring required

Title of the document request

optionalboolean required

Define if the document request is optional for the Signers

signer_idsstring[] required

Ids of Signers to request a document

Example response

{
  "id": "69df8404-40d3-4686-887b-5678f46a0d9a",
  "title": "Proof of address",
  "signer_ids": [
    "2fd4a3fb-a886-4c9d-ac49-ea6f759c0c64"
  ]
}