Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Is there a single method that lets me choose the delivery channel (email/SMS)?

No, each channnel channel has its own endpoint and request format.

...

  • in case you need only the basic feature, getting started with SMTP+ is usually easier because there are a lot of "ready to use" code snippets that help you implement a an SMTP client   
  • with APIs you can choose between providing the whole HTML code of the message or to refer an existing email template that may be personalized with merge tags. The  The SMTP relay does not support templates instead.
  • the way you access them is different. Parameters that are specified with message headers in SMTP+, in the API are handled as fields of a JSON object that is passed to the web services. For more details about these parameters please check out the examples that are provided for SMTP+
  • with APIs you can take advantage of a set of additional methods for creating and retieving users

...

Which methods have to be used for sending transactional messages? 


Recipient's address, subject, email bodyRecipient's number, SMS text
ChannelMethodsReferenceMain request parametersOptional request parametersReturned values
Email
Code Block
POST https://send.mailup.com/API/v2.0/messages/sendmessage
 
POST https://send.mailup.com/API/v2.0/messages/sendtemplate
Transactional Emails using APIsscheduled datetime, campaign code*, ...Error codes
SMS
Code Block
POST https://sendsms.mailup.com/api/v2.0/sms/{account_ID}/{List_ID}
Transactional SMS using APIs

 

scheduled datetime, campaign code*, ...Delivery ID

 *the campaign code is an ID that MailUp

Which are the main request parameters?

Here is a short list. Please refer to the API documentation for all the details.

Main request parametersMain optionsAdvanced options
Email
  • Recipient's address,
  • subject,
  • email body

 

  • scheduled datetime,
  • campaign code*
  • merge tags (dynamic fields)
  • Template ID
  • From
  • Cc and Bcc
  • ReplyTo
  • Charset
  • Custom headers
  • Attachments (max 10 MB)
  • Embedded images
  • enable/disable tracking
  • header
  • footer
  • priority
SMS
  • Recipient's number,
  • SMS text

 

  • scheduled datetime,
  • campaign code*
  • merge tags (dynamic fields)
  • Template ID
  • Sender
  • Charset

*the campaign code is an ID that MailUp uses to group the mailing results by the specified ID.

For each new ID, MailUp creates a "message" object, which will act as result container

...