Skip to main content

Send a Transactional Message Request (Query String)

This method creates a request to send a Transactional Message to an email address. The response indicates whether the send was successful.

This is a GET method.

About Using Query String for a Trigger Request

HTTPS GET QS (Query String):

  • The query string is composed of a series of field-value pairs.
  • The field-value pairs are each separated by an equals sign (=).
  • The series of pairs is separated by the ampersand (&).
  • Below is an Internet browser URL location bar showing a URL where the Query String is: title=Main_page&action=raw
    HTTPS Query String

Personalization dyn tags are key:value pairs for each personalization dyn tag separated by a pipe (|) symbol. Example: To personalize the "firstname" and "lastname" values for a recipient with the name "John Blum", you would enter &dyn=firstname:John|lastname:Blum

REST URL

https://atmp-pub-api-www3.actito.com/NMSREST?random={random}&encrypt={encrypt}&email={email}&senddate={senddate}&stype={stype}&dyn={dynkey}:{dyn key value}|{dyn key}:{dyn key value}
Input parameters
Required parameters		DescriptionOutput parametersDescription
randomThe Unique Random Tag value provided for the Template in the ATMP interface.returnThe status of the send
encryptThe Security tag value provided for the Template in the ATMP interface.
emailThe email address to which you want to send the Transactional Message
senddateThe time you wish to send the Transactional Message. If you put a time in the past, it will be sent immediately. (For more information on date formats, see Parameter List)
notificationIdThe ID of the Template
synchrotypeThe synchrotype parameter is deprecated and relates to a feature that is no longer supported. Nevertheless, the synchrotype parameter must be declared in the call.

Actito recommends that you use "NOTHING" for the synchrotype value, but any of the following values can be used to get the same result:
  • NOTHING
    Actito recommends using the value "NOTHING" for the synchrotype parameter.
  • INSERT
  • UPDATE
  • INSERT_UPDATE
Dynamic Personalization Parameters
dynThe personalization parameter envelope to be used with parameter personalization (i.e., the EMV DYN personalization tags in your template).
keyThe key stated in the Template in the [EMV DYN] tag.
valueThe value of the dyn key

Error messages​

  • You must fill in the id parameter.
  • You must fill in the random parameter
  • You must fill in the encrypt parameter
  • You must fill in the email parameter
  • You must fill in the senddate parameter
  • You must fill in the stype parameter
  • The email address 0 is malformed!!
  • Error while parsing dyn parameter: 0.
  • Error while parsing sendDate parameter: 0.
  • Error while parsing encrypt parameter: 0
  • Query random: 0 doesn't match with notification random: 1 !!!
  • You don't have enough rights to use this service
  • The status not exist
  • The senddate doesn't exist or is malformed !
  • Job done or the sendRequest not exist
  • Unable to retrieve the notification
  • Unable to retrieve the client for this notification
  • Bad authentication!!! Random parameter is wrong 0
  • Wrong encrypt parameter!
  • An error occured on the server

REST Example​

Input​

https://atmp-pub-api-www3.actito.com/NMSREST?random=4A776E3602000078&encrypt=BdX7CqkmjTHtxWEKB5QK6MzXKkx6HK3E8guM&email=johnblum@flowerpowershop.biz&senddate=2020%2D12%2D12%2023%3A30%3A00&uidkey=email&stype=NOTHING&dyn=email:johnblum@flowerpowershop.biz|firstname:john|lastname:blum

Response​

<?xml version="1.0" encoding="utf-8" standalone="yes"?>
<response responseStatus="success" email="david.buxton@actito.com">
    <result xsi:type="xs:string" xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">SendRequest has been successfully saved!</result>
</response>