Marketing
SCHEDULE "STRING"
The name of the schedule to send
BATCH_ID RECOMMENDED
A unique reference number. By default, a reference number is automatically generated if one is not provided. If you specify your own batch ID it must be unique across all schedule types and cannot be reused again, for example, a non-decimal integer value such as a microtime. In this instance, 100 bytes of disk space is reserved to store the batch ID in the database. If you want to save the batch ID that is returned in the call response, you need to reserve this amount of space for each batch ID. If a duplicate batch ID is detected, subsequent requests using the same batch ID are not processed.
RECIPIENTS ARRAY
The number of optional person fields and parameters that can be used per recipient, has a maximum limit.
EMAIL "STRING"
A person's email address. Currently this is limited to a maximum of 10,000 recipients. This data is stored in the database
MOBILE "STRING"
Mobile number. Currently this is limited to a maximum of 10,000 mobile numbers. A maximum of 100 optional person fields and parameters are allowed per mobile number.
FIRSTNAME OPTIONAL
A person's first name. Merge data for the message content. This data is stored in the database.
TITLELASTNAME OPTIONAL
A person's title and surname. Merge data for the message content. This data is stored in the database.
ORDERNUMBER OPTIONAL
Customer order number. Merge data for the message content. This data is stored in the database.
Marketing Response
STATUS "STRING"
A message describing the overall status of the call. A status of 'OK' is recorded as acceptance of the API request and not the receipt of the email.
BATCH_ID "STRING"
Returns the automatically generated or user defined batch ID that was specified in the call.
TOKEN "STRING"
Use this token in a Marketing getstatus call to identify and retrieve information about the specific Marketing call that was transmitted.
Marketing Get Status Response
STATUS "STRING"
Confirms the status of the API call, this changes as the call moves through the QUEUE to DONE
RECIPIENTS INTEGER
The number of total recipients
SENT INTEGER
The number of recipients who successfully received the message
FAILED INTEGER
The number of recipients who did not receive the message due to an incorrect email address or mobile number
ERRORS "STRING"
The error response received from the system while processing the request