Getting started
SMTP or API? It's
User Management resources
Create a SMTP+ user
To access resources and to use the methods, you must have an active account with an enabled SMTP+ user (SMTP+ users have the "sNNNNN_NN" format). You can create SMTP+ accounts and retrieve their credentials:
- from within the MailUp platform. See: SMTP Settings
- calling a REST API endpoint
In this page we explain how to create a SMTP+ account using the REST API endpoint.
Description
Retrieve the list of priorities
HTTP Method
GET
URL
Code Block |
---|
https://services.mailup.com/api/v1.1/rest/ConsoleService.svc/Console/SmtpPlusPriorities |
JSON request (example)
none
JSON response (example)
Depending on the invoked method, user management resources may require different credentials and authentication methods.
Authentication type | References | Description | ||
---|---|---|---|---|
OAuth 2 | Authenticating with OAuth v2 | Standard OAuth 2 with access and refresh tokens. In the request you must add the following header:
Note: OAuth 2 requires the MailUp account credentials, not SMTP+ username and password | ||
SMTP+ credentials in the request body | SMTP relay service | SMTP+ username and password must be included in each request through the "User" parameter inside the request body.
An error may be returned when the SMTP+ user is blocked. In this case you could use the "ListUserInfo" method to get more details about that user. For example, there could be a billing issue. |
Create a SMTP+ user
To access resources and to use the methods, you must have an active account with an enabled SMTP+ user (SMTP+ users have the "sNNNNN_NN" name format). You can create SMTP+ accounts and retrieve their credentials:
- from within the MailUp platform. See: SMTP Settings
- calling a REST API endpoint
In this page we explain how to create a SMTP+ account using the REST API endpoint.
Anchor | ||||
---|---|---|---|---|
|
Description | Service method to get the enumerated types of the available priority levels | ||||
---|---|---|---|---|---|
Authentication | OAuth 2 | ||||
HTTP Method | GET | ||||
URL |
| ||||
JSON request (example) | none | ||||
JSON response (example) |
| ||||
Paging and filtering (example) | none |
Create a new user
Description | To create Before creating a SMTP+ user you have to provide define one or more trusted senders email and/or one or more trusted domains. To retrieve the list of trusted emails please refer to this page. Remember that you can create a SMTP+ user only if all the trusted senders you provide in the TrustedSenders field have the StatusCode property equals to 1 (Confirmed): you can find this information here. To properly attemp this request, you need an access_token and include it in the Authorization header as shown below:
If you need more information about the MailUp REST API OAuth 2.0 authorization process, please refer to this page. | |||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Authentication | OAuth 2 | |||||||||||||
HTTP Method | POST | |||||||||||||
URL |
| |||||||||||||
JSON request (example) |
| |||||||||||||
JSON response (example)response (example) |
| |||||||||||||
Paging and filtering (example) | none |
Reset password
Description | Reset a SMTP+ account passwordthe password for the specified SMTP+ user. MailUp is in charge of creating a new password and providing it in the response body | ||||
---|---|---|---|---|---|
Authentication | OAuth 2 | ||||
HTTP Method | POST | ||||
URL |
| ||||
JSON request (example) |
| ||||
JSON response (example) |
If something goes wrong:
| ||||
Paging and filtering (example) | none |
Send resources
Username and password must be included in each request through the "User" parameter .
No Format |
---|
"User":{"Username":"YourSmtpPlusUsername","Secret":"YourSmtpPlusPassword"} |
An error may be returned when the SMTP+ user is blocked. In this case you could use the "ListUserInfo" method to get more details about that user.
For example, there could be a billing issue.
Messages
This section includes the methods that can be used to send transactional emails.
Use SendMessage when you need to specify a completely different content for each message, while you can use SendTemplate - and use merge tags - if you want to pick the body of an existing content and simply customize some of its parts.
The two methods provide the same level of performance: pick the one that better fits your needs.
Info | ||
---|---|---|
| ||
The use of a reply-to address different from the FROM email address must be enabled by MailUp. If you need this, please contact our support team by writing an email to support@mailup.com. |
SendMessage
This method allows sending of a transactional message to multiple recipients. This method is not intended for bulk mailings.
The message content is passed as input with HTML code or plain text. The message may also include attachments and embedded images.
title | Click here to learn more about request parameters |
---|
The method takes as input the document JSON or XML that has the structure MessageDTO defined in the tables below.
MessageDTO | ||
---|---|---|
Parameter | Type | Description |
Subject | String | the subject of the message |
Html | HtmlDTO | HTML part of the message (specify only the HTML inside the BODY tag) |
Text | String | the plain text part of the message |
From | EmailAddressDTO | the sender's name and email address |
To | List<EmailAddressDTO> | the list of recipientsin Toheader |
Cc | List<EmailAddressDTO> | the list of recipients in Cc header |
Bcc | List<EmailAddressDTO> | the list of recipients in Bcc |
ReplyTo | String | the email address to be added into Reply-To header |
CharSet | String | the charset of the message body |
ExtendedHeaders | List<NameValueDTO> | list of custom headers (only SMTP headers that are approved by MailUp will be added) |
Attachments | List<MessagePartDTO> | list of attachments |
EmbeddedImages | List<MessagePartDTO> | list of embedded images |
XSmtpAPI | XSmtpAPIDTO | the X-SMTPAPI header value, used for custom aggregations and configurations. You can use this parameter to overwrite, for a specific message, some of the settings |
User | SmtpUserDTO | the SMTP+ user credentials: the API uses the same credentials as the SMTP relay |
HtmlDTO | ||
---|---|---|
Parameter | Type | Description |
DocType | String | the DOCTYPE directive |
Head | String | the head content |
Body | String | the body content |
BodyTag | String | the body tag, default is "< body>" |
EmailAddressDTO | ||
---|---|---|
Parameter | Type | Description |
Name | String | the name |
String | the email address |
NameValueDTO | ||
---|---|---|
Parameter | Type | Description |
N | String | the name of the parameter |
V | String | the value of the parameter |
MessagePartDTO | ||
---|---|---|
Parameter | Type | Description |
Filename | String | the file name |
ContentId | String | the Content-Id value |
Body | Array of Byte | the array of byte of the content |
XSmtpAPIDTO | ||
---|---|---|
Parameter | Type | Description |
CampaignName | String | the name used for the aggregated campaign |
CampaignCode | String | the campaign code which determines the aggregation |
Header | Boolean | add or not the MailUp header to the message |
Footer | Boolean | add or not the MailUp footer to the message |
ClickTracking | Boolean | enable click tracking |
ViewTracking | Boolean | enable view tracking |
Priority | Integer | set the priority of the message (1 high - 5 low ) |
Schedule | DateTime | schedule date and time of when it should be sent |
DynamicFields | List<NameValueDTO> | list of merge tags and recipient fields |
CampaignReport | String | name of the aggregated campaign report |
SkipDynamicFields | Boolean | skip merge tags evaluation |
SmtpUserDTO | ||
---|---|---|
Parameter | Type | Description |
Username | String | username |
Secret | String | password |
title | Click here to learn more about response parameters |
---|
SendResponseDTO | ||
---|---|---|
Parameter | Type | Description |
Status | String | the status of the response can be "done" or "error" |
Code | String | the result code (see the Error Code table) |
Message | String | the result message |
Expand |
---|
{ |
{
"Status":"done",Example of error:
"Code":"0",
"Message":"Ok"
}
{
"Status":"error",
"Code":"102",
"Message":"The operation is not authorized."
}
SendTemplate
Description |
---|
Note |
---|
Only lowercase placeholders must be used in the referenced messages. If you use capital letters (e.g. "Dear [FirstName]", the text is not replaced |
title | Click here to learn more about request parameters |
---|
TemplateDTO | ||
---|---|---|
Parameter | Type | Description |
Subject | String | the subject of the message |
TemplateId | Integer | Numeric ID of the MailUp message whose content has to be used. It only accepts messages that belong to the same List in which the SMTP+ user was created |
From | EmailAddressDTO | the sender's name and email address |
To | List<EmailAddressDTO> | the list of recipientsin Toheader |
Cc | List<EmailAddressDTO> | the list of recipients in Cc header |
Bcc | List<EmailAddressDTO> | the list of recipients in Bcc |
ReplyTo | String | the email address to be added into Reply-To header |
CharSet | String | the charset of the message body |
ExtendedHeaders | List<NameValueDTO> | list of custom headers (only SMTP headers that are approved by MailUp will be added) |
Attachments | List<MessagePartDTO> | list of attachments |
EmbeddedImages | List<MessagePartDTO> | list of embedded images |
XSmtpAPI | XSmtpAPIDTO | the X-SMTPAPI header value, used for custom aggregations and configurations You can use this parameter to overwrite, for a specific message, some of the settings |
User | SmtpUserDTO | the SMTP+ user credentials |
See the SendMessage reference for the definition of the others DTOs (EmailAddressDTO, NameValueDTO, ...)
title | Click here to learn more about response parameters |
---|
SendResponseDTO | ||
---|---|---|
Parameter | Type | Description |
Status | String | the status of the response can be "done" or "error" |
Code | String | the result code (see the Error Code table) |
Message | String | the result message |
Expand |
---|
{ "TemplateId":694, "To":[{"Name":"Max","Email":"info@example.com"}], |
Paging and filtering (example)
none
Get SMTP+ users
Use ListUserInfo to retrieve status details about current SMTP+ user or other SMTP+ users that belong to the same List of a specified MailUp account.
ListUserInfo
Description | This method returns the list of SMTP+ users that exist in the List of a specified MailUp account. Status details of each user are provided | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Authentication | SMTP+ credentials in the request body | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
HTTP Method | POST | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
URL | https://send.mailup.com/API/v2.0/users/listuserinfo | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Reference |
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
JSON request (example) | {"User":{"Username":"sNNNN_NN","Secret":"..."},"Username":"sMMMM_MM"} | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
JSON response (example) | Example of a successfulresponse:{ Example of error: { "Status":"error", |
Send resources
All the send resources are accessed using SMTP+ credentials
Authentication type | References | Description | ||
---|---|---|---|---|
SMTP+ credentials in the request body | SMTP relay service | SMTP+ Username and password must be included in each request through the "User" parameter inside the request body.
An error may be returned when the SMTP+ user is blocked. In this case you could use the "ListUserInfo" method to get more details about that user. For example, there could be a billing issue. |
Messages
This section includes the methods that can be used to send transactional emails.
Use SendMessage when you need to specify a completely different content for each message, while you can use SendTemplate - and use merge tags - if you want to pick the body of an existing content and simply customize some of its parts.
The two methods provide the same level of performance: pick the one that better fits your needs.
Info | ||
---|---|---|
| ||
The use of a reply-to address different from the FROM email address must be enabled by MailUp. If you need this, please contact our support team by writing an email to support@mailup.com. |
SendMessage
Description | This method allows sending of a transactional message to multiple recipients. This method is not intended for bulk mailings. The message content is passed as input with HTML code or plain text. The message may also include attachments and embedded images. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Authentication | SMTP+ credentials in the request body | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
HTTP Method | POST | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
URL | https://send.mailup.com/API/v2.0/messages/sendmessage | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Reference |
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
JSON request (example) |
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
JSON response (example) | Example of a successfulresponsesuccessful response:{ "Status":"done",Example of error: { "Status":"error", |
SendTemplate
Users
Use ListUserInfo to retrieve status details about current SMTP+ user or other SMTP+ users that belong to the same List of a specified MailUp account.
ListUserInfo
Description | This method returns the list of SMTP+ users that exist in the List of a specified MailUp account. Status details of each user are providedDescription | This method allows sending of a transactional message to multiple recipients, taking advantage of placeholders to customize content. This method is not intended for bulk mailings. The message content (both HTML body and plain text) is obtained by specifying the unique ID of a message previously created and stored in the MailUp admin console. The message may also include attachments and embedded images.
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Authentication | SMTP+ credentials in the request body | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
HTTP Method | POST | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
URL | https://send.mailup.com/API/v2.0/usersmessages/listuserinfosendtemplate | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Reference |
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
JSON request (example) |
| JSON response (example) | Example of a successfulresponse:{ "Status
"UpdateDate":"2015-03-31T12:12:34", "DomainList":"
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
JSON response (example) | Example of a successfulresponse:{ "Status":"done", Example of error: { "Status":"error", |
Error codes
This table shows possible HTTP response statuses lists the response codes that can be returned by the API methods and the corresponding error code provided by the application (inside the response)methods whose authentication method consists of SMTP+ credentials in the request body.
HTTP response code | Application Code | Description |
---|---|---|
200 | 0 | Ok |
400 | 1 | The operation failed. |
403 | 101 | The input is null. |
403 | 102 | The operation is not authorized. |
403 | 103 | The user is not enabled. |
403 | 104 | The user is blocked. |
403 | 105 | The user is blocked until this date. |
403 | 106 | The MailUp account cannot be found. |
403 | 107 | The MailUp account has been suspended. |
403 | 108 | The MailUp account has been deleted. |
403 | 109 | At leastone least one recipient is required. |
403 | 110 | The sender is required. |
403 | 111 | The template cannot found. |
403 | 112 | The user has been deleted. |