This is an old revision of the document!
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 | Type | Description |
ExternalID | string | ID of the Mailing List. |
Name | string | 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 | Type | Description |
ExternalID | string | ID of the Mailing List. |
Name | string | 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 All Mailing Subscribers
This Endpoint is used to get all the Contacts that are currently Subscribed to a particular Mailing List.
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 | Type | Description |
SystemID | integer | The SystemID of a Contact. |
EmailAddress | string | The email address of a Contact. |
Example | [
{
"SystemID": "100",
"EmailAddress": "contact1@example.com"
},
{
"SystemID": "104",
"EmailAddress": "contact4@example.com"
},
]
|