API Docs / Schemas / RequestClientApprovalForDocumentsRequest

RequestClientApprovalForDocumentsRequest

Sends one or more documents to a client for approval, either as a single batch decided
together or as a separate approval request per document.

Properties

Name Type Description
documentCodes*array of string

The codes of the documents to send for approval. Duplicates are ignored.

The codes of the documents to send for approval. Duplicates are ignored.

modeenum

Individual Batch

Individual Batch

recipientEmailsstring

Comma-separated email addresses of recipients to send the approval request to

Comma-separated email addresses of recipients to send the approval request to

chaseFrequencyDaysinteger

Override for the chase frequency in days. If not specified, the tenant default is used
for portal approvals; e-signature approvals default to no chasing (the signing platform
sends its own reminders) unless a value is given.

Override for the chase frequency in days. If not specified, the tenant default is used
for portal approvals; e-signature approvals default to no chasing (the signing platform
sends its own reminders) unless a value is given.

approvalMethodenum

Portal ESignature

Portal ESignature

scheduledAtstring

When set, approval is not requested now: no batch is created and the documents are left
untouched until a scheduled send dispatches the request at this UTC instant. Must be in
the future. Omit to request approval immediately.

When set, approval is not requested now: no batch is created and the documents are left
untouched until a scheduled send dispatches the request at this UTC instant. Must be in
the future. Omit to request approval immediately.

JSON Example

{
  "documentCodes": [
    "string"
  ],
  "mode": "Individual",
  "recipientEmails": "string",
  "chaseFrequencyDays": 0,
  "approvalMethod": "Portal"
}

Used By Operations

Contained in Schemas