API Docs / Schemas / NotifyClientDocumentsRequest

NotifyClientDocumentsRequest

Sends the specified recipients one email covering one or more documents, each with its own
secure link to view it in the portal.

Properties

Name Type Description
documentCodes*array of string

The codes of the documents to notify the client about. Duplicates are ignored.

The codes of the documents to notify the client about. Duplicates are ignored.

recipientEmailsstring

Comma-separated email addresses of recipients to send the notification to

Comma-separated email addresses of recipients to send the notification to

messagestring

Optional personal message included in the notification email via the
{{ Message }} template token. May contain HTML and template tokens.

Optional personal message included in the notification email via the
{{ Message }} template token. May contain HTML and template tokens.

includeAttachmentboolean

Whether to attach the document files to the notification email in addition to the view
links. Limited to 15MB across all attachments.

Whether to attach the document files to the notification email in addition to the view
links. Limited to 15MB across all attachments.

JSON Example

{
  "documentCodes": [
    "string"
  ],
  "recipientEmails": "string",
  "message": "string",
  "includeAttachment": false
}

Used By Operations