This article describes the Enudge REST web service which allows your website or web application to call an API to remove a specified contact from a specified message series. You might want to do this if, for example, your contact’s relationship with your organisation changes, or they indicate that they no longer want to be part of a segment that receives automated messaging.
The REST API can be accessed via the following endpoint:
https://www.enudge.com.au/api/removeContactFromSeries.php
The possible parameters are as follows:
{
“email_addr”:”name@domain.com”,
“mobile”:”+614111222333″,
“series_id”:”00″,
“license”:”YOURLICENSENUMBER”
}
Please note:
-
At least one of email_addr and mobile must be supplied.
-
You must include your Enudge License number. If you don’t have that, please send a request to Enudge support requesting a license number.
-
A valid Message Series ID must be included, corresponding to the ID of your Message Series in your Enudge account.
When submitted successfully, the API will respond with:
“Success: contact removed from series.”