Download OpenAPI specification:
Automatically generated swagger spec for the message stack.
Adds email addresses to the confidential email list for the given account.
| accountId required | string <int64> |
| emails required | Array of strings |
{- "accountId": "string",
- "emails": [
- "string"
]
}{ }Sends multiple mails in one request using the provided entries (owner, participants, subject, body, attachments, and optional reply/confidential settings). Returns the sent mails.
required | Array of objects (v2BulkSendMailEntry) |
{- "entries": [
- {
- "attachmentMediaIds": [
- "string"
], - "bcc": [
- {
- "email": "string",
- "name": "string"
}
], - "bodyHtml": "string",
- "bodyText": "string",
- "cc": [
- {
- "email": "string",
- "name": "string"
}
], - "confidential": true,
- "from": {
- "email": "string",
- "name": "string"
}, - "ownerId": "string",
- "referenceIds": [
- "string"
], - "replyToMailId": "string",
- "subject": "string",
- "to": [
- {
- "email": "string",
- "name": "string"
}
]
}
]
}{- "mail": [
- {
- "archived": true,
- "attachmentMediaIds": [
- "string"
], - "bcc": [
- {
- "email": "string",
- "name": "string"
}
], - "bodyHtml": "string",
- "bodyText": "string",
- "cc": [
- {
- "email": "string",
- "name": "string"
}
], - "cidMappings": [
- {
- "cid": "string",
- "mediaId": "string"
}
], - "confidential": true,
- "deliverData": {
- "changedAt": "string",
- "errorMessage": "string",
- "status": "DELIVER_STATUS_UNDEFINED"
}, - "engagementData": {
- "changedAt": "string",
- "status": "ENGAGEMENT_STATUS_UNDEFINED"
}, - "from": {
- "email": "string",
- "name": "string"
}, - "hasForwarding": true,
- "hasReply": true,
- "id": "string",
- "inTrash": true,
- "inbound": true,
- "mailType": "MAIL_TYPE_NORMAL",
- "mailboxId": "string",
- "maliciousAttachmentsMissing": true,
- "missingHtml": true,
- "ownerId": "string",
- "readEntries": [
- {
- "accountId": "string",
- "timestamp": "string"
}
], - "referenceIds": [
- "string"
], - "replyTo": "string",
- "sentByPlatform": true,
- "spam": true,
- "subject": "string",
- "timestamp": "string",
- "to": [
- {
- "email": "string",
- "name": "string"
}
]
}
]
}Creates a new mail domain for the given owner. Returns the created domain including its validation key.
| domain required | string |
| ownerId required | string <int64> |
{- "domain": "string",
- "ownerId": "string"
}{- "domain": {
- "domain": "string",
- "id": "string",
- "isValid": true,
- "ownerId": "string",
- "validationKey": "string"
}
}Creates a new mailbox for the given owner. Accepts mailbox type, outbound email, name, optional main and allowed user IDs, and an optional signature ID. Returns the created mailbox.
| allowedUserIds required | Array of strings |
| mailboxType required | string (v2MailboxType) Default: "MAILBOX_TYPE_SPF" Enum: "MAILBOX_TYPE_SPF" "MAILBOX_TYPE_NYLAS" "MAILBOX_TYPE_NYLAS_MANUAL" |
| mainUserId required | string (Can be empty if no specific user is using this mailbox) |
| name required | string |
| outboundEmail required | string |
| ownerId required | string <int64> |
| signatureId required | string |
{- "allowedUserIds": [
- "string"
], - "mailboxType": "MAILBOX_TYPE_SPF",
- "mainUserId": "string",
- "name": "string",
- "outboundEmail": "string",
- "ownerId": "string",
- "signatureId": "string"
}{- "mailbox": {
- "active": true,
- "allowedUserIds": [
- "string"
], - "automaticReply": {
- "bodyHtml": "string",
- "bodyText": "string",
- "enabled": true,
- "endDate": {
- "day": 0,
- "month": 0,
- "year": 0
}, - "endTime": {
- "hours": 0,
- "minutes": 0,
- "nanos": 0,
- "seconds": 0
}, - "startDate": {
- "day": 0,
- "month": 0,
- "year": 0
}, - "startTime": {
- "hours": 0,
- "minutes": 0,
- "nanos": 0,
- "seconds": 0
}, - "subject": "string"
}, - "confidential": true,
- "documentRecognition": {
- "enabled": true
}, - "id": "string",
- "inboundEmail": "string",
- "mailboxType": "MAILBOX_TYPE_SPF",
- "mainUserId": "string",
- "name": "string",
- "outboundEmail": "string",
- "ownerId": "string",
- "signatureId": "string"
}
}Updates an existing mailbox by ID, including outbound email, name, main and allowed user IDs, and signature ID.
| id required | string |
| allowedUserIds | Array of strings |
| mainUserId | string (Can be empty if no specific user is using this mailbox) |
| name | string |
| outboundEmail | string |
| signatureId | string |
{- "allowedUserIds": [
- "string"
], - "mainUserId": "string",
- "name": "string",
- "outboundEmail": "string",
- "signatureId": "string"
}{ }Forwards an existing mail identified by forwardingMailId to the given recipients. Accepts owner, participants, subject, body, attachments, and a confidential flag. Returns the forwarded mail.
| attachmentMediaIds required | Array of strings |
required | Array of objects (mailv2Participant) |
| bodyHtml required | string |
| bodyText required | string |
required | Array of objects (mailv2Participant) |
| confidential required | boolean |
| forwardingMailId required | string |
required | object (mailv2Participant) |
| ownerId required | string <int64> |
| referenceIds required | Array of strings |
| subject required | string |
required | Array of objects (mailv2Participant) |
{- "attachmentMediaIds": [
- "string"
], - "bcc": [
- {
- "email": "string",
- "name": "string"
}
], - "bodyHtml": "string",
- "bodyText": "string",
- "cc": [
- {
- "email": "string",
- "name": "string"
}
], - "confidential": true,
- "forwardingMailId": "string",
- "from": {
- "email": "string",
- "name": "string"
}, - "ownerId": "string",
- "referenceIds": [
- "string"
], - "subject": "string",
- "to": [
- {
- "email": "string",
- "name": "string"
}
]
}{- "mail": {
- "archived": true,
- "attachmentMediaIds": [
- "string"
], - "bcc": [
- {
- "email": "string",
- "name": "string"
}
], - "bodyHtml": "string",
- "bodyText": "string",
- "cc": [
- {
- "email": "string",
- "name": "string"
}
], - "cidMappings": [
- {
- "cid": "string",
- "mediaId": "string"
}
], - "confidential": true,
- "deliverData": {
- "changedAt": "string",
- "errorMessage": "string",
- "status": "DELIVER_STATUS_UNDEFINED"
}, - "engagementData": {
- "changedAt": "string",
- "status": "ENGAGEMENT_STATUS_UNDEFINED"
}, - "from": {
- "email": "string",
- "name": "string"
}, - "hasForwarding": true,
- "hasReply": true,
- "id": "string",
- "inTrash": true,
- "inbound": true,
- "mailType": "MAIL_TYPE_NORMAL",
- "mailboxId": "string",
- "maliciousAttachmentsMissing": true,
- "missingHtml": true,
- "ownerId": "string",
- "readEntries": [
- {
- "accountId": "string",
- "timestamp": "string"
}
], - "referenceIds": [
- "string"
], - "replyTo": "string",
- "sentByPlatform": true,
- "spam": true,
- "subject": "string",
- "timestamp": "string",
- "to": [
- {
- "email": "string",
- "name": "string"
}
]
}
}Returns delivery and engagement data for mails matching the given reference IDs, including participants, deliverability status, engagement status, and timestamps.
| referenceIds required | Array of strings |
{- "referenceIds": [
- "string"
]
}{- "entries": [
- {
- "bcc": [
- {
- "email": "string",
- "name": "string"
}
], - "cc": [
- {
- "email": "string",
- "name": "string"
}
], - "deliverData": {
- "changedAt": "string",
- "errorMessage": "string",
- "status": "DELIVER_STATUS_UNDEFINED"
}, - "engagementData": {
- "changedAt": "string",
- "status": "ENGAGEMENT_STATUS_UNDEFINED"
}, - "from": {
- "email": "string",
- "name": "string"
}, - "id": "string",
- "referenceId": [
- "string"
], - "timestamp": "string",
- "to": [
- {
- "email": "string",
- "name": "string"
}
]
}
]
}Returns the mailbox identified by the given ID.
| id required | string |
{- "mailbox": {
- "active": true,
- "allowedUserIds": [
- "string"
], - "automaticReply": {
- "bodyHtml": "string",
- "bodyText": "string",
- "enabled": true,
- "endDate": {
- "day": 0,
- "month": 0,
- "year": 0
}, - "endTime": {
- "hours": 0,
- "minutes": 0,
- "nanos": 0,
- "seconds": 0
}, - "startDate": {
- "day": 0,
- "month": 0,
- "year": 0
}, - "startTime": {
- "hours": 0,
- "minutes": 0,
- "nanos": 0,
- "seconds": 0
}, - "subject": "string"
}, - "confidential": true,
- "documentRecognition": {
- "enabled": true
}, - "id": "string",
- "inboundEmail": "string",
- "mailboxType": "MAILBOX_TYPE_SPF",
- "mainUserId": "string",
- "name": "string",
- "outboundEmail": "string",
- "ownerId": "string",
- "signatureId": "string"
}
}Returns all mail domains belonging to the given owner.
| ownerId required | string <int64> |
{- "domains": [
- {
- "domain": "string",
- "id": "string",
- "isValid": true,
- "ownerId": "string",
- "validationKey": "string"
}
]
}Returns all mail drafts for the authenticated caller. The request has no parameters.
{- "drafts": [
- {
- "attachmentMediaIds": [
- "string"
], - "bcc": [
- {
- "email": "string",
- "name": "string"
}
], - "bodyHtml": "string",
- "bodyText": "string",
- "cc": [
- {
- "email": "string",
- "name": "string"
}
], - "forwardingMailId": "string",
- "id": "string",
- "mailboxId": "string",
- "ownerId": "string",
- "referenceIds": [
- "string"
], - "replyToMailId": "string",
- "subject": "string",
- "timestamp": "string",
- "to": [
- {
- "email": "string",
- "name": "string"
}
], - "userId": "string"
}
]
}Returns the latest mail for each of the given reference IDs.
| referenceIds required | Array of strings |
{- "referenceIds": [
- "string"
]
}{- "mails": [
- {
- "archived": true,
- "attachmentMediaIds": [
- "string"
], - "bcc": [
- {
- "email": "string",
- "name": "string"
}
], - "bodyHtml": "string",
- "bodyText": "string",
- "cc": [
- {
- "email": "string",
- "name": "string"
}
], - "cidMappings": [
- {
- "cid": "string",
- "mediaId": "string"
}
], - "confidential": true,
- "deliverData": {
- "changedAt": "string",
- "errorMessage": "string",
- "status": "DELIVER_STATUS_UNDEFINED"
}, - "engagementData": {
- "changedAt": "string",
- "status": "ENGAGEMENT_STATUS_UNDEFINED"
}, - "from": {
- "email": "string",
- "name": "string"
}, - "hasForwarding": true,
- "hasReply": true,
- "id": "string",
- "inTrash": true,
- "inbound": true,
- "mailType": "MAIL_TYPE_NORMAL",
- "mailboxId": "string",
- "maliciousAttachmentsMissing": true,
- "missingHtml": true,
- "ownerId": "string",
- "readEntries": [
- {
- "accountId": "string",
- "timestamp": "string"
}
], - "referenceIds": [
- "string"
], - "replyTo": "string",
- "sentByPlatform": true,
- "spam": true,
- "subject": "string",
- "timestamp": "string",
- "to": [
- {
- "email": "string",
- "name": "string"
}
]
}
]
}Returns mail IDs for the given mailbox IDs. Supports query text, unread and folder filters, reference-ID prefix exclusions, and sorting by received time.
| filterFolder required | string (v2FilterFolder) Default: "FILTER_FOLDER_ALL" Enum: "FILTER_FOLDER_ALL" "FILTER_FOLDER_INBOUND" "FILTER_FOLDER_OUTBOUND" "FILTER_FOLDER_ARCHIVED" "FILTER_FOLDER_TRASH" "FILTER_FOLDER_SPAM" |
| filterReferenceIdPrefixes required | Array of strings All mails with provided entity prefixes in referenceIds are excluded from results |
| filterUnread required | string (applicableApplicable) Default: "UNDEFINED_VALUE" Enum: "UNDEFINED_VALUE" "APPLIES" "DOES_NOT_APPLY" |
| mailboxIds required | Array of strings |
| query required | string |
| sortReceivedAt required | string (sortSortOrder) Default: "UNDEFINED_SORT_ORDER" Enum: "UNDEFINED_SORT_ORDER" "ASC" "DESC" |
{- "filterFolder": "FILTER_FOLDER_ALL",
- "filterReferenceIdPrefixes": [
- "string"
], - "filterUnread": "UNDEFINED_VALUE",
- "mailboxIds": [
- "string"
], - "query": "string",
- "sortReceivedAt": "UNDEFINED_SORT_ORDER"
}{- "ids": [
- "string"
]
}Returns all mailboxes belonging to the given account ID.
| accountId required | string <int64> |
{- "mailboxes": [
- {
- "active": true,
- "allowedUserIds": [
- "string"
], - "automaticReply": {
- "bodyHtml": "string",
- "bodyText": "string",
- "enabled": true,
- "endDate": {
- "day": 0,
- "month": 0,
- "year": 0
}, - "endTime": {
- "hours": 0,
- "minutes": 0,
- "nanos": 0,
- "seconds": 0
}, - "startDate": {
- "day": 0,
- "month": 0,
- "year": 0
}, - "startTime": {
- "hours": 0,
- "minutes": 0,
- "nanos": 0,
- "seconds": 0
}, - "subject": "string"
}, - "confidential": true,
- "documentRecognition": {
- "enabled": true
}, - "id": "string",
- "inboundEmail": "string",
- "mailboxType": "MAILBOX_TYPE_SPF",
- "mainUserId": "string",
- "name": "string",
- "outboundEmail": "string",
- "ownerId": "string",
- "signatureId": "string"
}
]
}Returns all mailboxes accessible to the given user ID.
| userId required | string |
{- "mailboxes": [
- {
- "active": true,
- "allowedUserIds": [
- "string"
], - "automaticReply": {
- "bodyHtml": "string",
- "bodyText": "string",
- "enabled": true,
- "endDate": {
- "day": 0,
- "month": 0,
- "year": 0
}, - "endTime": {
- "hours": 0,
- "minutes": 0,
- "nanos": 0,
- "seconds": 0
}, - "startDate": {
- "day": 0,
- "month": 0,
- "year": 0
}, - "startTime": {
- "hours": 0,
- "minutes": 0,
- "nanos": 0,
- "seconds": 0
}, - "subject": "string"
}, - "confidential": true,
- "documentRecognition": {
- "enabled": true
}, - "id": "string",
- "inboundEmail": "string",
- "mailboxType": "MAILBOX_TYPE_SPF",
- "mainUserId": "string",
- "name": "string",
- "outboundEmail": "string",
- "ownerId": "string",
- "signatureId": "string"
}
]
}Returns a paginated list of mails for the given mailbox IDs. Supports query text, unread and folder filters, reference-ID prefix exclusions, and sorting by received time. Optional limitPagination can cap exact counts for performance. Response includes total and page counts.
| filterFolder required | string (v2FilterFolder) Default: "FILTER_FOLDER_ALL" Enum: "FILTER_FOLDER_ALL" "FILTER_FOLDER_INBOUND" "FILTER_FOLDER_OUTBOUND" "FILTER_FOLDER_ARCHIVED" "FILTER_FOLDER_TRASH" "FILTER_FOLDER_SPAM" |
| filterReferenceIdPrefixes required | Array of strings (All mails with provided entity prefixes in referenceIds are excluded from results) All mails with provided entity prefixes in referenceIds are excluded from results |
| filterUnread required | string (applicableApplicable) Default: "UNDEFINED_VALUE" Enum: "UNDEFINED_VALUE" "APPLIES" "DOES_NOT_APPLY" |
| itemsPerPage required | integer <int32> |
| limitPagination required | boolean If set to true, the response will only contain exact count until 100 mails. Page count won't be accurate after that. This flag can be used for performance reasons. |
| mailboxIds required | Array of strings |
| page required | integer <int32> |
| query required | string |
| sortFromEmail required | string (sortSortOrder) Default: "UNDEFINED_SORT_ORDER" Enum: "UNDEFINED_SORT_ORDER" "ASC" "DESC" |
| sortReceivedAt required | string (sortSortOrder) Default: "UNDEFINED_SORT_ORDER" Enum: "UNDEFINED_SORT_ORDER" "ASC" "DESC" |
{- "filterFolder": "FILTER_FOLDER_ALL",
- "filterReferenceIdPrefixes": [
- "string"
], - "filterUnread": "UNDEFINED_VALUE",
- "itemsPerPage": 0,
- "limitPagination": true,
- "mailboxIds": [
- "string"
], - "page": 0,
- "query": "string",
- "sortFromEmail": "UNDEFINED_SORT_ORDER",
- "sortReceivedAt": "UNDEFINED_SORT_ORDER"
}{- "mails": [
- {
- "archived": true,
- "attachmentMediaIds": [
- "string"
], - "bcc": [
- {
- "email": "string",
- "name": "string"
}
], - "bodyHtml": "string",
- "bodyText": "string",
- "cc": [
- {
- "email": "string",
- "name": "string"
}
], - "cidMappings": [
- {
- "cid": "string",
- "mediaId": "string"
}
], - "confidential": true,
- "deliverData": {
- "changedAt": "string",
- "errorMessage": "string",
- "status": "DELIVER_STATUS_UNDEFINED"
}, - "engagementData": {
- "changedAt": "string",
- "status": "ENGAGEMENT_STATUS_UNDEFINED"
}, - "from": {
- "email": "string",
- "name": "string"
}, - "hasForwarding": true,
- "hasReply": true,
- "id": "string",
- "inTrash": true,
- "inbound": true,
- "mailType": "MAIL_TYPE_NORMAL",
- "mailboxId": "string",
- "maliciousAttachmentsMissing": true,
- "missingHtml": true,
- "ownerId": "string",
- "readEntries": [
- {
- "accountId": "string",
- "timestamp": "string"
}
], - "referenceIds": [
- "string"
], - "replyTo": "string",
- "sentByPlatform": true,
- "spam": true,
- "subject": "string",
- "timestamp": "string",
- "to": [
- {
- "email": "string",
- "name": "string"
}
]
}
], - "totalCount": 0,
- "totalPageCount": 0
}Returns the mails matching the given mail IDs.
| mailIds required | Array of strings |
{- "mailIds": [
- "string"
]
}{- "mails": [
- {
- "archived": true,
- "attachmentMediaIds": [
- "string"
], - "bcc": [
- {
- "email": "string",
- "name": "string"
}
], - "bodyHtml": "string",
- "bodyText": "string",
- "cc": [
- {
- "email": "string",
- "name": "string"
}
], - "cidMappings": [
- {
- "cid": "string",
- "mediaId": "string"
}
], - "confidential": true,
- "deliverData": {
- "changedAt": "string",
- "errorMessage": "string",
- "status": "DELIVER_STATUS_UNDEFINED"
}, - "engagementData": {
- "changedAt": "string",
- "status": "ENGAGEMENT_STATUS_UNDEFINED"
}, - "from": {
- "email": "string",
- "name": "string"
}, - "hasForwarding": true,
- "hasReply": true,
- "id": "string",
- "inTrash": true,
- "inbound": true,
- "mailType": "MAIL_TYPE_NORMAL",
- "mailboxId": "string",
- "maliciousAttachmentsMissing": true,
- "missingHtml": true,
- "ownerId": "string",
- "readEntries": [
- {
- "accountId": "string",
- "timestamp": "string"
}
], - "referenceIds": [
- "string"
], - "replyTo": "string",
- "sentByPlatform": true,
- "spam": true,
- "subject": "string",
- "timestamp": "string",
- "to": [
- {
- "email": "string",
- "name": "string"
}
]
}
]
}Returns a paginated list of mails linked to the given reference IDs. Supports query text, folder filter, and optional mailbox IDs when filtering inbound/outbound. Response includes total mail and page counts.
| emailAddresses | Array of strings Optional filter. At least one provided email address must be a participant (FROM, TO, CC or BCC) |
| filterFolder required | string (v2FilterFolder) Default: "FILTER_FOLDER_ALL" Enum: "FILTER_FOLDER_ALL" "FILTER_FOLDER_INBOUND" "FILTER_FOLDER_OUTBOUND" "FILTER_FOLDER_ARCHIVED" "FILTER_FOLDER_TRASH" "FILTER_FOLDER_SPAM" |
| itemsPerPage required | integer <int32> |
| mailboxIds | Array of strings Optional filter that only needs to be set if filter folder is inbound/outbound |
| page required | integer <int32> |
| query required | string |
| referenceIds required | Array of strings |
{- "emailAddresses": [
- "string"
], - "filterFolder": "FILTER_FOLDER_ALL",
- "itemsPerPage": 0,
- "mailboxIds": [
- "string"
], - "page": 0,
- "query": "string",
- "referenceIds": [
- "string"
]
}{- "mails": [
- {
- "archived": true,
- "attachmentMediaIds": [
- "string"
], - "bcc": [
- {
- "email": "string",
- "name": "string"
}
], - "bodyHtml": "string",
- "bodyText": "string",
- "cc": [
- {
- "email": "string",
- "name": "string"
}
], - "cidMappings": [
- {
- "cid": "string",
- "mediaId": "string"
}
], - "confidential": true,
- "deliverData": {
- "changedAt": "string",
- "errorMessage": "string",
- "status": "DELIVER_STATUS_UNDEFINED"
}, - "engagementData": {
- "changedAt": "string",
- "status": "ENGAGEMENT_STATUS_UNDEFINED"
}, - "from": {
- "email": "string",
- "name": "string"
}, - "hasForwarding": true,
- "hasReply": true,
- "id": "string",
- "inTrash": true,
- "inbound": true,
- "mailType": "MAIL_TYPE_NORMAL",
- "mailboxId": "string",
- "maliciousAttachmentsMissing": true,
- "missingHtml": true,
- "ownerId": "string",
- "readEntries": [
- {
- "accountId": "string",
- "timestamp": "string"
}
], - "referenceIds": [
- "string"
], - "replyTo": "string",
- "sentByPlatform": true,
- "spam": true,
- "subject": "string",
- "timestamp": "string",
- "to": [
- {
- "email": "string",
- "name": "string"
}
]
}
], - "totalMailsCount": 0,
- "totalPageCount": 0
}Removes the spam flag from the mails identified by the given IDs.
| ids required | Array of strings |
{- "ids": [
- "string"
]
}{ }Marks the given mails as read for the specified account.
| accountId required | string <int64> |
| ids required | Array of strings |
{- "accountId": "string",
- "ids": [
- "string"
]
}{ }Marks the given mails as unread for the specified account.
| accountId required | string <int64> |
| ids required | Array of strings |
{- "accountId": "string",
- "ids": [
- "string"
]
}{ }Removes the given email addresses from the confidential email list of the account.
| accountId required | string <int64> |
| emails required | Array of strings |
{- "accountId": "string",
- "emails": [
- "string"
]
}{ }Creates or updates a mail draft for the given mailbox. Optional id updates an existing draft; otherwise a new draft is created. Accepts participants, subject, body, attachments, and optional reply/forward mail IDs. Returns the saved draft.
| attachmentMediaIds required | Array of strings |
required | Array of objects (mailv2Participant) |
| bodyHtml required | string |
| bodyText required | string |
required | Array of objects (mailv2Participant) |
| forwardingMailId required | string |
| id | string Optional parameter to save new drafts and update existing ones |
| mailboxId required | string |
| referenceIds required | Array of strings |
| replyToMailId required | string |
| subject required | string |
| timestamp required | string <int64> (UNIX timestamp in seconds when draft was saved the last time) |
required | Array of objects (mailv2Participant) |
{- "attachmentMediaIds": [
- "string"
], - "bcc": [
- {
- "email": "string",
- "name": "string"
}
], - "bodyHtml": "string",
- "bodyText": "string",
- "cc": [
- {
- "email": "string",
- "name": "string"
}
], - "forwardingMailId": "string",
- "id": "string",
- "mailboxId": "string",
- "referenceIds": [
- "string"
], - "replyToMailId": "string",
- "subject": "string",
- "timestamp": "string",
- "to": [
- {
- "email": "string",
- "name": "string"
}
]
}{- "draft": {
- "attachmentMediaIds": [
- "string"
], - "bcc": [
- {
- "email": "string",
- "name": "string"
}
], - "bodyHtml": "string",
- "bodyText": "string",
- "cc": [
- {
- "email": "string",
- "name": "string"
}
], - "forwardingMailId": "string",
- "id": "string",
- "mailboxId": "string",
- "ownerId": "string",
- "referenceIds": [
- "string"
], - "replyToMailId": "string",
- "subject": "string",
- "timestamp": "string",
- "to": [
- {
- "email": "string",
- "name": "string"
}
], - "userId": "string"
}
}Sends a mail for the given owner with from/to/cc/bcc participants, subject, body, and optional attachments. Supports reply threading via replyToMailId, scheduled send via sendAt, and a confidential flag. Returns the sent mail.
| attachmentMediaIds required | Array of strings |
required | Array of objects (mailv2Participant) |
| bodyHtml required | string |
| bodyText required | string |
required | Array of objects (mailv2Participant) |
| confidential required | boolean |
required | object (mailv2Participant) |
| mailType | string (v2MailType) Default: "MAIL_TYPE_NORMAL" Enum: "MAIL_TYPE_NORMAL" "MAIL_TYPE_IMIP" "MAIL_TYPE_TICKET_NOTIFICATION" |
| ownerId required | string <int64> |
| referenceIds required | Array of strings |
| replyToMailId | string Optional: If set to id of mail the user replies to -> support for threaded mails |
| sendAt | string <int64> Optional: for scheduled mails |
| subject required | string |
required | Array of objects (mailv2Participant) |
{- "attachmentMediaIds": [
- "string"
], - "bcc": [
- {
- "email": "string",
- "name": "string"
}
], - "bodyHtml": "string",
- "bodyText": "string",
- "cc": [
- {
- "email": "string",
- "name": "string"
}
], - "confidential": true,
- "from": {
- "email": "string",
- "name": "string"
}, - "mailType": "MAIL_TYPE_NORMAL",
- "ownerId": "string",
- "referenceIds": [
- "string"
], - "replyToMailId": "string",
- "sendAt": "string",
- "subject": "string",
- "to": [
- {
- "email": "string",
- "name": "string"
}
]
}{- "mail": {
- "archived": true,
- "attachmentMediaIds": [
- "string"
], - "bcc": [
- {
- "email": "string",
- "name": "string"
}
], - "bodyHtml": "string",
- "bodyText": "string",
- "cc": [
- {
- "email": "string",
- "name": "string"
}
], - "cidMappings": [
- {
- "cid": "string",
- "mediaId": "string"
}
], - "confidential": true,
- "deliverData": {
- "changedAt": "string",
- "errorMessage": "string",
- "status": "DELIVER_STATUS_UNDEFINED"
}, - "engagementData": {
- "changedAt": "string",
- "status": "ENGAGEMENT_STATUS_UNDEFINED"
}, - "from": {
- "email": "string",
- "name": "string"
}, - "hasForwarding": true,
- "hasReply": true,
- "id": "string",
- "inTrash": true,
- "inbound": true,
- "mailType": "MAIL_TYPE_NORMAL",
- "mailboxId": "string",
- "maliciousAttachmentsMissing": true,
- "missingHtml": true,
- "ownerId": "string",
- "readEntries": [
- {
- "accountId": "string",
- "timestamp": "string"
}
], - "referenceIds": [
- "string"
], - "replyTo": "string",
- "sentByPlatform": true,
- "spam": true,
- "subject": "string",
- "timestamp": "string",
- "to": [
- {
- "email": "string",
- "name": "string"
}
]
}
}Sets the automatic reply configuration (enabled flag, date/time window, subject and body) on the given mailbox IDs. Returns the updated mailboxes.
required | object (v2AutomaticReply) |
| ids required | Array of strings |
{- "automaticReply": {
- "bodyHtml": "string",
- "bodyText": "string",
- "enabled": true,
- "endDate": {
- "day": 0,
- "month": 0,
- "year": 0
}, - "endTime": {
- "hours": 0,
- "minutes": 0,
- "nanos": 0,
- "seconds": 0
}, - "startDate": {
- "day": 0,
- "month": 0,
- "year": 0
}, - "startTime": {
- "hours": 0,
- "minutes": 0,
- "nanos": 0,
- "seconds": 0
}, - "subject": "string"
}, - "ids": [
- "string"
]
}{- "mailboxes": [
- {
- "active": true,
- "allowedUserIds": [
- "string"
], - "automaticReply": {
- "bodyHtml": "string",
- "bodyText": "string",
- "enabled": true,
- "endDate": {
- "day": 0,
- "month": 0,
- "year": 0
}, - "endTime": {
- "hours": 0,
- "minutes": 0,
- "nanos": 0,
- "seconds": 0
}, - "startDate": {
- "day": 0,
- "month": 0,
- "year": 0
}, - "startTime": {
- "hours": 0,
- "minutes": 0,
- "nanos": 0,
- "seconds": 0
}, - "subject": "string"
}, - "confidential": true,
- "documentRecognition": {
- "enabled": true
}, - "id": "string",
- "inboundEmail": "string",
- "mailboxType": "MAILBOX_TYPE_SPF",
- "mainUserId": "string",
- "name": "string",
- "outboundEmail": "string",
- "ownerId": "string",
- "signatureId": "string"
}
]
}Sets the confidential flag on the mails identified by the given IDs.
| confidential required | boolean |
| ids required | Array of strings |
{- "confidential": true,
- "ids": [
- "string"
]
}{ }Sets the confidential flag on the given mailbox IDs. Returns the updated mailboxes.
| confidential required | boolean |
| mailboxIds required | Array of strings |
{- "confidential": true,
- "mailboxIds": [
- "string"
]
}{- "mailboxes": [
- {
- "active": true,
- "allowedUserIds": [
- "string"
], - "automaticReply": {
- "bodyHtml": "string",
- "bodyText": "string",
- "enabled": true,
- "endDate": {
- "day": 0,
- "month": 0,
- "year": 0
}, - "endTime": {
- "hours": 0,
- "minutes": 0,
- "nanos": 0,
- "seconds": 0
}, - "startDate": {
- "day": 0,
- "month": 0,
- "year": 0
}, - "startTime": {
- "hours": 0,
- "minutes": 0,
- "nanos": 0,
- "seconds": 0
}, - "subject": "string"
}, - "confidential": true,
- "documentRecognition": {
- "enabled": true
}, - "id": "string",
- "inboundEmail": "string",
- "mailboxType": "MAILBOX_TYPE_SPF",
- "mainUserId": "string",
- "name": "string",
- "outboundEmail": "string",
- "ownerId": "string",
- "signatureId": "string"
}
]
}Sets the automatic document recognition configuration on the given mailbox IDs. Inbound PDF attachments (invoices and credit notes) of enabled mailboxes are processed by the document recognition service. Returns the updated mailboxes.
required | object (v2DocumentRecognitionConfig) Automatic document recognition ("Automatische Belegerkennung"). Only PDF attachments of inbound mails are considered; expected document types are invoices and credit notes. |
| mailboxIds required | Array of strings |
{- "documentRecognition": {
- "enabled": true
}, - "mailboxIds": [
- "string"
]
}{- "mailboxes": [
- {
- "active": true,
- "allowedUserIds": [
- "string"
], - "automaticReply": {
- "bodyHtml": "string",
- "bodyText": "string",
- "enabled": true,
- "endDate": {
- "day": 0,
- "month": 0,
- "year": 0
}, - "endTime": {
- "hours": 0,
- "minutes": 0,
- "nanos": 0,
- "seconds": 0
}, - "startDate": {
- "day": 0,
- "month": 0,
- "year": 0
}, - "startTime": {
- "hours": 0,
- "minutes": 0,
- "nanos": 0,
- "seconds": 0
}, - "subject": "string"
}, - "confidential": true,
- "documentRecognition": {
- "enabled": true
}, - "id": "string",
- "inboundEmail": "string",
- "mailboxType": "MAILBOX_TYPE_SPF",
- "mainUserId": "string",
- "name": "string",
- "outboundEmail": "string",
- "ownerId": "string",
- "signatureId": "string"
}
]
}Sets the reference IDs on the mails identified by the given IDs.
| ids required | Array of strings non-empty |
| referenceIds | Array of strings |
{- "referenceIds": [
- "string"
]
}{ }Validates the mail domain identified by the given ID and returns whether it is valid.
| id required | string |
{ }{- "isValid": true
}Creates a new signature or updates an existing one when id is provided. Accepts account ID, name, and signature text. Returns the saved signature.
| accountId required | string <int64> |
| id required | string OPTIONAL. If not provided a new signature is created |
| name required | string |
| signature required | string |
{- "accountId": "string",
- "id": "string",
- "name": "string",
- "signature": "string"
}{- "signature": {
- "accountId": "string",
- "id": "string",
- "name": "string",
- "signature": "string"
}
}Returns the signature for the given account. This is the legacy single-signature-per-account API.
| accountId required | string <int64> |
{- "signature": {
- "accountId": "string",
- "id": "string",
- "name": "string",
- "signature": "string"
}
}Sets the signature text for the given account. This is the legacy single-signature-per-account API.
| accountId required | string <int64> |
| signature | string |
{- "signature": "string"
}{ }Renders the given text and optional title for multiple entries, each with contact, object, property, and building IDs. Returns one rendered text/title result per contact.
required | Array of objects (v2BulkRenderTextEntry) |
| text required | string |
| title required | string |
{- "entries": [
- {
- "buildingId": "string",
- "condominiumId": "string",
- "contactId": "string",
- "objectId": "string",
- "propertyId": "string",
- "tenancyId": "string"
}
], - "text": "string",
- "title": "string"
}{- "entries": [
- {
- "contactId": "string",
- "text": "string",
- "title": "string"
}
]
}Creates a new message template for the given owner. Accepts type (email, letter, ticket, or deep sign), name, subject, message body, optional attachment media IDs, and language. Returns the created template.
| attachmentMediaIds required | Array of strings |
| language required | string |
| message required | string |
| name required | string |
| ownerId required | string <int64> |
| subject required | string |
| type required | string (v2TemplateType) Default: "TEMPLATE_TYPE_EMAIL" Enum: "TEMPLATE_TYPE_EMAIL" "TEMPLATE_TYPE_LETTER" "TEMPLATE_TYPE_TICKET" "TEMPLATE_TYPE_DEEP_SIGN" |
{- "attachmentMediaIds": [
- "string"
], - "language": "string",
- "message": "string",
- "name": "string",
- "ownerId": "string",
- "subject": "string",
- "type": "TEMPLATE_TYPE_EMAIL"
}{- "template": {
- "attachmentMediaIds": [
- "string"
], - "createdAt": "string",
- "id": "string",
- "language": "string",
- "message": "string",
- "name": "string",
- "ownerId": "string",
- "subject": "string",
- "type": "TEMPLATE_TYPE_EMAIL",
- "updatedAt": "string"
}
}Returns all message templates belonging to the given owner.
| ownerId | string <int64> |
{- "templates": [
- {
- "attachmentMediaIds": [
- "string"
], - "createdAt": "string",
- "id": "string",
- "language": "string",
- "message": "string",
- "name": "string",
- "ownerId": "string",
- "subject": "string",
- "type": "TEMPLATE_TYPE_EMAIL",
- "updatedAt": "string"
}
]
}Renders the given text and optional title using contact and object IDs for placeholder substitution. Returns the rendered text and title.
| contactId required | string |
| objectId required | string |
| text required | string |
| title required | string |
{- "contactId": "string",
- "objectId": "string",
- "text": "string",
- "title": "string"
}{- "text": "string",
- "title": "string"
}Renders the template identified by ID using optional contact, object, property, and building IDs for placeholder substitution. Returns subject, rendered text, and attachment media IDs.
| id required | string |
| buildingId | string |
| contactId | string |
| objectId | string |
| propertyId | string |
{- "buildingId": "string",
- "contactId": "string",
- "objectId": "string",
- "propertyId": "string"
}{- "attachmentMediaIds": [
- "string"
], - "subject": "string",
- "text": "string"
}Updates an existing message template by ID, including name, subject, message body, attachment media IDs, and language.
| id required | string |
| attachmentMediaIds | Array of strings |
| language | string |
| message | string |
| name | string |
| subject | string |
{- "attachmentMediaIds": [
- "string"
], - "language": "string",
- "message": "string",
- "name": "string",
- "subject": "string"
}{ }