This shows you the differences between two versions of the page.
| Both sides previous revision Previous revision Next revision | Previous revision Next revision Both sides next revision | ||
|
api-emails [2015/03/04 11:42] dan |
api-emails [2015/03/04 12:09] dan [Get Sent Emails] |
||
|---|---|---|---|
| Line 2: | Line 2: | ||
| The Email Endpoints are used to manage the Emails in your Sentori Account. | The Email Endpoints are used to manage the Emails in your Sentori Account. | ||
| + | |||
| + | ===== Create Email ===== | ||
| + | |||
| + | This Endpoint is used to create a new Email in the Account. | ||
| + | |||
| + | ==== Endpoint ==== | ||
| + | |URI| <nowiki>https://api.sentoriapp.com/v2.0/emails/create/</nowiki>| | ||
| + | |Method| GET | | ||
| + | |||
| + | ==== Request ==== | ||
| + | |||
| + | |Field|Type|Required|Description| | ||
| + | |ExternalID|string|true|External ID of an Email Template to create from or an existing Email to copy.| | ||
| + | |Name|string|true|Name to use for the new Email.| | ||
| + | |Description|string|false|Description to use for the new Email.| | ||
| + | |||
| + | |Example|<code javascript>{ | ||
| + | "ExternalID":"AB1C234D", | ||
| + | "Name":"API Created Email", | ||
| + | "Description":"This is a new email." | ||
| + | }</code>| | ||
| + | |||
| + | ==== Response ==== | ||
| + | |Field|Type|Description| | ||
| + | |ExternalID|string|External ID of the new Email.| | ||
| + | |Example|<code javascript>{ | ||
| + | "ExternalID":"YQ4G521C" | ||
| + | }</code>| | ||
| ===== Get Draft Emails ===== | ===== Get Draft Emails ===== | ||
| Line 7: | Line 35: | ||
| This Endpoint is used to get the Draft Emails currently in your Sentori Account. | This Endpoint is used to get the Draft Emails currently in your Sentori Account. | ||
| + | ==== Endpoint ==== | ||
| |URI| <nowiki>https://api.sentoriapp.com/v2.0/emails/drafts/</nowiki>| | |URI| <nowiki>https://api.sentoriapp.com/v2.0/emails/drafts/</nowiki>| | ||
| |Method| GET | | |Method| GET | | ||
| Line 43: | Line 72: | ||
| This endpoint will get the [[/templates|Templates]] in an Account that can be used to create an Email. | This endpoint will get the [[/templates|Templates]] in an Account that can be used to create an Email. | ||
| + | ==== Endpoint ==== | ||
| |URI| <nowiki>https://api.sentoriapp.com/v2.0/emails/templates/</nowiki>| | |URI| <nowiki>https://api.sentoriapp.com/v2.0/emails/templates/</nowiki>| | ||
| |Method| GET | | |Method| GET | | ||
| Line 79: | Line 109: | ||
| This Endpoint is used to get the Broadcast Emails that have been sent. | This Endpoint is used to get the Broadcast Emails that have been sent. | ||
| + | ==== Endpoint ==== | ||
| |URI| <nowiki>https://api.sentoriapp.com/v2.0/emails/sent/</nowiki>| | |URI| <nowiki>https://api.sentoriapp.com/v2.0/emails/sent/</nowiki>| | ||
| |Method| GET | | |Method| GET | | ||