API docs by Redocly

message API (develop:c14720)

Download OpenAPI specification:

License: None

Automatically generated swagger spec for the message stack.

TemplateService

TemplateService_BulkRenderText

Request Body schema: application/json
required
required
Array of objects (v2BulkRenderTextEntry)
text
required
string
title
required
string

Responses

Request samples

Content type
application/json
{
  • "entries": [
    ],
  • "text": "string",
  • "title": "string"
}

Response samples

Content type
application/json
{
  • "entries": [
    ]
}

Create

Request Body schema: application/json
required
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"

Responses

Request samples

Content type
application/json
{
  • "attachmentMediaIds": [
    ],
  • "language": "string",
  • "message": "string",
  • "name": "string",
  • "ownerId": "string",
  • "subject": "string",
  • "type": "TEMPLATE_TYPE_EMAIL"
}

Response samples

Content type
application/json
{
  • "template": {
    }
}

Read

query Parameters
ownerId
string <int64>

Responses

Response samples

Content type
application/json
{
  • "templates": [
    ]
}

TemplateService_RenderText

Request Body schema: application/json
required
contactId
required
string
objectId
required
string
text
required
string
title
required
string

Responses

Request samples

Content type
application/json
{
  • "contactId": "string",
  • "objectId": "string",
  • "text": "string",
  • "title": "string"
}

Response samples

Content type
application/json
{
  • "text": "string",
  • "title": "string"
}

Delete

path Parameters
ids
required
Array of strings non-empty

Responses

Response samples

Content type
application/json
{ }

TemplateService_Render

path Parameters
id
required
string
Request Body schema: application/json
required
buildingId
string
contactId
string
objectId
string
propertyId
string

Responses

Request samples

Content type
application/json
{
  • "buildingId": "string",
  • "contactId": "string",
  • "objectId": "string",
  • "propertyId": "string"
}

Response samples

Content type
application/json
{
  • "attachmentMediaIds": [
    ],
  • "subject": "string",
  • "text": "string"
}

Update

path Parameters
id
required
string
Request Body schema: application/json
required
attachmentMediaIds
Array of strings
language
string
message
string
name
string
subject
string

Responses

Request samples

Content type
application/json
{
  • "attachmentMediaIds": [
    ],
  • "language": "string",
  • "message": "string",
  • "name": "string",
  • "subject": "string"
}

Response samples

Content type
application/json
{ }

MailService

MailService_ActivateMailboxes

Request Body schema: application/json
required
ids
required
Array of strings

Responses

Request samples

Content type
application/json
{
  • "ids": [
    ]
}

Response samples

Content type
application/json
{ }

Confidential email list

Request Body schema: application/json
required
accountId
required
string <int64>
emails
required
Array of strings

Responses

Request samples

Content type
application/json
{
  • "accountId": "string",
  • "emails": [
    ]
}

Response samples

Content type
application/json
{ }

MailService_Archive

Request Body schema: application/json
required
ids
required
Array of strings

Responses

Request samples

Content type
application/json
{
  • "ids": [
    ]
}

Response samples

Content type
application/json
{ }

MailService_BulkSendMail

Request Body schema: application/json
required
required
Array of objects (v2BulkSendMailEntry)

Responses

Request samples

Content type
application/json
{
  • "entries": [
    ]
}

Response samples

Content type
application/json
{
  • "mail": [
    ]
}

MailService_CountDrafts

Responses

Response samples

Content type
application/json
{
  • "amount": 0
}

MailService_CountUnreadMails

path Parameters
mailboxIds
required
Array of strings non-empty

Responses

Response samples

Content type
application/json
{
  • "count": 0
}

Domain

Request Body schema: application/json
required
domain
required
string
ownerId
required
string <int64>

Responses

Request samples

Content type
application/json
{
  • "domain": "string",
  • "ownerId": "string"
}

Response samples

Content type
application/json
{
  • "domain": {
    }
}

