This method is used to change the password of a user (based on the session key passed).
A session key must be submitted via the X-Session-Key header.
The response body will be empty.
A successful transaction will receive a 200 status code.
The change password request data
Ok
{}
The LogonRequestData model is required in the request body. ||
The NewPassword field is required. ||
The OldPassword field is required.
The X-Session-Key header is missing. ||
Bad session key. ||
Session key expired. ||
User is not authorized to use the Web Service API. ||
The new password has already been used as one of the last [NumberOfStoredPasswords] passwords. ||
The password could not be changed. Please ensure you are using the correct old password. ||
The new password could not be validated. ||
The new password does not meet complexity requirements. ||
Password not supplied. ||
The new password must be at least [MinimumLength] characters. ||
An error occurred while validating the password.
This method is used to query account information about the user.
(like the password expiration date, or how many unread messages are in the user's inbox) based on the session key passed.
A session key must be submitted via the X-Session-Key header.
The request body should be left empty.
A successful transaction will receive a 200 status code.
Ok
{
"EmailAddress": "string",
"FirstName": "string",
"LastName": "string",
"Statistics": {
"AccountSize": 0,
"AvailableAccountSize": 0,
"DateCreated": "string",
"DateOfLastNotice": "string",
"DateOfLastVisit": "string",
"DatePasswordExpires": "string",
"TotalFilesInOutbox": 0,
"TotalFilesSent": 0,
"TotalMessagesInInbox": 0,
"TotalMessagesInOutbox": 0,
"TotalMessagesReceived": 0,
"TotalMessagesSent": 0,
"TotalUnreadMessagesInInbox": 0,
"TotalVisits": 0,
"UsedAccountSize": 0
},
"Uid": 0,
"UserId": "string"
}
The X-Session-Key header is missing. ||
Bad session key. ||
Session key expired. ||
User is not authorized to use the Web Service API.
This method is used to authenticate DataMotion credentials and retrieve a session key.
Unless otherwise noted, this method must be called before any any other web service function, as the X-Session-Key header value is required to call most methods.
A successful transaction will receive a 200 status code.
The logon request data
Ok
{
"SessionKey": "string"
}
The LogonRequestData model is required in the request body. ||
The UserIdOrEmail field is required. ||
The Password field is required.
User account has not been verified. ||
User credentials are invalid. ||
User is not authorized to use the Web Service API. ||
Password expired. User must change their password to use this function. ||
Too many invalid logon attempts. User automatically disabled. ||
User could not be authenticated. ||
User disabled.
This method is used to invalidate a session key, making any subsequent calls with that session key invalid.
A session key must be submitted via the X-Session-Key header.
The request body should be left empty.
The response body will be empty.
A successful transaction will receive a 200 status code.
Ok
{}
The X-Session-Key header is missing. ||
Bad session key. ||
Session key expired. ||
User is not authorized to use the Web Service API.
This method is used to create or update DataMotion user accounts.
A session key must be submitted via the X-Session-Key header.
A successful transaction will receive a 200 status code.
The migrate users request data
Ok. ||
User migration successful. User migration validation successful. (0) ||
User migration failed. (10) ||
User migration Password exceeds maximum length. (20) ||
User migration CompanyId exceeds maximum length. (20) ||
User migration UserTypeId exceeds maximum length. (20) ||
User migration CompanyId less than zero. (20) ||
User migration UserTypeId less than zero. (20) ||
User migration company ID retrieval failed. (30) ||
User migration CompanyId in the request body does not match the company of the user associated with the session key. (40) ||
User migration UserTypeId does not exist. (50) ||
User migration cannot migrate user into integrator user type. (60) ||
User migration Users collection is NULL or empty. (70) ||
User migration UserTag exceeds maximum length. (80) ||
User migration UserId exceeds maximum length. (80) ||
User migration Email exceeds maximum length. (80) ||
User migration FirstName exceeds maximum length. (80) ||
User migration LastName exceeds maximum length. (80) ||
User migration CreateDate exceeds maximum length. (80) ||
User migration Create required CompanyId field is not greater than zero. (90) ||
User migration Create required UserTypeId field is not greater than zero. (90) ||
User migration Create required Password field is NULL or empty. (90) ||
User migration Create required UserId field is NULL or empty. (90) ||
User migration Create required Email field is NULL or empty. (90) ||
User migration Create required Email field is invalid. (90) ||
User migration Create optional CreateDate field is invalid. (90) ||
User migration Update no valid optional field supplied. (100) ||
User migration Update optional Email field is invalid. (100) ||
User migration Update optional CreateDate field is invalid. (100) ||
User migration Update cannot update user with blank password. (100) ||
User migration Create UserId already exists. (110) ||
User migration Create Email already exists. (120) ||
User migration Create UserId and Email already exist. (130) ||
User migration Create UserTag insert UserTag already exists. (140) ||
User migration Create failed to set CreateDate. (150) ||
User migration Create User Type Id is not associated with specified Company Id (155) ||
User migration Create unexpected exception occurred. Check the server logs. (160) ||
User migration Update user information retrieval failed. (170) ||
User migration Update CompanyId associated with the UserTag does not match the company of the user associated with the session key. (175) ||
User migration Update UserId already exists. (180) ||
User migration Update Email already exists. (190) ||
User migration Update failed to set CreateDate. (200) ||
User migration Update unexpected exception occurred. Check the server logs. (210) ||
User migration validation failed. User migration validation could not get migrated user data. (220) ||
User migration validation failed. User migration validation could not get migrated user data. Unexpected exception occurred. Check the server logs. (230).
{
"Users": [
{
"CompanyId": 0,
"UserTypeId": 0,
"Action": "string",
"Email": "string",
"UserId": "string",
"UserTag": "string",
"FirstName": "string",
"LastName": "string",
"CreateDate": "string",
"Uid": 0,
"Status": 0,
"Details": "string"
}
]
}
The MigrateUsersRequestData model is required in the request body. ||
The UserTag field is required. ||
CompanyId type is not an integer. ||
UserTypeId type is not an integer.
The X-Session-Key header is missing. ||
Bad session key. ||
Session key expired. ||
User is not authorized to use the Web Service API. ||
User is not authorized to use the MigrateUsers method. ||
User is not a company admin.
This method is used to retrieve a list of the user’s folders and corresponding statistics.
A session key must be submitted via the X-Session-Key header.
The request body should be left empty.
A successful transaction will receive a 200 status code.
Ok
{
"Folders": [
{
"FolderId": 0,
"FolderName": "string",
"FolderType": 0,
"FolderTypeDescription": "string",
"IsSystemFolder": true,
"TotalMessages": 0,
"TotalSize": 0
}
]
}
The X-Session-Key header is missing. ||
Bad session key. ||
Session key expired. ||
User is not authorized to use the Web Service API.
This method is used to create a custom folder in a user’s account.
Once a folder is created, messages can be moved into it using the Move Message function.
A session key must be submitted via the X-Session-Key header.
A successful transaction will receive a 200 status code.
The create folder request data
Ok
{
"FolderId": 0
}
The CreateFolderRequestData model is required in the request body. ||
The FolderName field is required.
The X-Session-Key header is missing. ||
Bad session key. ||
Session key expired. ||
User is not authorized to use the Web Service API. ||
The Folder Name already exists. ||
The Folder Name is too long. ||
Folder type [FolderType] is not supported. ||
The Folder Type or Folder Name is invalid. ||
Unknown error while creating folder.
This method is used to delete a custom folder from a user’s account.
Only custom folders can be deleted from a user’s account.
When a folder that contains messages is deleted from the system,
the messages will be moved into the respective Inbox or Outbox parent folder automatically.
A session key must be submitted via the X-Session-Key header.
The request body should be left empty.
The response body will be empty.
The FolderID of the folder you'd like to delete must be passed in the URL of this method.
A successful transaction will receive a 200 status code.
Unique folder identifier
Ok
{}
The X-Session-Key header is missing. ||
Bad session key. ||
Session key expired. ||
User is not authorized to use the Web Service API. ||
Could not parse the folder ID into an integer. ||
Folder could not be deleted. ||
Folder with ID [FolderId] does not exist.
This method retrieves a message based on the message ID passed.
A session key must be submitted via the X-Session-Key header.
The request body should be left empty.
The message ID of the message you'd like to retrieve must be passed in the URL of this method.
A successful transaction will receive a 200 status code.
Unique message identifier
Ok
{
"To": [
"string"
],
"From": "string",
"Cc": [
"string"
],
"Bcc": [
"string"
],
"Subject": "string",
"CreateTime": "string",
"Attachments": [
{
"AttachmentBase64": "string",
"ContentType": "string",
"FileName": "string",
"ContentId": "string"
}
],
"HtmlBody": "string",
"TextBody": "string"
}
The X-Session-Key header is missing. ||
Bad session key. ||
Session key expired. ||
User is not authorized to use the Web Service API. ||
Could not parse the message ID into an integer. ||
You do not have access to message with id [MessageId]. ||
The message has been deleted from the Inbox and is no longer available. ||
This message has been deleted from Track Sent and is no longer available. ||
An error has occurred at [DateTime] please check the server logs for details.
This method is used to delete a message from a folder.
When a message is deleted, it's normally moved to a Trash folder and then a Deleted Trash folder before being permanently purged from the DataMotion account.
The trash deletion mechanism is controlled by the DataMotion Server.
Deleting a message only removes the message from the current user’s account.
It does not remove the message from the account of any other DataMotion users referenced in the message.
A session key must be submitted via the X-Session-Key header.
The request body should be left empty.
The message ID of the message you'd like to delete must be passed in the URL of this method.
Include "?Permanently=true" to force a message to be permanently deleted from the account, bypassing any Trash folders.
A successful transaction will receive a 200 status code.
Unique message identifier
Indicates whether or not to force a message to be permanently deleted from the account, bypassing any Trash folders
Ok. ||
Message successfully deleted permanently. ||
Message successfully deleted from the trash folder and moved to the deleted trash folder. ||
Message successfully deleted from folder and moved to the trash folder.
{
"NewFolderId": 0,
"Result": "string"
}
The X-Session-Key header is missing. ||
Bad session key. ||
Session key expired. ||
User is not authorized to use the Web Service API. ||
Could not parse the message ID into an integer. ||
You do not have access to message with id [MessageId]. ||
Message could not be moved to the recovery folder. ||
Message could not be moved to the trash folder. ||
The message has been deleted from the Inbox and is no longer available. ||
This message has been deleted from Track Sent and is no longer available. ||
Message could not be permanently deleted from the user's account.
This method retrieves an attachment based on the attachment ID passed.
A session key must be submitted via the X-Session-Key header.
The request body should be left empty.
The attachment ID of the message you'd like to retrieve must be passed in the URL of this method.
A successful transaction will receive a 200 status code.
Unique attachment identifier
Ok
{
"AttachmentBase64": "string",
"ContentType": "string",
"FileName": "string",
"ContentId": "string"
}
The X-Session-Key header is missing. ||
Bad session key. ||
Session key expired. ||
User is not authorized to use the Web Service API. ||
Could not parse the attachment ID into an integer. ||
You do not have access to attachment with id [AttachmentId]. ||
The message has been deleted from the Inbox and is no longer available. ||
This message has been deleted from Track Sent and is no longer available. ||
An error has occurred at [DateTime] please check the server logs for details.
This method is used to retrieve the unique message identifiers (MIDs) of messages in a user's Inbox folder.
A session key must be submitted via the X-Session-Key header.
A successful transaction will receive a 200 status code.
The inbox message IDs search option data
Ok
{
"MessageIds": [
0
]
}
The InboxMessageIdsSearchOptionData model is required in the request body.
The X-Session-Key header is missing. ||
Bad session key. ||
Session key expired. ||
User is not authorized to use the Web Service API. ||
FolderId [FolderId] is not an inbox folder. ||
FolderId [FolderId] not found. ||
MessageList filter [MessageListFilter] is not supported.
This method is used to retrieve message summaries of all messages within a specified folder.
A session key must be submitted via the X-Session-Key header.
Include the LastMessageIdReceived request body parameter to specify the last message ID received to receive summaries only for messages created since the ID reference.
A successful transaction will receive a 200 status code.
Get message summaries request data
Ok
{
"Summaries": [
{
"AttachmentCount": 0,
"InlineAttachmentCount": 0,
"createTimeString": "string",
"FolderId": 0,
"MessageId": 0,
"MessageSize": 0,
"Read": true,
"MessageStatus": 0,
"SenderAddress": "string",
"Subject": "string",
"FirstRecipient": "string"
}
]
}
The GetMessageSummariesRequestData model is required in the request body.
The X-Session-Key header is missing. ||
Bad session key. ||
Session key expired. ||
User is not authorized to use the Web Service API. ||
FolderId [FolderId] not found. ||
An error has occurred at [DateTime] please check the server logs for details.
This method is used to retrieve message summaries of all messages with metadata within a specified folder.
A session key must be submitted via the X-Session-Key header.
Include the LastMessageIdReceived request body parameter to specify the last message ID received to receive summaries only for messages created since the ID reference.
A successful transaction will receive a 200 status code.
Get message summaries request data
Ok
{
"Summaries": [
{
"FirstRecipient": "string",
"AttachmentCount": 0,
"InlineAttachmentCount": 0,
"Attachments": [
{
"AttachmentId": 0,
"FileName": "string",
"ContentId": "string",
"SecurityEnvelope": {
"Checksum": "string",
"HashAlgorithm": "string",
"Status": 0,
"StatusDescription": "string"
},
"Size": {
"StdString": "string"
},
"Tracking": {
"Recipients": [
{
"ChecksumValidated": 0,
"Delivered": true,
"DeliveredDate": "string",
"Downloaded": true,
"DownloadedDate": "string",
"Email": "string"
}
]
}
}
],
"createTimeString": "string",
"ExpirationDate": "string",
"FolderId": 0,
"MessageId": 0,
"MessageSize": 0,
"Read": true,
"SecurityEnvelope": {
"Checksum": "string",
"HashAlgorithm": "string",
"Status": 0,
"StatusDescription": "string"
},
"MessageStatus": 0,
"Tracking": [
{
"DateOpened": "string",
"Email": "string",
"MessageStatusDescription": "string",
"MessageStatusId": 0,
"ReceiverField": "string"
}
],
"SenderAddress": "string",
"Subject": "string"
}
]
}
The GetMessageSummariesRequestData model is required in the request body.
The X-Session-Key header is missing. ||
Bad session key. ||
Session key expired. ||
User is not authorized to use the Web Service API. ||
FolderId [FolderId] not found. ||
An error has occurred at [DateTime] please check the server logs for details.
This method retrieves a message with attachment metadata but not the attachment contents based on the message ID passed.
A session key must be submitted via the X-Session-Key header.
The request body should be left empty.
The message ID of the message you'd like to retrieve must be passed in the URL of this method.
A successful transaction will receive a 200 status code.
Unique message identifier
Ok
{
"To": [
"string"
],
"From": "string",
"Cc": [
"string"
],
"Bcc": [
"string"
],
"Subject": "string",
"CreateTime": "string",
"Attachments": [
{
"AttachmentId": "string",
"ContentId": "string",
"ContentType": "string",
"FileName": "string",
"Size": 0
}
],
"HtmlBody": "string",
"TextBody": "string"
}
The X-Session-Key header is missing. ||
Bad session key. ||
Session key expired. ||
User is not authorized to use the Web Service API. ||
Could not parse the message ID into an integer. ||
You do not have access to message with id [MessageId]. ||
The message has been deleted from the Inbox and is no longer available. ||
This message has been deleted from Track Sent and is no longer available. ||
An error has occurred at [DateTime] please check the server logs for details.
This method is used to create and update with verify, and delete and move DataMotion messages.
A session key must be submitted via the X-Session-Key header.
A successful transaction will receive a 200 status code.
The migrate messages request data
Ok. ||
Message migration successful. Message migration validation successful. (0) ||
Message migration failed. (10) ||
Message migration Password exceeds maximum length. (20) ||
Message migration ChecksumAlgorithm exceeds maximum length. (20) ||
Message migration messages collection is NULL or empty. (30) ||
Message migration Action exceeds maximum length. (40) ||
Message migration CreateDate exceeds maximum length. (40) ||
Message migration FolderName exceeds maximum length. (40) ||
Message migration MessageTag exceeds maximum length. (40) ||
Message migration ReadStatus exceeds maximum length. (40) ||
Message migration UserTag exceeds maximum length. (40) ||
Message migration Create required ChecksumAlgorithm field is NULL or empty. (50) ||
Message migration Create required ChecksumAlgorithm field is invalid. (50) ||
Message migration Create required UserTag field is NULL or empty. (50) ||
Message migration Create required FolderName field is NULL or empty. (50) ||
Message migration Create required FolderName field is invalid. (50) ||
Message migration Create required ReadStatus field is NULL or empty. (50) ||
Message migration Create required ReadStatus field is invalid. (50) ||
Message migration Create required ContentData field is NULL or empty. (50) ||
Message migration Create optional CreateDate field is invalid. (50) ||
Message migration Update optional FolderName field is invalid. (60) ||
Message migration Update optional CreateDate field is invalid. (60) ||
Message migration Update optional ReadStatus field is invalid. (60) ||
Message migration Update ContentData is populated and ChecksumAlgorithm field is NULL or empty. (60) ||
Message migration Update ContentData is populated and ChecksumAlgorithm field is invalid. (60) ||
Message migration Update no valid optional field supplied. (60) ||
Message migration Create UserTag does not exist. (70) ||
Message migration Create CompanyId associated with the UserTag does not match the company of the user associated with the session key. (75) ||
Message migration Create the email address associated with the UserTag is not in the From or To or Cc or Bcc field. (80) ||
Message migration Create the Trash folder is invalid in the old email address use case. (82) ||
Message migration Create Inbox or Inbox|Trash folder passed and no recipient email addresses exist in the message in the old email address use case. (83) ||
Message migration Create Sent or Drafts or Sent|Trash folder passed and no From email address exists in the message in the old email address use case. (87) ||
Message migration Create Inbox|Trash and Sent|Trash are only valid in the old email address use case. (89) ||
Message migration Create the email address associated with the UserTag is in the From field only. The FolderName submitted is 'INBOX'. The submitted FolderName must be 'DRAFT' or 'SENT' or 'TRASH' when the email address associated with UserTag is in the From field only. (90) ||
Message migration Create the email address associated with the UserTag is in a recipient field only. The FolderName submitted is 'DRAFT' or 'SENT'. The submitted FolderName must be 'INBOX' or 'TRASH' when the email address associated with UserTag is in a recipient field only. (100) ||
Message migration Create no recipient addresses. (110) ||
Message migration Create recipient creation cannot create user with blank password. (112) ||
Message migration Create recipient creation email exceeds maximum length. (114) ||
Message migration Create recipient creation unexpected exception occurred. Check the server logs. (120) ||
Message migration Create no From address. (130) ||
Message migration Create sender creation cannot create user with blank password. (132) ||
Message migration Create sender creation email exceeds maximum length. (134) ||
Message migration Create sender creation unexpected exception occurred. Check the server logs. (140) ||
Message migration Create Subject exceeds maximum length. (145) ||
Message migration file sizes greater than 32 MB are not supported. (150) ||
Message migration Create write migration message unexpected exception occurred. Check the server logs. (160) ||
Message migration validation could not get migrated message data. (170) ||
Message migration validation could not get migrated message data. Unexpected exception occurred. Check the server logs. (180) ||
Message migration Move message UserTag is not associated with the message. Cannot move to specified folder. (200) ||
Message migration Move CompanyId associated with the UserTag does not match the company of the user associated with the session key. (205) ||
Message migration Move sender cannot move to folder Inbox. (210) ||
Message migration Move sender cannot move to folder Draft. (220) ||
Message migration Move recipient cannot move to folder Sent. (230) ||
Message migration Move recipient cannot move to folder Draft. (240) ||
Message migration Move message associated with recipient and folder specified is not Inbox or Trash. (250) ||
Message migration Move message associated with sender and folder specified is not Sent or Trash. (260) ||
Message migration Move message from Draft to Sent and message does not have recipients. (270) ||
Message migration Move message invalid folder. Check the server logs. (280) ||
Message migration Move message unexpected exception occurred. Check the server logs. (290) ||
Message migration Update sender cannot move to folder Inbox. (300) ||
Message migration Update sender cannot move to folder Draft. (310) ||
Message migration Update message associated with sender and folder specified is not Sent or Trash. (320) ||
Message migration Update recipient cannot move to folder Sent. (330) ||
Message migration Update recipient cannot move to folder Draft. (340) ||
Message migration Update message associated with recipient and folder specified is not Inbox or Trash. (350) ||
Message migration Update message move unexpected exception occurred. Check the server logs. (360) ||
Message migration Update message move invalid folder. Check the server logs. (370) ||
Message migration Update message cannot update a draft message with a ReadStatus value of Read. (380) ||
Message migration Update message ReadStatus unexpected exception occurred. Check the server logs. (390) ||
Message migration Update message CreateDate unexpected exception occurred. Check the server logs. (400) ||
Message migration Update message UserTag does not exist. (410) ||
Message migration Update CompanyId associated with the UserTag does not match the company of the user associated with the session key. (415) ||
Message migration Update message UserTag is not associated with the message. (420) ||
Message migration Update message UserTag unexpected exception occurred. Check the server logs. (430) ||
Message migration Update message delete unexpected exception occurred. Check the server logs. (440) ||
Message migration file sizes greater than 32 MB are not supported. (450) ||
Message migration Update the email address associated with the UserTag is in the From field only. The FolderName submitted is 'INBOX'. The submitted FolderName must be 'DRAFT' or 'SENT' or 'TRASH' when the email address associated with UserTag is in the From field only. (460) ||
Message migration Update no recipient addresses. (470) ||
Message migration Update recipient creation cannot create user with blank password. (472) ||
Message migration Update recipient creation email exceeds maximum length. (474) ||
Message migration Update recipient creation unexpected exception occurred. Check the server logs. (480) ||
Message migration Update the email address associated with the UserTag is not in the From or To or Cc or Bcc field. (490) ||
Message migration Update the email address associated with the UserTag is in a recipient field only. The FolderName submitted is 'DRAFT' or 'SENT'. The submitted FolderName must be 'INBOX' or 'TRASH' when the email address associated with UserTag is in a recipient field only. (500) ||
Message migration Update no From address. (510) ||
Message migration Update sender creation cannot create user with blank password. (512) ||
Message migration Update sender creation email exceeds maximum length. (514) ||
Message migration Update sender creation unexpected exception occurred. Check the server logs. (520) ||
Message migration Update Subject exceeds maximum length. (530) ||
Message migration Delete message MessageTag does not exist. (600) ||
Message migration Delete CompanyId associated with the UserTag does not match the company of the user associated with the session key. (605) ||
Message migration Delete message unexpected exception occurred. Check the server logs. (610)
{
"Messages": [
{
"Action": "string",
"UserTag": "string",
"FolderName": "string",
"MessageTag": "string",
"DmMessageId": 0,
"Status": 0,
"Details": "string",
"CreateDate": "string",
"ContentDataHash": "string"
}
]
}
The MigrateMessagesRequestData model is required in the request body. ||
The Messages field is required.
The X-Session-Key header is missing. ||
Bad session key. ||
Session key expired. ||
User is not authorized to use the Web Service API. ||
User is not authorized to use the MigrateMessages method. ||
User is not a company admin.
This method saves a draft message to a given recipient(s) from the user associated with the session key.
A session key must be submitted via the X-Session-Key header.
A successful transaction will receive a 200 status code.
Save draft message data
Ok
{
"MessageId": 0
}
The SaveDraftMessageData model is required in the request body. ||
The To field is required.
The Subject exceeds maximum length.
The X-Session-Key header is missing. ||
Bad session key. ||
Session key expired. ||
User is not authorized to use the Web Service API. ||
Recipient Invalid - To recipient is [ToEmailAddress]. ||
Recipient Invalid - Cc recipient is [CcEmailAddress]. ||
Recipient Invalid - Bcc recipient is [BccEmailAddress]. ||
File sizes greater than 32 MB are not supported. ||
Message not sent because you do not have permission to send or the email address is incorrectly formed for one or more of the recipients specified. ||
At least one recipient must be specified. If you are trying to send a MIME message, please use the SendMimeMessage ({serviceUrl}/Message/Mime) method instead.
This method sends a saved draft message to a given recipient(s) from the user associated with the session key.
A session key must be submitted via the X-Session-Key header.
A successful transaction will receive a 200 status code.
Unique message identifier of the saved draft to be sent.
Ok
{
"MessageId": 0
}
The X-Session-Key header is missing. ||
Bad session key. ||
Session key expired. ||
User is not authorized to use the Web Service API. ||
Recipient Invalid - To recipient is [ToEmailAddress]. ||
Recipient Invalid - Cc recipient is [CcEmailAddress]. ||
Recipient Invalid - Bcc recipient is [BccEmailAddress]. ||
File sizes greater than 32 MB are not supported. ||
Message not sent because you do not have permission to send or the email address is incorrectly formed for one or more of the recipients specified. ||
At least one recipient must be specified. If you are trying to send a MIME message, please use the SendMimeMessage ({serviceUrl}/Message/Mime) method instead. ||
Message '{0}' is not in the Drafts Folder.
Sends a properly formatted MIME message.
A session key must be submitted via the X-Session-Key header.
If the MIME string is improperly formatted, the message will be saved as a draft.
A successful transaction will receive a 200 status code.
The send MIME message request data
Ok
{
"MessageId": 0
}
The SendMimeMessageRequestData model is required in the request body.
The X-Session-Key header is missing. ||
Bad session key. ||
Session key expired. ||
User is not authorized to use the Web Service API.
This method is used to retrieve metadata for a sent message, particularly tracking and security information.
A session key must be submitted via the X-Session-Key header.
The request body should be left empty.
The message ID of the message metadata you'd like to retrieve must be passed in the URL of this method.
A successful transaction will receive a 200 status code.
Unique message identifier
Ok
{
"Attachments": [
{
"AttachmentId": 0,
"FileName": "string",
"ContentId": "string",
"SecurityEnvelope": {
"Checksum": "string",
"HashAlgorithm": "string",
"Status": 0,
"StatusDescription": "string"
},
"Size": {
"StdString": "string"
},
"Tracking": {
"Recipients": [
{
"ChecksumValidated": 0,
"Delivered": true,
"DeliveredDate": "string",
"Downloaded": true,
"DownloadedDate": "string",
"Email": "string"
}
]
}
}
],
"ExpirationDate": "string",
"MessageId": 0,
"MessageSize": 0,
"SecurityEnvelope": {
"Checksum": "string",
"HashAlgorithm": "string",
"Status": 0,
"StatusDescription": "string"
},
"Tracking": [
{
"DateOpened": "string",
"Email": "string",
"MessageStatusDescription": "string",
"MessageStatusId": 0,
"ReceiverField": "string"
}
]
}
The X-Session-Key header is missing. ||
Bad session key. ||
Session key expired. ||
User is not authorized to use the Web Service API. ||
Could not parse the message ID into an integer. ||
You do not have access to message with id [MessageId]. ||
The message has been deleted from the Inbox and is no longer available. ||
This message has been deleted from Track Sent and is no longer available.
This method is used to retrieve a DataMotion message in standard MIME format.
Senders and recipients are the only users that have access to the message and will be permitted to retrieve basic DataMotion header information and the Security Envelope.
The message sender is the only user that will be permitted to retrieve detailed tracking information.
When a message is retrieved using this function, tracking information will automatically be written indicating the message was read by the recipient.
A session key must be submitted via the X-Session-Key header.
The request body should be left empty.
The message ID of the message you'd like to get the MIME format of must be passed in the URL of this method.
A successful transaction will receive a 200 status code.
Unique message identifier
Ok
{
"MimeMessage": "string"
}
The X-Session-Key header is missing. ||
Bad session key. ||
Session key expired. ||
User is not authorized to use the Web Service API. ||
Could not parse the message ID into an integer. ||
You do not have access to message with id [MessageId]. ||
The message has been deleted from the Inbox and is no longer available. ||
This message has been deleted from Track Sent and is no longer available.
This method returns message summaries for all unread messages in the user's Inbox.
A session key must be submitted via the X-Session-Key header.
The request body should be left empty.
Include "?After={LastMessageIDReceived}" to specify the last message ID received to receive only messages created since the ID reference.
A successful transaction will receive a 200 status code.
Format - int32. Used to specify the last message ID received to receive summaries only for messages created since the ID reference
Ok
{
"Summaries": [
{
"AttachmentCount": 0,
"InlineAttachmentCount": 0,
"createTimeString": "string",
"FolderId": 0,
"MessageId": 0,
"MessageSize": 0,
"Read": true,
"MessageStatus": 0,
"SenderAddress": "string",
"Subject": "string",
"FirstRecipient": "string"
}
]
}
The X-Session-Key header is missing. ||
Bad session key. ||
Session key expired. ||
User is not authorized to use the Web Service API.
This method is used to move a particular message into a specific folder.
Messages can only be moved within their respective type (ie: Inbox or Outbox), but they can be placed in any subfolder with the same type.
A session key must be submitted via the X-Session-Key header.
The message ID of the message you'd like to move must be passed in the URL of this method.
The response body will be empty.
A successful transaction will receive a 200 status code.
Unique message identifier
The move message request data
Ok
{}
The MoveMessageRequestData model is required in the request body. ||
The DestinationFolderId field is required.
The X-Session-Key header is missing. ||
Bad session key. ||
Session key expired. ||
User is not authorized to use the Web Service API. ||
Could not parse the message ID into an integer. ||
You do not have access to message with id [MessageId]. ||
FolderId [FolderId] not found. ||
Could not move the message into the destination folder. ||
Message could not be moved to the recovery folder. ||
Message could not be moved to the trash folder. ||
The message has been deleted from the Inbox and is no longer available. ||
This message has been deleted from Track Sent and is no longer available.
This method retracts a message from any recipients that have received the message.
A message can be retracted whether or not the recipient has read the message, but the message will remain in that user’s account until it expires or the recipient deletes it.
A session key must be submitted via the X-Session-Key header.
The request body should be left empty.
The message ID of the message you'd like to retract must be passed in the URL of this method.
The response body will be empty.
A successful transaction will receive a 200 status code.
Unique message identifier
Ok
{}
The X-Session-Key header is missing. ||
Bad session key. ||
Session key expired. ||
User is not authorized to use the Web Service API. ||
Could not parse the message ID into an integer. ||
You do not have access to message with id [MessageId]. ||
Message could not be retracted. You may not have permission to retract this message. ||
The message has been deleted from the Inbox and is no longer available. ||
This message has been deleted from Track Sent and is no longer available.
This method is used to search the user's inbox, based on filter parameters.
A session key must be submitted via the X-Session-Key header.
A successful transaction will receive a 200 status code.
Mailbox search options data
Ok
{
"PageDetails": {
"CurrentPage": 0,
"FolderId": 0,
"OrderBy": "string",
"PageSize": 0,
"TotalMessages": 0,
"TotalPages": 0
},
"Results": [
{
"CreateTime": "string",
"LastAction": 0,
"MessageId": 0,
"MessageSize": 0,
"MessageStatusId": 0,
"PasswordHint": "string",
"Read": true,
"MessageStatus": 0,
"ReadConfirmation": true,
"SenderEmail": "string",
"SenderId": 0,
"Subject": "string"
}
]
}
The MailboxSearchOptionsData model is required in the request body. ||
The PageNum field is required. ||
The PageSize field is required.
The X-Session-Key header is missing. ||
Bad session key. ||
Session key expired. ||
User is not authorized to use the Web Service API. ||
FolderId [FolderId] not found. ||
FolderId [FolderId] is not an inbox folder. ||
Please specify a page size between 1 and 1000. ||
Expected 2 tables from WSGetInboxData but got [NumberOfTables]. ||
Last action [LastAction] is not supported.
This method sends a message to a given recipient(s) from the user associated with the session key.
A session key must be submitted via the X-Session-Key header.
A successful transaction will receive a 200 status code.
Send message message data
Ok
{
"MessageId": 0
}
The SendMessageMessageData model is required in the request body. ||
The To field is required. ||
The Subject exceeds maximum length.
An invalid Content Id was provided on an attachment.
The X-Session-Key header is missing. ||
Bad session key. ||
Session key expired. ||
User is not authorized to use the Web Service API. ||
Recipient Invalid - To recipient is [ToEmailAddress]. ||
Recipient Invalid - Cc recipient is [CcEmailAddress]. ||
Recipient Invalid - Bcc recipient is [BccEmailAddress]. ||
File sizes greater than 32 MB are not supported. ||
Message not sent because you do not have permission to send or the email address is incorrectly formed for one or more of the recipients specified. ||
At least one recipient must be specified. If you are trying to send a MIME message, please use the SendMimeMessage ({serviceUrl}/Message/Mime) method instead.