API Email Endpoints

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	https://api.sentoriapp.com/v2.0/emails/create/
Method	POST

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

{
"ExternalID":"AB1C234D",
"Name":"API Created Email",
"Description":"This is a new email."
}

Response

Field	Type	Description
ExternalID	string	External ID of the new Email.
Example	{ "ExternalID":"YQ4G521C" }

Get Draft Emails

This Endpoint is used to get the Draft Emails currently in your Sentori Account.

Endpoint

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

Response

Field	Type	Description
ExternalID	string	ID of this Email.
Name	string	Name of this Email.
Description	string	Description of this Email.
Created	datetime	Timestamp of when this Email was created.
CreatedBy	string	Name of the user who created this Email.
Modified	datetime	Timestamp of the last time this Email was modified.
ModifiedBy	string	Name of the user who last modified this Email.

Example

[{
"ExternalID":"AB1C234D",
"Name":"Draft Email",
"Description":"This is a draft email.",
"Created":"2013-02-21T14:41:59.007",
"CreatedBy":"ExampleU",
"Modified":"2013-02-21T15:45:14.47",
"ModifiedBy":"ExampleU"
},{
"ExternalID":"XY1C234E",
"Name":"Another draft email",
"Description":"This is a second draft email.",
"Created":"2012-02-07T11:06:53.85",
"CreatedBy":"ExampleU",
"Modified":"2012-02-07T11:06:53.85",
"ModifiedBy":"ExampleU"}]

Get Email Templates

This endpoint will get the Templates in an Account that can be used to create an Email.

Endpoint

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

Response

Field	Type	Description
ExternalID	string	ID of this Template.
Name	string	Name of this Template.
Description	string	Description of this Template.
Created	datetime	Timestamp of when this Template was created.
CreatedBy	string	Name of the user who created this Template.
Modified	datetime	Timestamp of the last time this Template was modified.
ModifiedBy	string	Name of the user who last modified this Template.

Example

[{
"ExternalID":"AB1C234D",
"Name":"Template One",
"Description":"This is an Email Template.",
"Created":"2013-02-21T14:41:59.007",
"CreatedBy":"ExampleU",
"Modified":"2013-02-21T15:45:14.47",
"ModifiedBy":"ExampleU"
},{
"ExternalID":"XY1C234E",
"Name":"Template Two",
"Description":"This is a second Email Template.",
"Created":"2012-02-07T11:06:53.85",
"CreatedBy":"ExampleU",
"Modified":"2012-02-07T11:06:53.85",
"ModifiedBy":"ExampleU"}]

Get Sent Emails

This Endpoint is used to get the Broadcast Emails that have been sent.

Endpoint

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

Response

Field	Type	Description
ExternalID	string	ID of this Email.
Name	string	Name of this Email.
Description	string	Description of this Email.
Created	datetime	Timestamp of when this Email was created.
CreatedBy	string	Name of the user who created this Email.
Modified	datetime	Timestamp of the last time this Email was modified.
ModifiedBy	string	Name of the user who last modified this Email.
LastScheduled	datetime	Timestamp of the last time this Email was Scheduled to be Sent.

Example

[{
"ExternalID":"AB1C234D",
"Name":"Draft Email",
"Description":"This is a sent email.",
"Created":"2013-02-21T14:41:59.007",
"CreatedBy":"ExampleU",
"Modified":"2013-02-21T15:45:14.47",
"ModifiedBy":"ExampleU",
"LastScheduled":"2013-02-21T16:00:00"
},{
"ExternalID":"XY1C234E",
"Name":"Another draft email",
"Description":"This is a second sent email.",
"Created":"2012-02-07T11:06:53.85",
"CreatedBy":"ExampleU",
"Modified":"2012-02-07T11:06:53.85",
"ModifiedBy":"ExampleU",
"LastScheduled":"2013-02-07T11:30:00"}]