User mailboxes

Request Body schema: application/json
required
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

Responses

Request samples

Content type
application/json
{
  • "allowedUserIds": [
    ],
  • "mailboxType": "MAILBOX_TYPE_SPF",
  • "mainUserId": "string",
  • "name": "string",
  • "outboundEmail": "string",
  • "ownerId": "string",
  • "signatureId": "string"
}

Response samples

Content type
application/json
{
  • "mailbox": {
    }
}

MailService_DeactivateMailboxes

Request Body schema: application/json
required
ids
required
Array of strings

Responses

Request samples

Content type
application/json
{
  • "ids": [
    ]
}

Response samples

Content type
application/json
{ }

MailService_DeleteDomain

path Parameters
id
required
string

Responses

Response samples

Content type
application/json
{ }

MailService_DeleteDrafts

path Parameters
ids
required
Array of strings non-empty

Responses

Response samples

Content type
application/json
{ }

MailService_DeleteMails

path Parameters
ids
required
Array of strings non-empty

Responses

Response samples

Content type
application/json
{ }

MailService_EditMailbox

path Parameters
id
required
string
Request Body schema: application/json
required
allowedUserIds
Array of strings
mainUserId
string (Can be empty if no specific user is using this mailbox)
name
string
outboundEmail
string
signatureId
string

Responses

Request samples

Content type
application/json
{
  • "allowedUserIds": [
    ],
  • "mainUserId": "string",
  • "name": "string",
  • "outboundEmail": "string",
  • "signatureId": "string"
}

Response samples

Content type
application/json
{ }

MailService_Forward

Request Body schema: application/json
required
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)

Responses

Request samples

Content type
application/json
{
  • "attachmentMediaIds": [
    ],
  • "bcc": [
    ],
  • "bodyHtml": "string",
  • "bodyText": "string",
  • "cc": [
    ],
  • "confidential": true,
  • "forwardingMailId": "string",
  • "from": {
    },
  • "ownerId": "string",
  • "referenceIds": [
    ],
  • "subject": "string",
  • "to": [
    ]
}

Response samples

Content type
application/json
{
  • "mail": {
    }
}

MailService_GetDeliveryAndEngagementData

Request Body schema: application/json
required
referenceIds
required
Array of strings

Responses

Request samples

Content type
application/json
{
  • "referenceIds": [
    ]
}

Response samples

Content type
application/json
{
  • "entries": [
    ]
}

MailService_GetMailbox

path Parameters
id
required
string

Responses

Response samples

Content type
application/json
{
  • "mailbox": {
    }
}

MailService_HasDomainDedicatedIp

query Parameters
fromEmail
string

Responses

Response samples

Content type
application/json
{
  • "hasDedicated": true
}

MailService_ListConfidentialEmails

path Parameters
accountId
required
string <int64>

Responses

Response samples

Content type
application/json
{
  • "emails": [
    ]
}

MailService_ListDomains

path Parameters
ownerId
required
string <int64>

Responses

Response samples

Content type
application/json
{
  • "domains": [
    ]
}

MailService_ListDrafts

Responses

Response samples

Content type
application/json
{
  • "drafts": [
    ]
}

MailService_ListLatestMailsForReferenceIds

Request Body schema: application/json
required
referenceIds
required
Array of strings

Responses

Request samples

Content type
application/json
{
  • "referenceIds": [
    ]
}

Response samples

Content type
application/json
{
  • "mails": [
    ]
}

MailService_ListMailIds

Request Body schema: application/json
required
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"

Responses

Request samples

Content type
application/json
{
  • "filterFolder": "FILTER_FOLDER_ALL",
  • "filterReferenceIdPrefixes": [
    ],
  • "filterUnread": "UNDEFINED_VALUE",
  • "mailboxIds": [
    ],
  • "query": "string",
  • "sortReceivedAt": "UNDEFINED_SORT_ORDER"
}

Response samples

