API Endpoints

Calling the API

Use HTTP GET/POST in any language of your preference. C#, Node.js, Python, JSON and Ajax examples below.

Sensorpro API Endpoint

https://newsletter.ie/run/APTE.aspx

Sensorpro on-premise API Endpoint

https://(your domain)/sensorpro/run/APTE.aspx

Authentication

All API's require that you authenticate with every request. Your API key is automatically generated in your Trigger campaign and would look like this:

Sample Code JSON:

Sample Code AJAX:

Sample Code Node.js

Sample Code C#

Sample Code Python

Substitution Data

&ApiKey API key System will default
&Camp Campaign id will be defaulted by the system
&BCact Broadcast id will be defaulted by the system

Required Parameters:

&Email: The email address which will be added to the subscriber database & emailed
&Delay: Delay the email by x minutes

Optional Parameters:

The following parameters can be passed as part of the contact record

FirstNameDateofBirthOptOutDate4
InFixDateOfLastPurchasePerStateDate5
LastNameGroupBy1PerZipUserChar10
PersonalEMailGroupBy2PerCountryUserChar11
GenderGroupBy3JobTitleUserChar12
PhoneBusinessGroupByIndustryPerStreetUserChar13
BusNameHomeFaxPerStreet1UserChar14
BusStreetNum1PerCityUserChar15
BusStreet1Num2CategoryUserChar2
BusCityNum3BusinessEmailUserChar3
BusStateNum4BusinessEmail1UserChar4
BusZipNum5BusinessFaxUserChar5
BusCountryPagerBusWebSiteUserChar6
MessagePreferencePasswordDate1UserChar7
PhoneHomePersonalEmail1Date2UserChar8
PhoneMobilePhoneOtherDate3UserChar9

Custom Data:

You may wish to pass data that is not part of the Sensorpro database i.e. from your own app. This data can be referenced to merge the data into the outgoing email. This data must be passed as encoded XML. Example:

These values can be referenced in the email design using the name value:
{item}
{Cost}
{OrderId}

API Status

To check the API call status: Admin/Setup/RequestQueueStatus
This is will list all of the queued calls and whether they have completed or not.

Get started

1 Create a Trigger campaign type

2 Select one of the templates provided or insert your own.

3 Note the API key and other parameters from the Broadcast screen

4 Verify your code and start sending.

Get Help.

We love Developers: Get help directly from our Engineering team.

Create your developer account: