Models
Company Notification Email Address
Properties
| Name | Type | Required | Description |
|---|---|---|---|
id | string | Yes | The ID of the notification email address record. Use it with the get, update and delete notification email address endpoints. Example: "cnea_01JQZ8X0M4T7RB6K9V2NDHW3PA" |
companyId | string | Yes | The ID of the company these notifications are sent for. Example: "c_01JQZ8X0M4T7RB6K9V2NDHW3PA" |
email | string | Yes | The address the notifications are sent to. Example: "billing@example.com" |
notifyIncoming | boolean | Yes | Whether this address is notified when the company receives a document. Example: true |
notifyOutgoing | boolean | Yes | Whether this address is notified when the company sends a document. Example: false |
includeAutoGeneratedPdfIncoming | boolean | Yes | Whether the notification for an incoming document carries a PDF rendering of it as an attachment. Example: true |
includeAutoGeneratedPdfOutgoing | boolean | Yes | Whether the notification for an outgoing document carries a PDF rendering of it as an attachment. Example: false |
includeDocumentJsonIncoming | boolean | Yes | Whether the notification for an incoming document carries the document's JSON representation as an attachment. Example: false |
includeDocumentJsonOutgoing | boolean | Yes | Whether the notification for an outgoing document carries the document's JSON representation as an attachment. Example: false |
createdAt | string (date-time) | Yes | When the address was added to the company. Format: date-time |
updatedAt | string (date-time) | Yes | When the address was last changed. Format: date-time |