This shows you the differences between two versions of the page.
| Both sides previous revision Previous revision Next revision | Previous revision | ||
|
api-mailinglists [2017/01/18 13:18] ben [Response] |
api-mailinglists [2017/07/26 08:24] (current) |
||
|---|---|---|---|
| Line 4: | Line 4: | ||
| This Endpoint is used to get a single Mailing List in your Sentori Account. | This Endpoint is used to get a single Mailing List in your Sentori Account. | ||
| + | |||
| + | You can find the [[/mailing-lists|Mailing List]] External IDs on the [[/mailing-lists|Mailing List]] page in Sentori or by calling the Get All Mailing Lists API Endpoint. | ||
| ==== Endpoint ==== | ==== Endpoint ==== | ||
| - | |URI| <nowiki>https://api.sentoriapp.com/v2.0/mailinglists/MailingListExternalID/</nowiki>| | + | |URI| <nowiki>https://api.sentoriapp.com/v2.0/mailinglists/{MailingListExternalID}/</nowiki>| |
| |Method| GET | | |Method| GET | | ||
| Line 19: | Line 21: | ||
| { | { | ||
| "ExternalID": "1234ABCD", | "ExternalID": "1234ABCD", | ||
| - | "Name": "Members", | + | "Name": "Members' Offers", |
| - | "Description": "For members who receive special discount emails." | + | "Description": "For members who receive special offers emails." |
| } | } | ||
| </code>| | </code>| | ||
| Line 43: | Line 45: | ||
| { | { | ||
| "ExternalID": "1234ABCD", | "ExternalID": "1234ABCD", | ||
| - | "Name": "Members", | + | "Name": "Members' Offers", |
| - | "Description": "For members who receive extra special discount emails." | + | "Description": "For members who receive special offers emails." |
| }, | }, | ||
| { | { | ||
| "ExternalID": "ABCD1234", | "ExternalID": "ABCD1234", | ||
| - | "Name": "Special Offers", | + | "Name": "Standard Offers", |
| - | "Description": "For contacts to receive our special offers emails." | + | "Description": "For contacts who receive our standard offers emails." |
| } | } | ||
| + | ] | ||
| + | </code>| | ||
| + | |||
| + | |||
| + | ===== 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-lists|Mailing List]] External IDs on the [[/mailing-lists|Mailing List]] page in Sentori or by calling the Get All Mailing Lists API Endpoint. | ||
| + | |||
| + | ==== Endpoint ==== | ||
| + | |URI| <nowiki>https://api.sentoriapp.com/v2.0/mailinglists/subscribers/{MailingListExternalID}</nowiki>| | ||
| + | |Method| GET | | ||
| + | |||
| + | ==== Response ==== | ||
| + | |||
| + | |Field| Type|Description | | ||
| + | |SystemID|integer| The SystemID of a Contact.| | ||
| + | |EmailAddress|string| The email address of a Contact.| | ||
| + | |||
| + | |Example|<code javascript> | ||
| + | [ | ||
| + | { | ||
| + | "SystemID": "1", | ||
| + | "EmailAddress": "contact1@sentori.co.uk" | ||
| + | }, | ||
| + | { | ||
| + | "SystemID": "2", | ||
| + | "EmailAddress": "contact2@sentori.co.uk" | ||
| + | }, | ||
| ] | ] | ||
| </code>| | </code>| | ||