This shows you the differences between two versions of the page.
|
api-mailinglists [2017/05/04 09:09] ben [Get All Mailing List Subscribers] |
api-mailinglists [2017/07/26 08:24] |
||
|---|---|---|---|
| Line 1: | Line 1: | ||
| - | ====== 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-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/{MailingListExternalID}/</nowiki>| | ||
| - | |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|<code javascript> | ||
| - | { | ||
| - | "ExternalID": "1234ABCD", | ||
| - | "Name": "Members' Offers", | ||
| - | "Description": "For members who receive special offers emails." | ||
| - | } | ||
| - | </code>| | ||
| - | |||
| - | ===== Get All Mailing Lists ===== | ||
| - | |||
| - | This Endpoint is used to get all Mailing Lists in your Sentori Account. | ||
| - | |||
| - | ==== Endpoint ==== | ||
| - | |URI| <nowiki>https://api.sentoriapp.com/v2.0/mailinglists/</nowiki>| | ||
| - | |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|<code javascript> | ||
| - | [ | ||
| - | { | ||
| - | "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." | ||
| - | } | ||
| - | ] | ||
| - | </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": "100", | ||
| - | "EmailAddress": "contact1@example.com" | ||
| - | }, | ||
| - | { | ||
| - | "SystemID": "104", | ||
| - | "EmailAddress": "contact4@example.com" | ||
| - | }, | ||
| - | ] | ||
| - | </code>| | ||