Content type
application/json
{
  • "ids": [
    ]
}

MailService_ListMailboxesByAccountId

path Parameters
accountId
required
string <int64>

Responses

Response samples

Content type
application/json
{
  • "mailboxes": [
    ]
}

MailService_ListMailboxesByUserId

path Parameters
userId
required
string

Responses

Response samples

Content type
application/json
{
  • "mailboxes": [
    ]
}

MailService_ListMails

Request Body schema: application/json
required
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"

Responses

Request samples

Content type
application/json
{
  • "filterFolder": "FILTER_FOLDER_ALL",
  • "filterReferenceIdPrefixes": [
    ],
  • "filterUnread": "UNDEFINED_VALUE",
  • "itemsPerPage": 0,
  • "limitPagination": true,
  • "mailboxIds": [
    ],
  • "page": 0,
  • "query": "string",
  • "sortFromEmail": "UNDEFINED_SORT_ORDER",
  • "sortReceivedAt": "UNDEFINED_SORT_ORDER"
}

Response samples

Content type
application/json
{
  • "mails": [
    ],
  • "totalCount": 0,
  • "totalPageCount": 0
}

MailService_ListMailsByIds

Request Body schema: application/json
required
mailIds
required
Array of strings

Responses

Request samples

Content type
application/json
{
  • "mailIds": [
    ]
}

Response samples

Content type
application/json
{
  • "mails": [
    ]
}

MailService_ListMailsByReferenceIds

Request Body schema: application/json
required
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

Responses

Request samples

Content type
application/json
{
  • "filterFolder": "FILTER_FOLDER_ALL",
  • "itemsPerPage": 0,
  • "mailboxIds": [
    ],
  • "page": 0,
  • "query": "string",
  • "referenceIds": [
    ]
}

Response samples

Content type
application/json
{
  • "mails": [
    ],
  • "totalMailsCount": 0,
  • "totalPageCount": 0
}

MailService_MarkAsNoSpam

Request Body schema: application/json
required
ids
required
Array of strings

Responses

Request samples

Content type
application/json
{
  • "ids": [
    ]
}

Response samples

Content type
application/json
{ }

MailService_MarkAsSpam

Request Body schema: application/json
required
ids
required
Array of strings

Responses

Request samples

Content type
application/json
{
  • "ids": [
    ]
}

Response samples

Content type
application/json
{ }

MailService_MarkRead

Request Body schema: application/json
required
accountId
required
string <int64>
ids
required
Array of strings

Responses

Request samples

Content type
application/json
{
  • "accountId": "string",
  • "ids": [
    ]
}

Response samples

Content type
application/json
{ }

MailService_MarkUnread

Request Body schema: application/json
required
accountId
required
string <int64>
ids
required
Array of strings

Responses

Request samples

Content type
application/json
{
  • "accountId": "string",
  • "ids": [
    ]
}

Response samples

Content type
application/json
{ }

MailService_MoveToTrash

Request Body schema: application/json
required
ids
required
Array of strings

Responses

Request samples

Content type
application/json
{
  • "ids": [
    ]
}

Response samples

Content type
application/json
{ }

MailService_RemoveConfidentialEmails

Request Body schema: application/json
required
accountId
required
string <int64>
emails
required
Array of strings

Responses

Request samples

Content type
application/json
{
  • "accountId": "string",
  • "emails": [
    ]
}

Response samples

Content type
application/json
{ }

MailService_Unarchive

Request Body schema: application/json
required
ids
required
Array of strings

Responses

Request samples

Content type
application/json
{
  • "ids": [
    ]
}

Response samples

Content type
application/json
{ }

MailService_RestoreFromTrash

Request Body schema: application/json
required
ids
required
Array of strings

Responses

Request samples

Content type
application/json
{
  • "ids": [
    ]
}

Response samples

Content type
application/json
{ }

Mail drafts

Request Body schema: application/json
required
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)

Responses

Request samples

