Models

Company Notification Email Address

Properties

NameTypeRequiredDescription
idstringYesThe ID of the notification email address record. Use it with the get, update and delete notification email address endpoints. Example: "cnea_01JQZ8X0M4T7RB6K9V2NDHW3PA"
companyIdstringYesThe ID of the company these notifications are sent for. Example: "c_01JQZ8X0M4T7RB6K9V2NDHW3PA"
emailstringYesThe address the notifications are sent to. Example: "billing@example.com"
notifyIncomingbooleanYesWhether this address is notified when the company receives a document. Example: true
notifyOutgoingbooleanYesWhether this address is notified when the company sends a document. Example: false
includeAutoGeneratedPdfIncomingbooleanYesWhether the notification for an incoming document carries a PDF rendering of it as an attachment. Example: true
includeAutoGeneratedPdfOutgoingbooleanYesWhether the notification for an outgoing document carries a PDF rendering of it as an attachment. Example: false
includeDocumentJsonIncomingbooleanYesWhether the notification for an incoming document carries the document's JSON representation as an attachment. Example: false
includeDocumentJsonOutgoingbooleanYesWhether the notification for an outgoing document carries the document's JSON representation as an attachment. Example: false
createdAtstring (date-time)YesWhen the address was added to the company. Format: date-time
updatedAtstring (date-time)YesWhen the address was last changed. Format: date-time

Used by

On this page