API Docs / Schemas / OpenDocumentRequestRequest

OpenDocumentRequestRequest

Request DTO for opening (sending to client) a document request.
Requires at least one recipient email address.

Properties

Name Type Description
recipientEmailsstring

Comma-separated email addresses to send the document request to.
At least one is required.

Comma-separated email addresses to send the document request to.
At least one is required.

chaseFrequencyDaysinteger

Override for the chase frequency in days. If not specified, the tenant default is used.

Override for the chase frequency in days. If not specified, the tenant default is used.

scheduledAtstring

When set, the request is not opened now: it stays Draft and a scheduled send opens it at
this UTC instant. Must be in the future. Omit to open and send immediately.

When set, the request is not opened now: it stays Draft and a scheduled send opens it at
this UTC instant. Must be in the future. Omit to open and send immediately.

JSON Example

{
  "recipientEmails": "string",
  "chaseFrequencyDays": 0,
  "scheduledAt": "2024-01-01T00:00:00Z"
}

Used By Operations

Contained in Schemas