Table of Contents

API Mailing List Endpoints

Get Mailing List

This Endpoint is used to get a single Mailing List in your Sentori Account.

You can find the Mailing List External IDs on the Mailing List page in Sentori or by calling the Get All Mailing Lists API Endpoint.

Endpoint

URI https://api.sentoriapp.com/v2.0/mailinglists/{MailingListExternalID}/
Method GET

Response

Field TypeDescription
ExternalID string ID of the Mailing List.
Namestring Name of the Mailing List.
Description string Description of the Mailing List.
Example
{
	"ExternalID": "1234ABCD",
	"Name": "Members' Offers",
	"Description": "For members who receive special offers emails."
}

Get All Mailing Lists

This Endpoint is used to get all Mailing Lists in your Sentori Account.

Endpoint

URI https://api.sentoriapp.com/v2.0/mailinglists/
Method GET

Response

Field TypeDescription
ExternalID string ID of the Mailing List.
Namestring Name of the Mailing List.
Description string Description of the Mailing List.
Example
[
	{
		"ExternalID": "1234ABCD",
		"Name": "Members' Offers",
		"Description": "For members who receive special offers emails."
	},
	{
		"ExternalID": "ABCD1234",
		"Name": "Standard Offers",
		"Description": "For contacts who receive our standard offers emails."
	}
]

Get Mailing List Subscribers

This Endpoint is used to get all the Contacts that are currently Subscribed to a particular Mailing List and are Emailable (those that are Unsubscribed or marked as having a Bad Email Address are excluded).

You can find the Mailing List External IDs on the Mailing List page in Sentori or by calling the Get All Mailing Lists API Endpoint.

Endpoint

URI https://api.sentoriapp.com/v2.0/mailinglists/subscribers/{MailingListExternalID}
Method GET

Response

Field TypeDescription
SystemIDinteger The SystemID of a Contact.
EmailAddressstring The email address of a Contact.
Example
[
	{
		"SystemID": "1",
		"EmailAddress": "contact1@sentori.co.uk"
	},
	{
		"SystemID": "2",
		"EmailAddress": "contact2@sentori.co.uk"
	},
]