Content type
application/json
{
  • "attachmentMediaIds": [
    ],
  • "bcc": [
    ],
  • "bodyHtml": "string",
  • "bodyText": "string",
  • "cc": [
    ],
  • "forwardingMailId": "string",
  • "id": "string",
  • "mailboxId": "string",
  • "referenceIds": [
    ],
  • "replyToMailId": "string",
  • "subject": "string",
  • "timestamp": "string",
  • "to": [
    ]
}

Response samples

Content type
application/json
{
  • "draft": {
    }
}

Mails

Request Body schema: application/json
required
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)

Responses

Request samples

Content type
application/json
{
  • "attachmentMediaIds": [
    ],
  • "bcc": [
    ],
  • "bodyHtml": "string",
  • "bodyText": "string",
  • "cc": [
    ],
  • "confidential": true,
  • "from": {
    },
  • "mailType": "MAIL_TYPE_NORMAL",
  • "ownerId": "string",
  • "referenceIds": [
    ],
  • "replyToMailId": "string",
  • "sendAt": "string",
  • "subject": "string",
  • "to": [
    ]
}

Response samples

Content type
application/json
{
  • "mail": {
    }
}

MailService_SetAutomaticReply

Request Body schema: application/json
required
required
object (v2AutomaticReply)
ids
required
Array of strings

Responses

Request samples

Content type
application/json
{
  • "automaticReply": {
    },
  • "ids": [
    ]
}

Response samples

Content type
application/json
{
  • "mailboxes": [
    ]
}

MailService_SetConfidential

Request Body schema: application/json
required
confidential
required
boolean
ids
required
Array of strings

Responses

Request samples

Content type
application/json
{
  • "confidential": true,
  • "ids": [
    ]
}

Response samples

Content type
application/json
{ }

MailService_SetMailboxesConfidential

Request Body schema: application/json
required
confidential
required
boolean
mailboxIds
required
Array of strings

Responses

Request samples

Content type
application/json
{
  • "confidential": true,
  • "mailboxIds": [
    ]
}

Response samples

Content type
application/json
{
  • "mailboxes": [
    ]
}

MailService_SetReferenceIds

path Parameters
ids
required
Array of strings non-empty
Request Body schema: application/json
required
referenceIds
Array of strings

Responses

Request samples

Content type
application/json
{
  • "referenceIds": [
    ]
}

Response samples

Content type
application/json
{ }

MailService_ValidateDomain

path Parameters
id
required
string
Request Body schema: application/json
required
object

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{
  • "isValid": true
}

SignatureService

SignatureService_ListByAccountId

query Parameters
accountId
string <int64>

Responses

Response samples

Content type
application/json
{
  • "signatures": [
    ]
}

SignatureService_RenderById

path Parameters
id
required
string
userId
required
string

Responses

Response samples

Content type
application/json
{
  • "signature": "string"
}

New RPCs that support multiple signatures per account

Request Body schema: application/json
required
accountId
required
string <int64>
id
required
string

OPTIONAL. If not provided a new signature is created

name
required
string
signature
required
string

Responses

Request samples

Content type
application/json
{
  • "accountId": "string",
  • "id": "string",
  • "name": "string",
  • "signature": "string"
}

Response samples

Content type
application/json
{
  • "signature": {
    }
}

SignatureService_Get

path Parameters
accountId
required
string <int64>

Responses

Response samples

Content type
application/json
{
  • "signature": {
    }
}

SignatureService_Render

path Parameters
accountId
required
string <int64>
userId
required
string

Responses

Response samples

Content type
application/json
{
  • "signature": "string"
}

SignatureService_Set

path Parameters
accountId
required
string <int64>
Request Body schema: application/json
required
signature
string

Responses

Request samples

Content type
application/json
{
  • "signature": "string"
}

Response samples

Content type
application/json
{ }

SignatureService_DeleteSignature

path Parameters
id
required
string

Responses

Response samples

Content type
application/json
{ }