Elastic Email REST API (4.0.0)
This API is based on the REST API architecture, allowing the user to easily manage their data with this resource-based approach.
Every API call is established on which specific request type (GET, POST, PUT, DELETE) will be used.
The API has a limit of 20 concurrent connections and a hard timeout of 600 seconds per request.
To start using this API, you will need your Access Token (available here). Remember to keep it safe. Required access levels are listed in the given request’s description.
Downloadable library clients can be found in our Github repository here
Load Campaigns
Returns a list all of your campaigns. Limited to 1000 results. Required Access Level: ViewCampaigns
Authorizations:
query Parameters
search | string <string> Text fragment used for searching in Campaign name (using the 'contains' rule) |
offset | integer <int32> Default: "0" Example: offset=20 How many items should be returned ahead. |
limit | integer <int32> Default: "0" Example: limit=100 Maximum number of returned items. |
Responses
Response Schema: application/json
Name required | string <string> Campaign name |
required | object (CampaignRecipient) A set of lists and segments names to read recipients from |
Array of objects (CampaignTemplate) [ items ] Campaign's email content. Provide multiple items to send an A/X Split Campaign | |
Status | string (CampaignStatus) Default: "Deleted" Enum: "Deleted" "Active" "Processing" "Sending" "Completed" "Paused" "Cancelled" "Draft" |
object (CampaignOptions) Different send options for a Campaign |
Response samples
- 200
[- {
- "Content": [
- {
- "Poolname": "My Custom Pool",
- "From": "John Doe <email@domain.com>",
- "ReplyTo": "John Doe <email@domain.com>",
- "Subject": "Hello!",
- "TemplateName": "Template01",
- "AttachFiles": [
- "preuploaded.jpg"
], - "Utm": {
- "Source": "string",
- "Medium": "string",
- "Campaign": "string",
- "Content": "string"
}
}
], - "Name": "string",
- "Status": "Deleted",
- "Recipients": {
- "ListNames": [
- "string"
], - "SegmentNames": [
- "string"
]
}, - "Options": {
- "DeliveryOptimization": "None",
- "TrackOpens": "true",
- "TrackClicks": "true",
- "ScheduleFor": null,
- "TriggerFrequency": 0,
- "TriggerCount": 0,
- "SplitOptions": {
- "OptimizeFor": "Opens",
- "OptimizePeriodMinutes": "30"
}
}
}
]
Add Campaign
Add a campaign for processing. Required Access Level: ModifyCampaigns
Authorizations:
Request Body schema: application/json
JSON representation of a campaign
Name required | string <string> Campaign name |
required | object (CampaignRecipient) A set of lists and segments names to read recipients from |
Array of objects (CampaignTemplate) [ items ] Campaign's email content. Provide multiple items to send an A/X Split Campaign | |
Status | string (CampaignStatus) Default: "Deleted" Enum: "Deleted" "Active" "Processing" "Sending" "Completed" "Paused" "Cancelled" "Draft" |
object (CampaignOptions) Different send options for a Campaign |
Responses
Response Schema: application/json
Name required | string <string> Campaign name |
required | object (CampaignRecipient) A set of lists and segments names to read recipients from |
Array of objects (CampaignTemplate) [ items ] Campaign's email content. Provide multiple items to send an A/X Split Campaign | |
Status | string (CampaignStatus) Default: "Deleted" Enum: "Deleted" "Active" "Processing" "Sending" "Completed" "Paused" "Cancelled" "Draft" |
object (CampaignOptions) Different send options for a Campaign |
Request samples
- Payload
{- "Content": [
- {
- "Poolname": "My Custom Pool",
- "From": "John Doe <email@domain.com>",
- "ReplyTo": "John Doe <email@domain.com>",
- "Subject": "Hello!",
- "TemplateName": "Template01",
- "AttachFiles": [
- "preuploaded.jpg"
], - "Utm": {
- "Source": "string",
- "Medium": "string",
- "Campaign": "string",
- "Content": "string"
}
}
], - "Name": "string",
- "Status": "Deleted",
- "Recipients": {
- "ListNames": [
- "string"
], - "SegmentNames": [
- "string"
]
}, - "Options": {
- "DeliveryOptimization": "None",
- "TrackOpens": "true",
- "TrackClicks": "true",
- "ScheduleFor": null,
- "TriggerFrequency": 0,
- "TriggerCount": 0,
- "SplitOptions": {
- "OptimizeFor": "Opens",
- "OptimizePeriodMinutes": "30"
}
}
}
Response samples
- 201
{- "Content": [
- {
- "Poolname": "My Custom Pool",
- "From": "John Doe <email@domain.com>",
- "ReplyTo": "John Doe <email@domain.com>",
- "Subject": "Hello!",
- "TemplateName": "Template01",
- "AttachFiles": [
- "preuploaded.jpg"
], - "Utm": {
- "Source": "string",
- "Medium": "string",
- "Campaign": "string",
- "Content": "string"
}
}
], - "Name": "string",
- "Status": "Deleted",
- "Recipients": {
- "ListNames": [
- "string"
], - "SegmentNames": [
- "string"
]
}, - "Options": {
- "DeliveryOptimization": "None",
- "TrackOpens": "true",
- "TrackClicks": "true",
- "ScheduleFor": null,
- "TriggerFrequency": 0,
- "TriggerCount": 0,
- "SplitOptions": {
- "OptimizeFor": "Opens",
- "OptimizePeriodMinutes": "30"
}
}
}
Load Campaign
Returns the specified campaign details. Required Access Level: ViewCampaigns
Authorizations:
path Parameters
name required | string <string> Name of Campaign to get |
Responses
Response Schema: application/json
Name required | string <string> Campaign name |
required | object (CampaignRecipient) A set of lists and segments names to read recipients from |
Array of objects (CampaignTemplate) [ items ] Campaign's email content. Provide multiple items to send an A/X Split Campaign | |
Status | string (CampaignStatus) Default: "Deleted" Enum: "Deleted" "Active" "Processing" "Sending" "Completed" "Paused" "Cancelled" "Draft" |
object (CampaignOptions) Different send options for a Campaign |
Response samples
- 200
{- "Content": [
- {
- "Poolname": "My Custom Pool",
- "From": "John Doe <email@domain.com>",
- "ReplyTo": "John Doe <email@domain.com>",
- "Subject": "Hello!",
- "TemplateName": "Template01",
- "AttachFiles": [
- "preuploaded.jpg"
], - "Utm": {
- "Source": "string",
- "Medium": "string",
- "Campaign": "string",
- "Content": "string"
}
}
], - "Name": "string",
- "Status": "Deleted",
- "Recipients": {
- "ListNames": [
- "string"
], - "SegmentNames": [
- "string"
]
}, - "Options": {
- "DeliveryOptimization": "None",
- "TrackOpens": "true",
- "TrackClicks": "true",
- "ScheduleFor": null,
- "TriggerFrequency": 0,
- "TriggerCount": 0,
- "SplitOptions": {
- "OptimizeFor": "Opens",
- "OptimizePeriodMinutes": "30"
}
}
}
Update Campaign
Updates a previously added campaign. Only Active and Paused campaigns can be updated. Required Access Level: ModifyCampaigns
Authorizations:
path Parameters
name required | string <string> Name of Campaign to update |
Request Body schema: application/json
JSON representation of a campaign
Name required | string <string> Campaign name |
required | object (CampaignRecipient) A set of lists and segments names to read recipients from |
Array of objects (CampaignTemplate) [ items ] Campaign's email content. Provide multiple items to send an A/X Split Campaign | |
Status | string (CampaignStatus) Default: "Deleted" Enum: "Deleted" "Active" "Processing" "Sending" "Completed" "Paused" "Cancelled" "Draft" |
object (CampaignOptions) Different send options for a Campaign |
Responses
Response Schema: application/json
Name required | string <string> Campaign name |
required | object (CampaignRecipient) A set of lists and segments names to read recipients from |
Array of objects (CampaignTemplate) [ items ] Campaign's email content. Provide multiple items to send an A/X Split Campaign | |
Status | string (CampaignStatus) Default: "Deleted" Enum: "Deleted" "Active" "Processing" "Sending" "Completed" "Paused" "Cancelled" "Draft" |
object (CampaignOptions) Different send options for a Campaign |
Request samples
- Payload
{- "Content": [
- {
- "Poolname": "My Custom Pool",
- "From": "John Doe <email@domain.com>",
- "ReplyTo": "John Doe <email@domain.com>",
- "Subject": "Hello!",
- "TemplateName": "Template01",
- "AttachFiles": [
- "preuploaded.jpg"
], - "Utm": {
- "Source": "string",
- "Medium": "string",
- "Campaign": "string",
- "Content": "string"
}
}
], - "Name": "string",
- "Status": "Deleted",
- "Recipients": {
- "ListNames": [
- "string"
], - "SegmentNames": [
- "string"
]
}, - "Options": {
- "DeliveryOptimization": "None",
- "TrackOpens": "true",
- "TrackClicks": "true",
- "ScheduleFor": null,
- "TriggerFrequency": 0,
- "TriggerCount": 0,
- "SplitOptions": {
- "OptimizeFor": "Opens",
- "OptimizePeriodMinutes": "30"
}
}
}
Response samples
- 200
{- "Content": [
- {
- "Poolname": "My Custom Pool",
- "From": "John Doe <email@domain.com>",
- "ReplyTo": "John Doe <email@domain.com>",
- "Subject": "Hello!",
- "TemplateName": "Template01",
- "AttachFiles": [
- "preuploaded.jpg"
], - "Utm": {
- "Source": "string",
- "Medium": "string",
- "Campaign": "string",
- "Content": "string"
}
}
], - "Name": "string",
- "Status": "Deleted",
- "Recipients": {
- "ListNames": [
- "string"
], - "SegmentNames": [
- "string"
]
}, - "Options": {
- "DeliveryOptimization": "None",
- "TrackOpens": "true",
- "TrackClicks": "true",
- "ScheduleFor": null,
- "TriggerFrequency": 0,
- "TriggerCount": 0,
- "SplitOptions": {
- "OptimizeFor": "Opens",
- "OptimizePeriodMinutes": "30"
}
}
}
Load Contacts
Returns a list of contacts. Required Access Level: ViewContacts
Authorizations:
query Parameters
limit | integer <int32> Default: "20" Example: limit=100 Maximum number of returned items. |
offset | integer <int32> Default: "0" Example: offset=20 How many items should be returned ahead. |
Responses
Response Schema: application/json
string <string> Proper email address. | |
Status | string (ContactStatus) Default: "Transactional" Enum: "Transactional" "Engaged" "Active" "Bounced" "Unsubscribed" "Abuse" "Inactive" "Stale" "NotConfirmed" |
FirstName | string <string> First name. |
LastName | string <string> Last name. |
object A key-value collection of custom contact fields which can be used in the system. | |
object (ConsentData) | |
Source | string (ContactSource) Default: "DeliveryApi" Enum: "DeliveryApi" "ManualInput" "FileUpload" "WebForm" "ContactApi" "VerificationApi" "FileVerificationApi" |
DateAdded | string <date-time> Date of creation in YYYY-MM-DDThh:ii:ss format |
DateUpdated | string or null <date-time> Last change date |
StatusChangeDate | string or null <date-time> Date of last status change. |
object (ContactActivity) |
Response samples
- 200
[- {
- "Email": "mail@example.com",
- "Status": "Transactional",
- "FirstName": "Fred",
- "LastName": "Flintstone",
- "CustomFields": {
- "city": "New York",
- "age": "34"
}, - "Consent": {
- "ConsentIP": "192.168.0.1",
- "ConsentDate": "1/1/2015 0:00:00 AM",
- "ConsentTracking": "Unknown"
}, - "Source": "DeliveryApi",
- "DateAdded": "2001-01-01T12:00:00",
- "DateUpdated": "2001-01-01T12:00:00",
- "StatusChangeDate": "2001-01-01T12:00:00",
- "Activity": {
- "TotalSent": "1000",
- "TotalOpened": "1000",
- "TotalClicked": "1000",
- "TotalFailed": "1000",
- "LastSent": null,
- "LastOpened": "2014-01-01",
- "LastClicked": null,
- "LastFailed": null,
- "LastIP": "string",
- "ErrorCode": null,
- "FriendlyErrorMessage": "string"
}
}
]
Add Contact
Add new Contacts to your Lists. Up to 1000 can be added (for more please refer to the import request). Required Access Level: ModifyContacts
Authorizations:
query Parameters
listnames | Array of strings <string> Names of lists to which the uploaded contacts should be added to |
Request Body schema: application/json
Email required | string <string> Proper email address. |
Status | string (ContactStatus) Default: "Transactional" Enum: "Transactional" "Engaged" "Active" "Bounced" "Unsubscribed" "Abuse" "Inactive" "Stale" "NotConfirmed" |
FirstName | string <string> First name. |
LastName | string <string> Last name. |
object A key-value collection of custom contact fields which can be used in the system. Only already existing custom fields will be saved. | |
object (ConsentData) |
Responses
Response Schema: application/json
string <string> Proper email address. | |
Status | string (ContactStatus) Default: "Transactional" Enum: "Transactional" "Engaged" "Active" "Bounced" "Unsubscribed" "Abuse" "Inactive" "Stale" "NotConfirmed" |
FirstName | string <string> First name. |
LastName | string <string> Last name. |
object A key-value collection of custom contact fields which can be used in the system. | |
object (ConsentData) | |
Source | string (ContactSource) Default: "DeliveryApi" Enum: "DeliveryApi" "ManualInput" "FileUpload" "WebForm" "ContactApi" "VerificationApi" "FileVerificationApi" |
DateAdded | string <date-time> Date of creation in YYYY-MM-DDThh:ii:ss format |
DateUpdated | string or null <date-time> Last change date |
StatusChangeDate | string or null <date-time> Date of last status change. |
object (ContactActivity) |
Request samples
- Payload
[- {
- "Email": "mail@example.com",
- "Status": "Transactional",
- "FirstName": "Fred",
- "LastName": "Flintstone",
- "CustomFields": {
- "city": "New York",
- "age": "34"
}, - "Consent": {
- "ConsentIP": "192.168.0.1",
- "ConsentDate": "1/1/2015 0:00:00 AM",
- "ConsentTracking": "Unknown"
}
}
]
Response samples
- 200
[- {
- "Email": "mail@example.com",
- "Status": "Transactional",
- "FirstName": "Fred",
- "LastName": "Flintstone",
- "CustomFields": {
- "city": "New York",
- "age": "34"
}, - "Consent": {
- "ConsentIP": "192.168.0.1",
- "ConsentDate": "1/1/2015 0:00:00 AM",
- "ConsentTracking": "Unknown"
}, - "Source": "DeliveryApi",
- "DateAdded": "2001-01-01T12:00:00",
- "DateUpdated": "2001-01-01T12:00:00",
- "StatusChangeDate": "2001-01-01T12:00:00",
- "Activity": {
- "TotalSent": "1000",
- "TotalOpened": "1000",
- "TotalClicked": "1000",
- "TotalFailed": "1000",
- "LastSent": null,
- "LastOpened": "2014-01-01",
- "LastClicked": null,
- "LastFailed": null,
- "LastIP": "string",
- "ErrorCode": null,
- "FriendlyErrorMessage": "string"
}
}
]
Load Contact
Load detailed contact information for specified email. Required Access Level: ViewContacts
Authorizations:
path Parameters
email required | string <string> Example: mail@example.com Proper email address. |
Responses
Response Schema: application/json
string <string> Proper email address. | |
Status | string (ContactStatus) Default: "Transactional" Enum: "Transactional" "Engaged" "Active" "Bounced" "Unsubscribed" "Abuse" "Inactive" "Stale" "NotConfirmed" |
FirstName | string <string> First name. |
LastName | string <string> Last name. |
object A key-value collection of custom contact fields which can be used in the system. | |
object (ConsentData) | |
Source | string (ContactSource) Default: "DeliveryApi" Enum: "DeliveryApi" "ManualInput" "FileUpload" "WebForm" "ContactApi" "VerificationApi" "FileVerificationApi" |
DateAdded | string <date-time> Date of creation in YYYY-MM-DDThh:ii:ss format |
DateUpdated | string or null <date-time> Last change date |
StatusChangeDate | string or null <date-time> Date of last status change. |
object (ContactActivity) |
Response samples
- 200
{- "Email": "mail@example.com",
- "Status": "Transactional",
- "FirstName": "Fred",
- "LastName": "Flintstone",
- "CustomFields": {
- "city": "New York",
- "age": "34"
}, - "Consent": {
- "ConsentIP": "192.168.0.1",
- "ConsentDate": "1/1/2015 0:00:00 AM",
- "ConsentTracking": "Unknown"
}, - "Source": "DeliveryApi",
- "DateAdded": "2001-01-01T12:00:00",
- "DateUpdated": "2001-01-01T12:00:00",
- "StatusChangeDate": "2001-01-01T12:00:00",
- "Activity": {
- "TotalSent": "1000",
- "TotalOpened": "1000",
- "TotalClicked": "1000",
- "TotalFailed": "1000",
- "LastSent": null,
- "LastOpened": "2014-01-01",
- "LastClicked": null,
- "LastFailed": null,
- "LastIP": "string",
- "ErrorCode": null,
- "FriendlyErrorMessage": "string"
}
}
Update Contact
Update selected contact. Omitted contact's fields will not be changed. Required Access Level: ModifyContacts
Authorizations:
path Parameters
email required | string <string> Example: mail@example.com Proper email address. |
Request Body schema: application/json
FirstName | string <string> First name. |
LastName | string <string> Last name. |
object A key-value collection of custom contact fields which can be used in the system. |
Responses
Response Schema: application/json
string <string> Proper email address. | |
Status | string (ContactStatus) Default: "Transactional" Enum: "Transactional" "Engaged" "Active" "Bounced" "Unsubscribed" "Abuse" "Inactive" "Stale" "NotConfirmed" |
FirstName | string <string> First name. |
LastName | string <string> Last name. |
object A key-value collection of custom contact fields which can be used in the system. | |
object (ConsentData) | |
Source | string (ContactSource) Default: "DeliveryApi" Enum: "DeliveryApi" "ManualInput" "FileUpload" "WebForm" "ContactApi" "VerificationApi" "FileVerificationApi" |
DateAdded | string <date-time> Date of creation in YYYY-MM-DDThh:ii:ss format |
DateUpdated | string or null <date-time> Last change date |
StatusChangeDate | string or null <date-time> Date of last status change. |
object (ContactActivity) |
Request samples
- Payload
{- "FirstName": "Fred",
- "LastName": "Flintstone",
- "CustomFields": {
- "city": "New York",
- "age": "34"
}
}
Response samples
- 200
{- "Email": "mail@example.com",
- "Status": "Transactional",
- "FirstName": "Fred",
- "LastName": "Flintstone",
- "CustomFields": {
- "city": "New York",
- "age": "34"
}, - "Consent": {
- "ConsentIP": "192.168.0.1",
- "ConsentDate": "1/1/2015 0:00:00 AM",
- "ConsentTracking": "Unknown"
}, - "Source": "DeliveryApi",
- "DateAdded": "2001-01-01T12:00:00",
- "DateUpdated": "2001-01-01T12:00:00",
- "StatusChangeDate": "2001-01-01T12:00:00",
- "Activity": {
- "TotalSent": "1000",
- "TotalOpened": "1000",
- "TotalClicked": "1000",
- "TotalFailed": "1000",
- "LastSent": null,
- "LastOpened": "2014-01-01",
- "LastClicked": null,
- "LastFailed": null,
- "LastIP": "string",
- "ErrorCode": null,
- "FriendlyErrorMessage": "string"
}
}
Delete Contacts Bulk
Deletes provided contacts in bulk. Required Access Level: ModifyContacts
Authorizations:
Request Body schema: application/json
Provide either rule or a list of emails, not both.
Rule | string <string> SQL-like rule. Sending 'All' as a value loads all resources of the given type. Help for building a segment rule can be found here: https://help.elasticemail.com/en/articles/5162182-segment-rules |
Emails | Array of strings <string> Comma delimited list of contact emails |
Responses
Request samples
- Payload
{- "Rule": "string",
- "Emails": [
- "john.doe@sample.com"
]
}
Export Contacts
Request an Export of specified Contacts. Required Access Level: Export
Authorizations:
query Parameters
fileFormat | string (ExportFileFormats) Default: "Csv" Enum: "Csv" "Xml" "Json" Format of the exported file |
rule | string <string> Example: rule=Status%20=%20Engaged Query used for filtering. |
emails | Array of strings <string> Example: emails=mail@contact.com,mail1@contact.com,mail2@contact.com Comma delimited list of contact emails |
compressionFormat | string (CompressionFormat) Default: "None" Enum: "None" "Zip" FileResponse compression format. None or Zip. |
fileName | string <string> Example: fileName=filename.txt Name of your file including extension. |
Responses
Response Schema: application/json
Link | string <string> Direct URL to the exported file |
PublicExportID | string <guid> ID of the exported file |
Response samples
- 202
{- "Link": "string",
- "PublicExportID": "E33EBA7A-C20D-4D3D-8F2F-5EEF42F58E6F"
}
Check Export Status
Check the current status of the export. Required Access Level: Export
Authorizations:
path Parameters
id required | string <guid> Example: E33EBA7A-C20D-4D3D-8F2F-5EEF42F58E6F ID of the exported file |
Responses
Response Schema: application/json
Current status of the export.
Response samples
- 200
"Error"
Upload Contacts
Upload contacts from a file. Required Access Level: ModifyContacts
Authorizations:
query Parameters
listName | string <string> Name of an existing list to add these contacts to |
encodingName | string <string> In what encoding the file is uploaded |
fileUrl | string <string> Optional url of csv to import |
Request Body schema: multipart/form-data
File in CSV format with columns to upload as Contact fields. Required columns: Email. Suggested columns: AllowUnsubscribe, Status, ConsentDate, ConsentIP, ConsentTracking.
file | string <binary> |
Responses
Load Domains
Returns a list of all domains configured for this Account. Required Access Level: ViewSettings
Authorizations:
Responses
Response Schema: application/json
Domain | string <string> Name of selected domain. |
DefaultDomain | boolean <boolean> True, if domain is used as default. Otherwise, false, |
Spf | boolean <boolean> True, if SPF record is verified |
Dkim | boolean <boolean> True, if DKIM record is verified |
MX | boolean <boolean> True, if MX record is verified |
DMARC | boolean <boolean> |
IsRewriteDomainValid | boolean <boolean> True, if tracking CNAME record is verified |
Verify | boolean <boolean> True, if DKIM, SPF, or tracking are still to be verified |
Type | string (TrackingType) Default: "None" Enum: "None" "Delete" "Http" "ExternalHttps" "InternalCertHttps" "LetsEncryptCert" HTTP or HTTPS Protocal used for link tracking. |
TrackingStatus | string (TrackingValidationStatus) Default: "Validated" Enum: "Validated" "NotValidated" "Invalid" "Broken" Status of ValidDomain to determine how often tracking validation should be performed. |
CertificateStatus | string (CertificateValidationStatus) Default: "ErrorOccured" Enum: "ErrorOccured" "CertNotSet" "Valid" "NotValid" |
CertificateValidationError | string <string> |
TrackingTypeUserRequest | string (TrackingType) Default: "None" Enum: "None" "Delete" "Http" "ExternalHttps" "InternalCertHttps" "LetsEncryptCert" HTTP or HTTPS Protocal used for link tracking. |
VERP | boolean <boolean> |
CustomBouncesDomain | string <string> |
IsCustomBouncesDomainDefault | boolean <boolean> |
IsMarkedForDeletion | boolean <boolean> |
Ownership | string (DomainOwner) Default: "Current" Enum: "Current" "Parent" |
Response samples
- 200
[- {
- "Domain": "example.com",
- "DefaultDomain": true,
- "Spf": "true",
- "Dkim": "true",
- "MX": "true",
- "DMARC": true,
- "IsRewriteDomainValid": "true",
- "Verify": "true",
- "Type": "None",
- "TrackingStatus": "Validated",
- "CertificateStatus": "ErrorOccured",
- "CertificateValidationError": "string",
- "TrackingTypeUserRequest": "None",
- "VERP": true,
- "CustomBouncesDomain": "string",
- "IsCustomBouncesDomainDefault": true,
- "IsMarkedForDeletion": true,
- "Ownership": "Current"
}
]
Add Domain
Add new domain to Account. Required Access Level: ModifySettings
Authorizations:
Request Body schema: application/json
Domain to add
Domain | string <string> Name of selected domain. |
SetAsDefault | boolean <boolean> |
Responses
Response Schema: application/json
Domain | string <string> Name of selected domain. |
DefaultDomain | boolean <boolean> True, if domain is used as default. Otherwise, false, |
Spf | boolean <boolean> True, if SPF record is verified |
Dkim | boolean <boolean> True, if DKIM record is verified |
MX | boolean <boolean> True, if MX record is verified |
DMARC | boolean <boolean> |
IsRewriteDomainValid | boolean <boolean> True, if tracking CNAME record is verified |
Verify | boolean <boolean> True, if DKIM, SPF, or tracking are still to be verified |
Type | string (TrackingType) Default: "None" Enum: "None" "Delete" "Http" "ExternalHttps" "InternalCertHttps" "LetsEncryptCert" HTTP or HTTPS Protocal used for link tracking. |
TrackingStatus | string (TrackingValidationStatus) Default: "Validated" Enum: "Validated" "NotValidated" "Invalid" "Broken" Status of ValidDomain to determine how often tracking validation should be performed. |
CertificateStatus | string (CertificateValidationStatus) Default: "ErrorOccured" Enum: "ErrorOccured" "CertNotSet" "Valid" "NotValid" |
CertificateValidationError | string <string> |
TrackingTypeUserRequest | string (TrackingType) Default: "None" Enum: "None" "Delete" "Http" "ExternalHttps" "InternalCertHttps" "LetsEncryptCert" HTTP or HTTPS Protocal used for link tracking. |
VERP | boolean <boolean> |
CustomBouncesDomain | string <string> |
IsCustomBouncesDomainDefault | boolean <boolean> |
IsMarkedForDeletion | boolean <boolean> |
Ownership | string (DomainOwner) Default: "Current" Enum: "Current" "Parent" |
Request samples
- Payload
{- "Domain": "example.com",
- "SetAsDefault": true
}
Response samples
- 201
{- "Domain": "example.com",
- "DefaultDomain": true,
- "Spf": "true",
- "Dkim": "true",
- "MX": "true",
- "DMARC": true,
- "IsRewriteDomainValid": "true",
- "Verify": "true",
- "Type": "None",
- "TrackingStatus": "Validated",
- "CertificateStatus": "ErrorOccured",
- "CertificateValidationError": "string",
- "TrackingTypeUserRequest": "None",
- "VERP": true,
- "CustomBouncesDomain": "string",
- "IsCustomBouncesDomainDefault": true,
- "IsMarkedForDeletion": true,
- "Ownership": "Current"
}
Load Domain
Retrieve a domain configured for this Account. Required Access Level: ViewSettings
Authorizations:
path Parameters
domain required | string <string> Name of the given domain |
Responses
Response Schema: application/json
ValidationLog | string <string> Domain validation results - when domain has been running through validation process |
Domain | string <string> Name of selected domain. |
DefaultDomain | boolean <boolean> True, if domain is used as default. Otherwise, false, |
Spf | boolean <boolean> True, if SPF record is verified |
Dkim | boolean <boolean> True, if DKIM record is verified |
MX | boolean <boolean> True, if MX record is verified |
DMARC | boolean <boolean> |
IsRewriteDomainValid | boolean <boolean> True, if tracking CNAME record is verified |
Verify | boolean <boolean> True, if DKIM, SPF, or tracking are still to be verified |
Type | string (TrackingType) Default: "None" Enum: "None" "Delete" "Http" "ExternalHttps" "InternalCertHttps" "LetsEncryptCert" HTTP or HTTPS Protocal used for link tracking. |
TrackingStatus | string (TrackingValidationStatus) Default: "Validated" Enum: "Validated" "NotValidated" "Invalid" "Broken" Status of ValidDomain to determine how often tracking validation should be performed. |
CertificateStatus | string (CertificateValidationStatus) Default: "ErrorOccured" Enum: "ErrorOccured" "CertNotSet" "Valid" "NotValid" |
CertificateValidationError | string <string> |
TrackingTypeUserRequest | string (TrackingType) Default: "None" Enum: "None" "Delete" "Http" "ExternalHttps" "InternalCertHttps" "LetsEncryptCert" HTTP or HTTPS Protocal used for link tracking. |
VERP | boolean <boolean> |
CustomBouncesDomain | string <string> |
IsCustomBouncesDomainDefault | boolean <boolean> |
IsMarkedForDeletion | boolean <boolean> |
Ownership | string (DomainOwner) Default: "Current" Enum: "Current" "Parent" |
Response samples
- 200
{- "ValidationLog": "string",
- "Domain": "example.com",
- "DefaultDomain": true,
- "Spf": "true",
- "Dkim": "true",
- "MX": "true",
- "DMARC": true,
- "IsRewriteDomainValid": "true",
- "Verify": "true",
- "Type": "None",
- "TrackingStatus": "Validated",
- "CertificateStatus": "ErrorOccured",
- "CertificateValidationError": "string",
- "TrackingTypeUserRequest": "None",
- "VERP": true,
- "CustomBouncesDomain": "string",
- "IsCustomBouncesDomainDefault": true,
- "IsMarkedForDeletion": true,
- "Ownership": "Current"
}
Update Domain
Updates the specified domain. Required Access Level: ModifySettings
Authorizations:
path Parameters
domain required | string <string> Name of the given domain |
Request Body schema: application/json
Updated Domain resource
CertificateStatus | string (CertificateValidationStatus) Default: "ErrorOccured" Enum: "ErrorOccured" "CertNotSet" "Valid" "NotValid" |
VERP | boolean <boolean> |
CustomBouncesDomain | string <string> |
IsCustomBouncesDomainDefault | boolean <boolean> |
Responses
Response Schema: application/json
Domain | string <string> Name of selected domain. |
DefaultDomain | boolean <boolean> True, if domain is used as default. Otherwise, false, |
Spf | boolean <boolean> True, if SPF record is verified |
Dkim | boolean <boolean> True, if DKIM record is verified |
MX | boolean <boolean> True, if MX record is verified |
DMARC | boolean <boolean> |
IsRewriteDomainValid | boolean <boolean> True, if tracking CNAME record is verified |
Verify | boolean <boolean> True, if DKIM, SPF, or tracking are still to be verified |
Type | string (TrackingType) Default: "None" Enum: "None" "Delete" "Http" "ExternalHttps" "InternalCertHttps" "LetsEncryptCert" HTTP or HTTPS Protocal used for link tracking. |
TrackingStatus | string (TrackingValidationStatus) Default: "Validated" Enum: "Validated" "NotValidated" "Invalid" "Broken" Status of ValidDomain to determine how often tracking validation should be performed. |
CertificateStatus | string (CertificateValidationStatus) Default: "ErrorOccured" Enum: "ErrorOccured" "CertNotSet" "Valid" "NotValid" |
CertificateValidationError | string <string> |
TrackingTypeUserRequest | string (TrackingType) Default: "None" Enum: "None" "Delete" "Http" "ExternalHttps" "InternalCertHttps" "LetsEncryptCert" HTTP or HTTPS Protocal used for link tracking. |
VERP | boolean <boolean> |
CustomBouncesDomain | string <string> |
IsCustomBouncesDomainDefault | boolean <boolean> |
IsMarkedForDeletion | boolean <boolean> |
Ownership | string (DomainOwner) Default: "Current" Enum: "Current" "Parent" |
Request samples
- Payload
{- "CertificateStatus": "ErrorOccured",
- "VERP": true,
- "CustomBouncesDomain": "string",
- "IsCustomBouncesDomainDefault": true
}
Response samples
- 200
{- "Domain": "example.com",
- "DefaultDomain": true,
- "Spf": "true",
- "Dkim": "true",
- "MX": "true",
- "DMARC": true,
- "IsRewriteDomainValid": "true",
- "Verify": "true",
- "Type": "None",
- "TrackingStatus": "Validated",
- "CertificateStatus": "ErrorOccured",
- "CertificateValidationError": "string",
- "TrackingTypeUserRequest": "None",
- "VERP": true,
- "CustomBouncesDomain": "string",
- "IsCustomBouncesDomainDefault": true,
- "IsMarkedForDeletion": true,
- "Ownership": "Current"
}
Check for domain restriction
Checking if domain is from free provider, or restricted. Required Access Level: ViewSettings
Authorizations:
path Parameters
domain required | string <string> Name of the given domain |
Responses
Response Schema: application/json
Response samples
- 200
true
Verify Domain
Verifies that required DNS records exist for specified domain. Required Access Level: ModifySettings
Authorizations:
path Parameters
domain required | string <string> Name of the given domain |
Request Body schema: application/json
Tracking type used in the Tracking verification
Responses
Response Schema: application/json
ValidationLog | string <string> Domain validation results - when domain has been running through validation process |
Domain | string <string> Name of selected domain. |
DefaultDomain | boolean <boolean> True, if domain is used as default. Otherwise, false, |
Spf | boolean <boolean> True, if SPF record is verified |
Dkim | boolean <boolean> True, if DKIM record is verified |
MX | boolean <boolean> True, if MX record is verified |
DMARC | boolean <boolean> |
IsRewriteDomainValid | boolean <boolean> True, if tracking CNAME record is verified |
Verify | boolean <boolean> True, if DKIM, SPF, or tracking are still to be verified |
Type | string (TrackingType) Default: "None" Enum: "None" "Delete" "Http" "ExternalHttps" "InternalCertHttps" "LetsEncryptCert" HTTP or HTTPS Protocal used for link tracking. |
TrackingStatus | string (TrackingValidationStatus) Default: "Validated" Enum: "Validated" "NotValidated" "Invalid" "Broken" Status of ValidDomain to determine how often tracking validation should be performed. |
CertificateStatus | string (CertificateValidationStatus) Default: "ErrorOccured" Enum: "ErrorOccured" "CertNotSet" "Valid" "NotValid" |
CertificateValidationError | string <string> |
TrackingTypeUserRequest | string (TrackingType) Default: "None" Enum: "None" "Delete" "Http" "ExternalHttps" "InternalCertHttps" "LetsEncryptCert" HTTP or HTTPS Protocal used for link tracking. |
VERP | boolean <boolean> |
CustomBouncesDomain | string <string> |
IsCustomBouncesDomainDefault | boolean <boolean> |
IsMarkedForDeletion | boolean <boolean> |
Ownership | string (DomainOwner) Default: "Current" Enum: "Current" "Parent" |
Request samples
- Payload
"None"
Response samples
- 200
{- "ValidationLog": "string",
- "Domain": "example.com",
- "DefaultDomain": true,
- "Spf": "true",
- "Dkim": "true",
- "MX": "true",
- "DMARC": true,
- "IsRewriteDomainValid": "true",
- "Verify": "true",
- "Type": "None",
- "TrackingStatus": "Validated",
- "CertificateStatus": "ErrorOccured",
- "CertificateValidationError": "string",
- "TrackingTypeUserRequest": "None",
- "VERP": true,
- "CustomBouncesDomain": "string",
- "IsCustomBouncesDomainDefault": true,
- "IsMarkedForDeletion": true,
- "Ownership": "Current"
}
Set Default
Sets a verified email address as default sender. Required Access Level: ModifySettings
Authorizations:
path Parameters
email required | string <string> Default email sender, example: mail@yourdomain.com |
Responses
Response Schema: application/json
Domain | string <string> Name of selected domain. |
DefaultDomain | boolean <boolean> True, if domain is used as default. Otherwise, false, |
Spf | boolean <boolean> True, if SPF record is verified |
Dkim | boolean <boolean> True, if DKIM record is verified |
MX | boolean <boolean> True, if MX record is verified |
DMARC | boolean <boolean> |
IsRewriteDomainValid | boolean <boolean> True, if tracking CNAME record is verified |
Verify | boolean <boolean> True, if DKIM, SPF, or tracking are still to be verified |
Type | string (TrackingType) Default: "None" Enum: "None" "Delete" "Http" "ExternalHttps" "InternalCertHttps" "LetsEncryptCert" HTTP or HTTPS Protocal used for link tracking. |
TrackingStatus | string (TrackingValidationStatus) Default: "Validated" Enum: "Validated" "NotValidated" "Invalid" "Broken" Status of ValidDomain to determine how often tracking validation should be performed. |
CertificateStatus | string (CertificateValidationStatus) Default: "ErrorOccured" Enum: "ErrorOccured" "CertNotSet" "Valid" "NotValid" |
CertificateValidationError | string <string> |
TrackingTypeUserRequest | string (TrackingType) Default: "None" Enum: "None" "Delete" "Http" "ExternalHttps" "InternalCertHttps" "LetsEncryptCert" HTTP or HTTPS Protocal used for link tracking. |
VERP | boolean <boolean> |
CustomBouncesDomain | string <string> |
IsCustomBouncesDomainDefault | boolean <boolean> |
IsMarkedForDeletion | boolean <boolean> |
Ownership | string (DomainOwner) Default: "Current" Enum: "Current" "Parent" |
Response samples
- 200
{- "Domain": "example.com",
- "DefaultDomain": true,
- "Spf": "true",
- "Dkim": "true",
- "MX": "true",
- "DMARC": true,
- "IsRewriteDomainValid": "true",
- "Verify": "true",
- "Type": "None",
- "TrackingStatus": "Validated",
- "CertificateStatus": "ErrorOccured",
- "CertificateValidationError": "string",
- "TrackingTypeUserRequest": "None",
- "VERP": true,
- "CustomBouncesDomain": "string",
- "IsCustomBouncesDomainDefault": true,
- "IsMarkedForDeletion": true,
- "Ownership": "Current"
}
Send Bulk Emails
Send bulk merge email. Required Access Level: SendHttp
Authorizations:
Request Body schema: application/json
Email data
required | Array of objects (EmailRecipient) [ items ] List of recipients |
required | object (EmailContent) Proper e-mail content |
object (Options) E-mail configuration |
Responses
Response Schema: application/json
TransactionID | string <string> ID number of transaction |
MessageID | string <string> Unique identifier for this email. |
Request samples
- Payload
{- "Recipients": [
- {
- "Email": "mail@example.com",
- "Fields": {
- "city": "New York",
- "age": "34"
}
}
], - "Content": {
- "Body": [
- {
- "ContentType": "HTML",
- "Content": "string",
- "Charset": "string"
}
], - "Merge": {
- "city": "New York",
- "age": "34"
}, - "Attachments": [
- {
- "BinaryContent": "string",
- "Name": "string",
- "ContentType": "string",
- "Size": "100"
}
], - "Headers": {
- "city": "New York",
- "age": "34"
}, - "Postback": "string",
- "EnvelopeFrom": "John Doe <email@domain.com>",
- "From": "John Doe <email@domain.com>",
- "ReplyTo": "John Doe <email@domain.com>",
- "Subject": "Hello!",
- "TemplateName": "Template01",
- "AttachFiles": [
- "preuploaded.jpg"
], - "Utm": {
- "Source": "string",
- "Medium": "string",
- "Campaign": "string",
- "Content": "string"
}
}, - "Options": {
- "TimeOffset": null,
- "PoolName": "My Custom Pool",
- "ChannelName": "Channel01",
- "Encoding": "UserProvided",
- "TrackOpens": "true",
- "TrackClicks": "true"
}
}
Response samples
- 200
{- "TransactionID": "TransactionID",
- "MessageID": "-HHGPM_9RPhSMiaJq_ab4g3"
}
View Email
Returns email details for viewing or rendering. Required Access Level: None
Authorizations:
path Parameters
msgid required | string <string> Message identifier |
Responses
Response Schema: application/json
object (EmailView) Email details formatted in json | |
Array of objects (FileInfo) [ items ] Attachments sent with the email | |
object (EmailStatus) Status information of the specified email |
Response samples
- 200
{- "Preview": {
- "Body": "string",
- "Subject": "Hello!",
- "From": "string"
}, - "Attachments": [
- {
- "FileName": "filename.txt",
- "Size": "100",
- "DateAdded": "2001-01-01T12:00:00",
- "ExpirationDate": null,
- "ContentType": "image/jpeg"
}
], - "Status": {
- "From": "string",
- "To": "string",
- "Date": "2019-08-24T14:15:22Z",
- "Status": "All",
- "StatusName": "string",
- "StatusChangeDate": "2001-01-01T12:00:00",
- "DateSent": "2001-01-01T12:00:00",
- "DateOpened": "2001-01-01T12:00:00",
- "DateClicked": "2001-01-01T12:00:00",
- "ErrorMessage": "string",
- "TransactionID": "TransactionID",
- "EnvelopeFrom": "string",
- "ErrorCategory": "Unknown"
}
}
Get Status
Get status details of an email transaction. Required Access Level: ViewReports
Authorizations:
path Parameters
transactionid required | string <string> Transaction identifier |
query Parameters
showFailed | boolean <boolean> Default: "False" Include Bounced email addresses. |
showSent | boolean <boolean> Default: "False" Include Sent email addresses. |
showDelivered | boolean <boolean> Default: "False" Include all delivered email addresses. |
showPending | boolean <boolean> Default: "False" Include Ready to send email addresses. |
showOpened | boolean <boolean> Default: "False" Include Opened email addresses. |
showClicked | boolean <boolean> Default: "False" Include Clicked email addresses. |
showAbuse | boolean <boolean> Default: "False" Include Reported as abuse email addresses. |
showUnsubscribed | boolean <boolean> Default: "False" Include Unsubscribed email addresses. |
showErrors | boolean <boolean> Default: "False" Include error messages for bounced emails. |
showMessageIDs | boolean <boolean> Default: "False" Include all MessageIDs for this transaction |
Responses
Response Schema: application/json
ID | string <string> ID number of your attachment |
Status | string <string> Name of status: submitted, complete, in_progress |
RecipientsCount | integer <int32> |
Array of objects (EmailJobFailedStatus) [ items ] | |
FailedCount | integer <int32> Total emails failed. |
Sent | Array of strings <string> |
SentCount | integer <int32> Total emails sent. |
Delivered | Array of strings <string> Number of delivered messages |
DeliveredCount | integer <int32> |
Pending | Array of strings <string> |
PendingCount | integer <int32> |
Opened | Array of strings <string> Number of opened messages |
OpenedCount | integer <int32> Total emails opened. |
Clicked | Array of strings <string> Number of clicked messages |
ClickedCount | integer <int32> Total emails clicked |
Unsubscribed | Array of strings <string> Number of unsubscribed messages |
UnsubscribedCount | integer <int32> Total emails unsubscribed |
AbuseReports | Array of strings <string> |
AbuseReportsCount | integer <int32> |
MessageIDs | Array of strings <string> List of all MessageIDs for this job. |
Response samples
- 200
{- "ID": "123456",
- "Status": "string",
- "RecipientsCount": 0,
- "Failed": [
- {
- "Address": "string",
- "Error": "string",
- "ErrorCode": "550",
- "Category": "string"
}
], - "FailedCount": "1000",
- "Sent": [
- "string"
], - "SentCount": "1000",
- "Delivered": [
- "1000"
], - "DeliveredCount": 0,
- "Pending": [
- "string"
], - "PendingCount": 0,
- "Opened": [
- "1000"
], - "OpenedCount": "1000",
- "Clicked": [
- "1000"
], - "ClickedCount": "1000",
- "Unsubscribed": [
- "1000"
], - "UnsubscribedCount": "1000",
- "AbuseReports": [
- "string"
], - "AbuseReportsCount": 0,
- "MessageIDs": [
- "string"
]
}
Send Bulk Emails CSV
Send to a list of contacts submitted in a CSV data file. The first column in the CSV must be the email address and the CSV must contain a header row. Additional fields can be included with a named header row and can be merged with the template using {merge} tags in the content.
Example CSV:
email, firstname, lastname
test1@gmail.com, michael, smith
test2@gmail.com, janet, smith
Merge file must not be empty. Required Access Level: SendHttp
Authorizations:
Request Body schema: application/json
Email data
required | object (MessageAttachment) |
required | object (EmailContent) Proper e-mail content |
object (Options) E-mail configuration |
Responses
Response Schema: application/json
TransactionID | string <string> ID number of transaction |
MessageID | string <string> Unique identifier for this email. |
Request samples
- Payload
{- "MergeFile": {
- "BinaryContent": "string",
- "Name": "string",
- "ContentType": "string",
- "Size": "100"
}, - "Content": {
- "Body": [
- {
- "ContentType": "HTML",
- "Content": "string",
- "Charset": "string"
}
], - "Merge": {
- "city": "New York",
- "age": "34"
}, - "Attachments": [
- {
- "BinaryContent": "string",
- "Name": "string",
- "ContentType": "string",
- "Size": "100"
}
], - "Headers": {
- "city": "New York",
- "age": "34"
}, - "Postback": "string",
- "EnvelopeFrom": "John Doe <email@domain.com>",
- "From": "John Doe <email@domain.com>",
- "ReplyTo": "John Doe <email@domain.com>",
- "Subject": "Hello!",
- "TemplateName": "Template01",
- "AttachFiles": [
- "preuploaded.jpg"
], - "Utm": {
- "Source": "string",
- "Medium": "string",
- "Campaign": "string",
- "Content": "string"
}
}, - "Options": {
- "TimeOffset": null,
- "PoolName": "My Custom Pool",
- "ChannelName": "Channel01",
- "Encoding": "UserProvided",
- "TrackOpens": "true",
- "TrackClicks": "true"
}
}
Response samples
- 200
{- "TransactionID": "TransactionID",
- "MessageID": "-HHGPM_9RPhSMiaJq_ab4g3"
}
Send Transactional Email
Send transactional emails (recipients will be known to each other). Required Access Level: SendHttp
Authorizations:
Request Body schema: application/json
Email data
required | object (TransactionalRecipient) List of transactional recipients |
required | object (EmailContent) Proper e-mail content |
object (Options) E-mail configuration |
Responses
Response Schema: application/json
TransactionID | string <string> ID number of transaction |
MessageID | string <string> Unique identifier for this email. |
Request samples
- Payload
{- "Recipients": {
- "To": [
- "string"
], - "CC": [
- "string"
], - "BCC": [
- "string"
]
}, - "Content": {
- "Body": [
- {
- "ContentType": "HTML",
- "Content": "string",
- "Charset": "string"
}
], - "Merge": {
- "city": "New York",
- "age": "34"
}, - "Attachments": [
- {
- "BinaryContent": "string",
- "Name": "string",
- "ContentType": "string",
- "Size": "100"
}
], - "Headers": {
- "city": "New York",
- "age": "34"
}, - "Postback": "string",
- "EnvelopeFrom": "John Doe <email@domain.com>",
- "From": "John Doe <email@domain.com>",
- "ReplyTo": "John Doe <email@domain.com>",
- "Subject": "Hello!",
- "TemplateName": "Template01",
- "AttachFiles": [
- "preuploaded.jpg"
], - "Utm": {
- "Source": "string",
- "Medium": "string",
- "Campaign": "string",
- "Content": "string"
}
}, - "Options": {
- "TimeOffset": null,
- "PoolName": "My Custom Pool",
- "ChannelName": "Channel01",
- "Encoding": "UserProvided",
- "TrackOpens": "true",
- "TrackClicks": "true"
}
}
Response samples
- 200
{- "TransactionID": "TransactionID",
- "MessageID": "-HHGPM_9RPhSMiaJq_ab4g3"
}
Load Events
Returns a log of delivery events filtered by specified parameters. Required Access Level: ViewReports
Authorizations:
query Parameters
eventTypes | Array of strings (EventType) Items Enum: "Submission" "FailedAttempt" "Bounce" "Sent" "Open" "Click" "Unsubscribe" "Complaint" Types of Events to return |
from | string or null <date-time> Example: from=2001-01-01T01:01:01 Starting date for search in YYYY-MM-DDThh:mm:ss format. |
to | string or null <date-time> Example: to=2001-01-01T01:01:01 Ending date for search in YYYY-MM-DDThh:mm:ss format. |
orderBy | string (EventsOrderBy) Default: "DateDescending" Enum: "DateDescending" "DateAscending" |
limit | integer <int32> Default: "0" How many items to load. Maximum for this request is 1000 items |
offset | integer <int32> Default: "0" Example: offset=20 How many items should be returned ahead. |
Responses
Response Schema: application/json
TransactionID | string <string> ID number of transaction |
MsgID | string <string> ID number of selected message. |
FromEmail | string <string> Default From: email address. |
To | string <string> Ending date for search in YYYY-MM-DDThh:mm:ss format. |
Subject | string <string> Default subject of email. |
EventType | string (EventType) Default: "Submission" Enum: "Submission" "FailedAttempt" "Bounce" "Sent" "Open" "Click" "Unsubscribe" "Complaint" Type of event |
EventDate | string <date-time> Creation date |
ChannelName | string <string> Name of selected channel. |
MessageCategory | string (MessageCategory) Default: "Unknown" Enum: "Unknown" "Ignore" "Spam" "BlackListed" "NoMailbox" "GreyListed" "Throttled" "Timeout" "ConnectionProblem" "SPFProblem" "AccountProblem" "DNSProblem" "NotDeliveredCancelled" "CodeError" "ManualCancel" "ConnectionTerminated" "NotDelivered" |
NextTryOn | string or null <date-time> Date of next try |
Message | string <string> Content of message, HTML encoded |
IPAddress | string <string> IP which this email was sent through |
PoolName | string <string> Name of an IP pool this email was sent through |
Response samples
- 200
[- {
- "TransactionID": "TransactionID",
- "MsgID": "ABCDE_9RPhSWiaJq_ab1g1",
- "FromEmail": "sender@yourdomain.com",
- "To": "2001-01-01T01:01:01",
- "Subject": "Hello!",
- "EventType": "Submission",
- "EventDate": "2019-08-24T14:15:22Z",
- "ChannelName": "Channel01",
- "MessageCategory": "Unknown",
- "NextTryOn": "2001-01-01T12:00:00",
- "Message": "Lorem ipsum",
- "IPAddress": "string",
- "PoolName": "string"
}
]
Load Email Events
Returns a log of delivery events for the specific transaction ID. Required Access Level: ViewReports
Authorizations:
path Parameters
transactionid required | string <string> Example: TransactionID ID number of transaction |
query Parameters
from | string or null <date-time> Example: from=2001-01-01T01:01:01 Starting date for search in YYYY-MM-DDThh:mm:ss format. |
to | string or null <date-time> Example: to=2001-01-01T01:01:01 Ending date for search in YYYY-MM-DDThh:mm:ss format. |
orderBy | string (EventsOrderBy) Default: "DateDescending" Enum: "DateDescending" "DateAscending" |
limit | integer <int32> Default: "0" Example: limit=100 Maximum number of returned items. |
offset | integer <int32> Default: "0" Example: offset=20 How many items should be returned ahead. |
Responses
Response Schema: application/json
TransactionID | string <string> ID number of transaction |
MsgID | string <string> ID number of selected message. |
FromEmail | string <string> Default From: email address. |
To | string <string> Ending date for search in YYYY-MM-DDThh:mm:ss format. |
Subject | string <string> Default subject of email. |
EventType | string (EventType) Default: "Submission" Enum: "Submission" "FailedAttempt" "Bounce" "Sent" "Open" "Click" "Unsubscribe" "Complaint" Type of event |
EventDate | string <date-time> Creation date |
ChannelName | string <string> Name of selected channel. |
MessageCategory | string (MessageCategory) Default: "Unknown" Enum: "Unknown" "Ignore" "Spam" "BlackListed" "NoMailbox" "GreyListed" "Throttled" "Timeout" "ConnectionProblem" "SPFProblem" "AccountProblem" "DNSProblem" "NotDeliveredCancelled" "CodeError" "ManualCancel" "ConnectionTerminated" "NotDelivered" |
NextTryOn | string or null <date-time> Date of next try |
Message | string <string> Content of message, HTML encoded |
IPAddress | string <string> IP which this email was sent through |
PoolName | string <string> Name of an IP pool this email was sent through |
Response samples
- 200
[- {
- "TransactionID": "TransactionID",
- "MsgID": "ABCDE_9RPhSWiaJq_ab1g1",
- "FromEmail": "sender@yourdomain.com",
- "To": "2001-01-01T01:01:01",
- "Subject": "Hello!",
- "EventType": "Submission",
- "EventDate": "2019-08-24T14:15:22Z",
- "ChannelName": "Channel01",
- "MessageCategory": "Unknown",
- "NextTryOn": "2001-01-01T12:00:00",
- "Message": "Lorem ipsum",
- "IPAddress": "string",
- "PoolName": "string"
}
]
Load Channel Events
Returns a log of delivery events filtered by specified parameters. Required Access Level: ViewReports
Authorizations:
path Parameters
name required | string <string> Example: Channel01 Name of selected channel. |
query Parameters
eventTypes | Array of strings (EventType) Items Enum: "Submission" "FailedAttempt" "Bounce" "Sent" "Open" "Click" "Unsubscribe" "Complaint" Types of Events to return |
from | string or null <date-time> Example: from=2001-01-01T01:01:01 Starting date for search in YYYY-MM-DDThh:mm:ss format. |
to | string or null <date-time> Example: to=2001-01-01T01:01:01 Ending date for search in YYYY-MM-DDThh:mm:ss format. |
orderBy | string (EventsOrderBy) Default: "DateDescending" Enum: "DateDescending" "DateAscending" |
limit | integer <int32> Default: "0" How many items to load. Maximum for this request is 1000 items |
offset | integer <int32> Default: "0" Example: offset=20 How many items should be returned ahead. |
Responses
Response Schema: application/json
TransactionID | string <string> ID number of transaction |
MsgID | string <string> ID number of selected message. |
FromEmail | string <string> Default From: email address. |
To | string <string> Ending date for search in YYYY-MM-DDThh:mm:ss format. |
Subject | string <string> Default subject of email. |
EventType | string (EventType) Default: "Submission" Enum: "Submission" "FailedAttempt" "Bounce" "Sent" "Open" "Click" "Unsubscribe" "Complaint" Type of event |
EventDate | string <date-time> Creation date |
ChannelName | string <string> Name of selected channel. |
MessageCategory | string (MessageCategory) Default: "Unknown" Enum: "Unknown" "Ignore" "Spam" "BlackListed" "NoMailbox" "GreyListed" "Throttled" "Timeout" "ConnectionProblem" "SPFProblem" "AccountProblem" "DNSProblem" "NotDeliveredCancelled" "CodeError" "ManualCancel" "ConnectionTerminated" "NotDelivered" |
NextTryOn | string or null <date-time> Date of next try |
Message | string <string> Content of message, HTML encoded |
IPAddress | string <string> IP which this email was sent through |
PoolName | string <string> Name of an IP pool this email was sent through |
Response samples
- 200
[- {
- "TransactionID": "TransactionID",
- "MsgID": "ABCDE_9RPhSWiaJq_ab1g1",
- "FromEmail": "sender@yourdomain.com",
- "To": "2001-01-01T01:01:01",
- "Subject": "Hello!",
- "EventType": "Submission",
- "EventDate": "2019-08-24T14:15:22Z",
- "ChannelName": "Channel01",
- "MessageCategory": "Unknown",
- "NextTryOn": "2001-01-01T12:00:00",
- "Message": "Lorem ipsum",
- "IPAddress": "string",
- "PoolName": "string"
}
]
Export Channel Events
Export delivery events log information to the specified file format. Required Access Level: Export
Authorizations:
path Parameters
name required | string <string> Example: Channel01 Name of selected channel. |
query Parameters
eventTypes | Array of strings (EventType) Items Enum: "Submission" "FailedAttempt" "Bounce" "Sent" "Open" "Click" "Unsubscribe" "Complaint" Types of Events to return |
from | string or null <date-time> Example: from=2001-01-01T01:01:01 Starting date for search in YYYY-MM-DDThh:mm:ss format. |
to | string or null <date-time> Example: to=2001-01-01T01:01:01 Ending date for search in YYYY-MM-DDThh:mm:ss format. |
fileFormat | string (ExportFileFormats) Default: "Csv" Enum: "Csv" "Xml" "Json" Format of the exported file |
compressionFormat | string (CompressionFormat) Default: "None" Enum: "None" "Zip" FileResponse compression format. None or Zip. |
fileName | string <string> Example: fileName=filename.txt Name of your file including extension. |
Responses
Response Schema: application/json
Link | string <string> Direct URL to the exported file |
PublicExportID | string <guid> ID of the exported file |
Response samples
- 202
{- "Link": "string",
- "PublicExportID": "E33EBA7A-C20D-4D3D-8F2F-5EEF42F58E6F"
}
Check Channel Export Status
Check the current status of the channel export. Required Access Level: Export
Authorizations:
path Parameters
id required | string <guid> Example: E33EBA7A-C20D-4D3D-8F2F-5EEF42F58E6F ID of the exported file |
Responses
Response Schema: application/json
Current status of the export.
Response samples
- 200
"Error"
Export Events
Export delivery events log information to the specified file format. Required Access Level: Export
Authorizations:
query Parameters
eventTypes | Array of strings (EventType) Items Enum: "Submission" "FailedAttempt" "Bounce" "Sent" "Open" "Click" "Unsubscribe" "Complaint" Types of Events to return |
from | string or null <date-time> Example: from=2001-01-01T01:01:01 Starting date for search in YYYY-MM-DDThh:mm:ss format. |
to | string or null <date-time> Example: to=2001-01-01T01:01:01 Ending date for search in YYYY-MM-DDThh:mm:ss format. |
fileFormat | string (ExportFileFormats) Default: "Csv" Enum: "Csv" "Xml" "Json" Format of the exported file |
compressionFormat | string (CompressionFormat) Default: "None" Enum: "None" "Zip" FileResponse compression format. None or Zip. |
fileName | string <string> Example: fileName=filename.txt Name of your file including extension. |
Responses
Response Schema: application/json
Link | string <string> Direct URL to the exported file |
PublicExportID | string <guid> ID of the exported file |
Response samples
- 202
{- "Link": "string",
- "PublicExportID": "E33EBA7A-C20D-4D3D-8F2F-5EEF42F58E6F"
}
Check Export Status
Check the current status of the export. Required Access Level: Export
Authorizations:
path Parameters
id required | string <guid> Example: E33EBA7A-C20D-4D3D-8F2F-5EEF42F58E6F ID of the exported file |
Responses
Response Schema: application/json
Current status of the export.
Response samples
- 200
"Error"
List Files
Returns a list of all your available files. Required Access Level: ViewFiles
Authorizations:
query Parameters
limit | integer <int32> Default: "0" Example: limit=100 Maximum number of returned items. |
offset | integer <int32> Default: "0" Example: offset=20 How many items should be returned ahead. |
Responses
Response Schema: application/json
FileName | string <string> Name of your file including extension. |
Size | integer or null <int32> Size of your attachment (in bytes). |
DateAdded | string <date-time> Date of creation in YYYY-MM-DDThh:ii:ss format |
ExpirationDate | string or null <date-time> Date when the file will be deleted from your Account. |
ContentType | string <string> Content type of the file. |
Response samples
- 200
[- {
- "FileName": "filename.txt",
- "Size": "100",
- "DateAdded": "2001-01-01T12:00:00",
- "ExpirationDate": null,
- "ContentType": "image/jpeg"
}
]
Upload File
Uploads selected file to the server. Required Access Level: ModifyFiles
Authorizations:
query Parameters
expiresAfterDays | integer or null <int32> Default: "35" Example: After how many days should the file be deleted. |
Request Body schema: application/json
BinaryContent required | string <byte> Content of the file sent as binary data |
Name | string <string> Filename |
ContentType | string <string> Type of file's content (e.g. image/jpeg) |
Responses
Response Schema: application/json
FileName | string <string> Name of your file including extension. |
Size | integer or null <int32> Size of your attachment (in bytes). |
DateAdded | string <date-time> Date of creation in YYYY-MM-DDThh:ii:ss format |
ExpirationDate | string or null <date-time> Date when the file will be deleted from your Account. |
ContentType | string <string> Content type of the file. |
Request samples
- Payload
{- "BinaryContent": "string",
- "Name": "attachment.txt",
- "ContentType": "string"
}
Response samples
- 201
{- "FileName": "filename.txt",
- "Size": "100",
- "DateAdded": "2001-01-01T12:00:00",
- "ExpirationDate": null,
- "ContentType": "image/jpeg"
}
Load File Details
Returns the specified File's details. Required Access Level: ViewFiles
Authorizations:
path Parameters
name required | string <string> Example: filename.txt Name of your file including extension. |
Responses
Response Schema: application/json
FileName | string <string> Name of your file including extension. |
Size | integer or null <int32> Size of your attachment (in bytes). |
DateAdded | string <date-time> Date of creation in YYYY-MM-DDThh:ii:ss format |
ExpirationDate | string or null <date-time> Date when the file will be deleted from your Account. |
ContentType | string <string> Content type of the file. |
Response samples
- 200
{- "FileName": "filename.txt",
- "Size": "100",
- "DateAdded": "2001-01-01T12:00:00",
- "ExpirationDate": null,
- "ContentType": "image/jpeg"
}
Get Routes
Get all your Inbound Routes. Required Access Level: ViewSettings
Authorizations:
Responses
Response Schema: application/json
PublicId | string <string> |
Name | string <string> Name of this route |
FilterType | string (InboundRouteFilterType) Default: "EmailAddress" Enum: "EmailAddress" "Subject" |
Filter | string <string> Filter of the inbound data |
ActionType | string (InboundRouteActionType) Default: "ForwardToEmail" Enum: "ForwardToEmail" "NotifyViaHttp" "Stop" |
ActionParameter | string <string> URL address or Email to notify about the inbound |
SortOrder | integer <int32> Place of this route in your routes queue's order |
Response samples
- 200
[- {
- "PublicId": "string",
- "Name": "string",
- "FilterType": "EmailAddress",
- "Filter": "string",
- "ActionType": "ForwardToEmail",
- "ActionParameter": "string",
- "SortOrder": 0
}
]
Create Route
Create new Inbound Route. Required Access Level: ModifySettings
Authorizations:
Request Body schema: application/json
Filter required | string <string> Filter of the inbound data |
Name required | string <string> Name of this route |
FilterType required | string (InboundRouteFilterType) Default: "EmailAddress" Enum: "EmailAddress" "Subject" |
ActionType required | string (InboundRouteActionType) Default: "ForwardToEmail" Enum: "ForwardToEmail" "NotifyViaHttp" "Stop" |
EmailAddress | string <string> Email to forward the inbound to |
HttpAddress | string <string> Address to notify about the inbound |
Responses
Response Schema: application/json
PublicId | string <string> |
Name | string <string> Name of this route |
FilterType | string (InboundRouteFilterType) Default: "EmailAddress" Enum: "EmailAddress" "Subject" |
Filter | string <string> Filter of the inbound data |
ActionType | string (InboundRouteActionType) Default: "ForwardToEmail" Enum: "ForwardToEmail" "NotifyViaHttp" "Stop" |
ActionParameter | string <string> URL address or Email to notify about the inbound |
SortOrder | integer <int32> Place of this route in your routes queue's order |
Request samples
- Payload
{- "Filter": "string",
- "Name": "string",
- "FilterType": "EmailAddress",
- "ActionType": "ForwardToEmail",
- "EmailAddress": "string",
- "HttpAddress": "string"
}
Response samples
- 200
{- "PublicId": "string",
- "Name": "string",
- "FilterType": "EmailAddress",
- "Filter": "string",
- "ActionType": "ForwardToEmail",
- "ActionParameter": "string",
- "SortOrder": 0
}
Get Route
Load an Inbound Route. Required Access Level: ViewSettings
Authorizations:
path Parameters
id required | string <guid> Example: 123456 ID number of your attachment |
Responses
Response Schema: application/json
PublicId | string <string> |
Name | string <string> Name of this route |
FilterType | string (InboundRouteFilterType) Default: "EmailAddress" Enum: "EmailAddress" "Subject" |
Filter | string <string> Filter of the inbound data |
ActionType | string (InboundRouteActionType) Default: "ForwardToEmail" Enum: "ForwardToEmail" "NotifyViaHttp" "Stop" |
ActionParameter | string <string> URL address or Email to notify about the inbound |
SortOrder | integer <int32> Place of this route in your routes queue's order |
Response samples
- 200
{- "PublicId": "string",
- "Name": "string",
- "FilterType": "EmailAddress",
- "Filter": "string",
- "ActionType": "ForwardToEmail",
- "ActionParameter": "string",
- "SortOrder": 0
}
Update Route
Update the Inbound Route. Required Access Level: ModifySettings
Authorizations:
path Parameters
id required | string <guid> string |
Request Body schema: application/json
Filter required | string <string> Filter of the inbound data |
Name required | string <string> Name of this route |
FilterType required | string (InboundRouteFilterType) Default: "EmailAddress" Enum: "EmailAddress" "Subject" |
ActionType required | string (InboundRouteActionType) Default: "ForwardToEmail" Enum: "ForwardToEmail" "NotifyViaHttp" "Stop" |
EmailAddress | string <string> Email to forward the inbound to |
HttpAddress | string <string> Address to notify about the inbound |
Responses
Response Schema: application/json
PublicId | string <string> |
Name | string <string> Name of this route |
FilterType | string (InboundRouteFilterType) Default: "EmailAddress" Enum: "EmailAddress" "Subject" |
Filter | string <string> Filter of the inbound data |
ActionType | string (InboundRouteActionType) Default: "ForwardToEmail" Enum: "ForwardToEmail" "NotifyViaHttp" "Stop" |
ActionParameter | string <string> URL address or Email to notify about the inbound |
SortOrder | integer <int32> Place of this route in your routes queue's order |
Request samples
- Payload
{- "Filter": "string",
- "Name": "string",
- "FilterType": "EmailAddress",
- "ActionType": "ForwardToEmail",
- "EmailAddress": "string",
- "HttpAddress": "string"
}
Response samples
- 200
{- "PublicId": "string",
- "Name": "string",
- "FilterType": "EmailAddress",
- "Filter": "string",
- "ActionType": "ForwardToEmail",
- "ActionParameter": "string",
- "SortOrder": 0
}
Update Sorting
Required Access Level: ViewSettings
Authorizations:
Request Body schema: application/json
Change the ordering of inbound routes for when matching the inbound
PublicInboundId required | string <guid> ID of the route to change the order of |
SortOrder required | integer <int32> 1 - route will be used first |
Responses
Response Schema: application/json
PublicId | string <string> |
Name | string <string> Name of this route |
FilterType | string (InboundRouteFilterType) Default: "EmailAddress" Enum: "EmailAddress" "Subject" |
Filter | string <string> Filter of the inbound data |
ActionType | string (InboundRouteActionType) Default: "ForwardToEmail" Enum: "ForwardToEmail" "NotifyViaHttp" "Stop" |
ActionParameter | string <string> URL address or Email to notify about the inbound |
SortOrder | integer <int32> Place of this route in your routes queue's order |
Request samples
- Payload
[- {
- "PublicInboundId": "string",
- "SortOrder": 0
}
]
Response samples
- 200
[- {
- "PublicId": "string",
- "Name": "string",
- "FilterType": "EmailAddress",
- "Filter": "string",
- "ActionType": "ForwardToEmail",
- "ActionParameter": "string",
- "SortOrder": 0
}
]
Load Lists
Returns all your existing lists. Required Access Level: ViewContacts
Authorizations:
query Parameters
limit | integer <int32> Default: "0" Example: limit=100 Maximum number of returned items. |
offset | integer <int32> Default: "0" Example: offset=20 How many items should be returned ahead. |
Responses
Response Schema: application/json
ListName | string <string> Name of your list. |
PublicListID | string or null <guid> ID code of list. Please note that this is different from the listid field. |
DateAdded | string <date-time> Date of creation in YYYY-MM-DDThh:ii:ss format |
AllowUnsubscribe | boolean <boolean> True: Allow unsubscribing from this list. Otherwise, false |
Response samples
- 200
[- {
- "ListName": "My List 1",
- "PublicListID": "E33EBA7A-C20D-4D3D-8F2F-5EEF42F58E6F",
- "DateAdded": "2001-01-01T12:00:00",
- "AllowUnsubscribe": "true/false"
}
]
Add List
Add a new list. Required Access Level: ModifyContacts
Authorizations:
Request Body schema: application/json
ListName required | string <string> Name of your list. |
AllowUnsubscribe | boolean <boolean> True: Allow unsubscribing from this list. Otherwise, false |
Emails | Array of strings <string> Comma delimited list of existing contact emails that should be added to this list. Leave empty for all contacts |
Responses
Response Schema: application/json
ListName | string <string> Name of your list. |
PublicListID | string or null <guid> ID code of list. Please note that this is different from the listid field. |
DateAdded | string <date-time> Date of creation in YYYY-MM-DDThh:ii:ss format |
AllowUnsubscribe | boolean <boolean> True: Allow unsubscribing from this list. Otherwise, false |
Request samples
- Payload
{- "ListName": "My List 1",
- "AllowUnsubscribe": "true/false",
- "Emails": [
- "john.doe@sample.com"
]
}
Response samples
- 201
{- "ListName": "My List 1",
- "PublicListID": "E33EBA7A-C20D-4D3D-8F2F-5EEF42F58E6F",
- "DateAdded": "2001-01-01T12:00:00",
- "AllowUnsubscribe": "true/false"
}
Load Contacts in List
Returns a list of contacts. Required Access Level: ViewContacts
Authorizations:
path Parameters
listname required | string <string> Example: My List 1 Name of your list. |
query Parameters
limit | integer <int32> Default: "20" Example: limit=100 Maximum number of returned items. |
offset | integer <int32> Default: "0" Example: offset=20 How many items should be returned ahead. |
Responses
Response Schema: application/json
string <string> Proper email address. | |
Status | string (ContactStatus) Default: "Transactional" Enum: "Transactional" "Engaged" "Active" "Bounced" "Unsubscribed" "Abuse" "Inactive" "Stale" "NotConfirmed" |
FirstName | string <string> First name. |
LastName | string <string> Last name. |
object A key-value collection of custom contact fields which can be used in the system. | |
object (ConsentData) | |
Source | string (ContactSource) Default: "DeliveryApi" Enum: "DeliveryApi" "ManualInput" "FileUpload" "WebForm" "ContactApi" "VerificationApi" "FileVerificationApi" |
DateAdded | string <date-time> Date of creation in YYYY-MM-DDThh:ii:ss format |
DateUpdated | string or null <date-time> Last change date |
StatusChangeDate | string or null <date-time> Date of last status change. |
object (ContactActivity) |
Response samples
- 200
[- {
- "Email": "mail@example.com",
- "Status": "Transactional",
- "FirstName": "Fred",
- "LastName": "Flintstone",
- "CustomFields": {
- "city": "New York",
- "age": "34"
}, - "Consent": {
- "ConsentIP": "192.168.0.1",
- "ConsentDate": "1/1/2015 0:00:00 AM",
- "ConsentTracking": "Unknown"
}, - "Source": "DeliveryApi",
- "DateAdded": "2001-01-01T12:00:00",
- "DateUpdated": "2001-01-01T12:00:00",
- "StatusChangeDate": "2001-01-01T12:00:00",
- "Activity": {
- "TotalSent": "1000",
- "TotalOpened": "1000",
- "TotalClicked": "1000",
- "TotalFailed": "1000",
- "LastSent": null,
- "LastOpened": "2014-01-01",
- "LastClicked": null,
- "LastFailed": null,
- "LastIP": "string",
- "ErrorCode": null,
- "FriendlyErrorMessage": "string"
}
}
]
Load List
Returns detailed information about specified list. Required Access Level: ViewContacts
Authorizations:
path Parameters
name required | string <string> Example: My List 1 Name of your list. |
Responses
Response Schema: application/json
ListName | string <string> Name of your list. |
PublicListID | string or null <guid> ID code of list. Please note that this is different from the listid field. |
DateAdded | string <date-time> Date of creation in YYYY-MM-DDThh:ii:ss format |
AllowUnsubscribe | boolean <boolean> True: Allow unsubscribing from this list. Otherwise, false |
Response samples
- 200
{- "ListName": "My List 1",
- "PublicListID": "E33EBA7A-C20D-4D3D-8F2F-5EEF42F58E6F",
- "DateAdded": "2001-01-01T12:00:00",
- "AllowUnsubscribe": "true/false"
}
Update List
Update existing list. Required Access Level: ModifyContacts
Authorizations:
path Parameters
name required | string <string> Example: My List 1 Name of your list. |
Request Body schema: application/json
NewListName | string <string> Name of your list if you want to change it. |
AllowUnsubscribe | boolean <boolean> True: Allow unsubscribing from this list. Otherwise, false |
Responses
Response Schema: application/json
ListName | string <string> Name of your list. |
PublicListID | string or null <guid> ID code of list. Please note that this is different from the listid field. |
DateAdded | string <date-time> Date of creation in YYYY-MM-DDThh:ii:ss format |
AllowUnsubscribe | boolean <boolean> True: Allow unsubscribing from this list. Otherwise, false |
Request samples
- Payload
{- "NewListName": "My List 2",
- "AllowUnsubscribe": "true/false"
}
Response samples
- 200
{- "ListName": "My List 1",
- "PublicListID": "E33EBA7A-C20D-4D3D-8F2F-5EEF42F58E6F",
- "DateAdded": "2001-01-01T12:00:00",
- "AllowUnsubscribe": "true/false"
}
Add Contacts to List
Add existing Contacts to specified list. Required Access Level: ModifyContacts
Authorizations:
path Parameters
name required | string <string> Example: My List 1 Name of your list. |
Request Body schema: application/json
Provide either rule or a list of emails, not both.
Rule | string <string> SQL-like rule. Sending 'All' as a value loads all resources of the given type. Help for building a segment rule can be found here: https://help.elasticemail.com/en/articles/5162182-segment-rules |
Emails | Array of strings <string> Comma delimited list of contact emails |
Responses
Response Schema: application/json
ListName | string <string> Name of your list. |
PublicListID | string or null <guid> ID code of list. Please note that this is different from the listid field. |
DateAdded | string <date-time> Date of creation in YYYY-MM-DDThh:ii:ss format |
AllowUnsubscribe | boolean <boolean> True: Allow unsubscribing from this list. Otherwise, false |
Request samples
- Payload
{- "Rule": "string",
- "Emails": [
- "john.doe@sample.com"
]
}
Response samples
- 200
{- "ListName": "My List 1",
- "PublicListID": "E33EBA7A-C20D-4D3D-8F2F-5EEF42F58E6F",
- "DateAdded": "2001-01-01T12:00:00",
- "AllowUnsubscribe": "true/false"
}
Remove Contacts from List
Remove specified Contacts from your list. Required Access Level: ModifyContacts
Authorizations:
path Parameters
name required | string <string> Example: My List 1 Name of your list. |
Request Body schema: application/json
Provide either rule or a list of emails, not both.
Rule | string <string> SQL-like rule. Sending 'All' as a value loads all resources of the given type. Help for building a segment rule can be found here: https://help.elasticemail.com/en/articles/5162182-segment-rules |
Emails | Array of strings <string> Comma delimited list of contact emails |
Responses
Request samples
- Payload
{- "Rule": "string",
- "Emails": [
- "john.doe@sample.com"
]
}
List ApiKeys
List all your existing ApiKeys. Required Access Level: Security
Authorizations:
query Parameters
subaccount | string <string> Email of the subaccount of which ApiKeys should be loaded |
Responses
Response Schema: application/json
AccessLevel | Array of strings (AccessLevel) Items Enum: "None" "ViewAccount" "ViewContacts" "ViewForms" "ViewTemplates" "ViewCampaigns" "ViewChannels" "ViewAutomations" "ViewSurveys" "ViewSettings" "ViewBilling" "ViewSubAccounts" "ViewUsers" "ViewFiles" "ViewReports" "ModifyAccount" "ModifyContacts" "ModifyForms" "ModifyTemplates" "ModifyCampaigns" "ModifyChannels" "ModifyAutomations" "ModifySurveys" "ModifyFiles" "Export" "SendSmtp" "SendSMS" "ModifySettings" "ModifyBilling" "ModifyProfile" "ModifySubAccounts" "ModifyUsers" "Security" "ModifyLanguage" "ViewSupport" "SendHttp" "Modify2FAEmail" "ModifySupport" "ViewCustomFields" "ModifyCustomFields" "ModifyWebNotifications" "ExtendedLogs" "VerifyEmails" "Modify2FASms" "ModifyLandingPages" "ViewLandingPages" "ModifySuppressions" "ViewSuppressions" "ViewDragDropEditor" "ViewTemplateEditor" "ViewAITools" "ModifySubscriptionAntiSpam" "ViewLandingPagesCheckout" "ModifyLandingPagesCheckout" Access level or permission to be assigned to this ApiKey. |
Name | string <string> Name of the ApiKey. |
DateCreated | string <date-time> Date this ApiKey was created. |
LastUse | string or null <date-time> Date this ApiKey was last used. |
Expires | string or null <date-time> Date this ApiKey expires. |
RestrictAccessToIPRange | Array of strings <string> Which IPs can use this ApiKey |
Response samples
- 200
[- {
- "AccessLevel": [
- "None"
], - "Name": "string",
- "DateCreated": "2019-08-24T14:15:22Z",
- "LastUse": null,
- "Expires": null,
- "RestrictAccessToIPRange": [
- "string"
]
}
]
Add ApiKey
Add a new ApiKey. Required Access Level: Security
Authorizations:
Request Body schema: application/json
Name required | string <string> Name of the ApiKey for ease of reference. |
AccessLevel required | Array of strings (AccessLevel) Items Enum: "None" "ViewAccount" "ViewContacts" "ViewForms" "ViewTemplates" "ViewCampaigns" "ViewChannels" "ViewAutomations" "ViewSurveys" "ViewSettings" "ViewBilling" "ViewSubAccounts" "ViewUsers" "ViewFiles" "ViewReports" "ModifyAccount" "ModifyContacts" "ModifyForms" "ModifyTemplates" "ModifyCampaigns" "ModifyChannels" "ModifyAutomations" "ModifySurveys" "ModifyFiles" "Export" "SendSmtp" "SendSMS" "ModifySettings" "ModifyBilling" "ModifyProfile" "ModifySubAccounts" "ModifyUsers" "Security" "ModifyLanguage" "ViewSupport" "SendHttp" "Modify2FAEmail" "ModifySupport" "ViewCustomFields" "ModifyCustomFields" "ModifyWebNotifications" "ExtendedLogs" "VerifyEmails" "Modify2FASms" "ModifyLandingPages" "ViewLandingPages" "ModifySuppressions" "ViewSuppressions" "ViewDragDropEditor" "ViewTemplateEditor" "ViewAITools" "ModifySubscriptionAntiSpam" "ViewLandingPagesCheckout" "ModifyLandingPagesCheckout" Access level or permission to be assigned to this ApiKey. |
Expires | string or null <date-time> Date this ApiKey expires. |
RestrictAccessToIPRange | Array of strings <string> Which IPs can use this ApiKey |
Subaccount | string <string> Email of the subaccount for which this ApiKey should be created |
Responses
Response Schema: application/json
Token | string <string> Unique token to be used in the system |
AccessLevel | Array of strings (AccessLevel) Items Enum: "None" "ViewAccount" "ViewContacts" "ViewForms" "ViewTemplates" "ViewCampaigns" "ViewChannels" "ViewAutomations" "ViewSurveys" "ViewSettings" "ViewBilling" "ViewSubAccounts" "ViewUsers" "ViewFiles" "ViewReports" "ModifyAccount" "ModifyContacts" "ModifyForms" "ModifyTemplates" "ModifyCampaigns" "ModifyChannels" "ModifyAutomations" "ModifySurveys" "ModifyFiles" "Export" "SendSmtp" "SendSMS" "ModifySettings" "ModifyBilling" "ModifyProfile" "ModifySubAccounts" "ModifyUsers" "Security" "ModifyLanguage" "ViewSupport" "SendHttp" "Modify2FAEmail" "ModifySupport" "ViewCustomFields" "ModifyCustomFields" "ModifyWebNotifications" "ExtendedLogs" "VerifyEmails" "Modify2FASms" "ModifyLandingPages" "ViewLandingPages" "ModifySuppressions" "ViewSuppressions" "ViewDragDropEditor" "ViewTemplateEditor" "ViewAITools" "ModifySubscriptionAntiSpam" "ViewLandingPagesCheckout" "ModifyLandingPagesCheckout" Access level or permission to be assigned to this ApiKey. |
Name | string <string> Name of the ApiKey. |
DateCreated | string <date-time> Date this ApiKey was created. |
LastUse | string or null <date-time> Date this ApiKey was last used. |
Expires | string or null <date-time> Date this ApiKey expires. |
RestrictAccessToIPRange | Array of strings <string> Which IPs can use this ApiKey |
Request samples
- Payload
{- "Name": "string",
- "AccessLevel": [
- "None"
], - "Expires": null,
- "RestrictAccessToIPRange": [
- "string"
], - "Subaccount": "string"
}
Response samples
- 201
{- "Token": "string",
- "AccessLevel": [
- "None"
], - "Name": "string",
- "DateCreated": "2019-08-24T14:15:22Z",
- "LastUse": null,
- "Expires": null,
- "RestrictAccessToIPRange": [
- "string"
]
}
Load ApiKey
Load your existing ApiKey info. Required Access Level: Security
Authorizations:
path Parameters
name required | string <string> Name of the ApiKey |
query Parameters
subaccount | string <string> Email of the subaccount of which ApiKey should be loaded |
Responses
Response Schema: application/json
AccessLevel | Array of strings (AccessLevel) Items Enum: "None" "ViewAccount" "ViewContacts" "ViewForms" "ViewTemplates" "ViewCampaigns" "ViewChannels" "ViewAutomations" "ViewSurveys" "ViewSettings" "ViewBilling" "ViewSubAccounts" "ViewUsers" "ViewFiles" "ViewReports" "ModifyAccount" "ModifyContacts" "ModifyForms" "ModifyTemplates" "ModifyCampaigns" "ModifyChannels" "ModifyAutomations" "ModifySurveys" "ModifyFiles" "Export" "SendSmtp" "SendSMS" "ModifySettings" "ModifyBilling" "ModifyProfile" "ModifySubAccounts" "ModifyUsers" "Security" "ModifyLanguage" "ViewSupport" "SendHttp" "Modify2FAEmail" "ModifySupport" "ViewCustomFields" "ModifyCustomFields" "ModifyWebNotifications" "ExtendedLogs" "VerifyEmails" "Modify2FASms" "ModifyLandingPages" "ViewLandingPages" "ModifySuppressions" "ViewSuppressions" "ViewDragDropEditor" "ViewTemplateEditor" "ViewAITools" "ModifySubscriptionAntiSpam" "ViewLandingPagesCheckout" "ModifyLandingPagesCheckout" Access level or permission to be assigned to this ApiKey. |
Name | string <string> Name of the ApiKey. |
DateCreated | string <date-time> Date this ApiKey was created. |
LastUse | string or null <date-time> Date this ApiKey was last used. |
Expires | string or null <date-time> Date this ApiKey expires. |
RestrictAccessToIPRange | Array of strings <string> Which IPs can use this ApiKey |
Response samples
- 200
{- "AccessLevel": [
- "None"
], - "Name": "string",
- "DateCreated": "2019-08-24T14:15:22Z",
- "LastUse": null,
- "Expires": null,
- "RestrictAccessToIPRange": [
- "string"
]
}
Update ApiKey
Update your existing ApiKey. Required Access Level: Security
Authorizations:
path Parameters
name required | string <string> Name of the ApiKey |
Request Body schema: application/json
Name required | string <string> Name of the ApiKey for ease of reference. |
AccessLevel required | Array of strings (AccessLevel) Items Enum: "None" "ViewAccount" "ViewContacts" "ViewForms" "ViewTemplates" "ViewCampaigns" "ViewChannels" "ViewAutomations" "ViewSurveys" "ViewSettings" "ViewBilling" "ViewSubAccounts" "ViewUsers" "ViewFiles" "ViewReports" "ModifyAccount" "ModifyContacts" "ModifyForms" "ModifyTemplates" "ModifyCampaigns" "ModifyChannels" "ModifyAutomations" "ModifySurveys" "ModifyFiles" "Export" "SendSmtp" "SendSMS" "ModifySettings" "ModifyBilling" "ModifyProfile" "ModifySubAccounts" "ModifyUsers" "Security" "ModifyLanguage" "ViewSupport" "SendHttp" "Modify2FAEmail" "ModifySupport" "ViewCustomFields" "ModifyCustomFields" "ModifyWebNotifications" "ExtendedLogs" "VerifyEmails" "Modify2FASms" "ModifyLandingPages" "ViewLandingPages" "ModifySuppressions" "ViewSuppressions" "ViewDragDropEditor" "ViewTemplateEditor" "ViewAITools" "ModifySubscriptionAntiSpam" "ViewLandingPagesCheckout" "ModifyLandingPagesCheckout" Access level or permission to be assigned to this ApiKey. |
Expires | string or null <date-time> Date this ApiKey expires. |
RestrictAccessToIPRange | Array of strings <string> Which IPs can use this ApiKey |
Subaccount | string <string> Email of the subaccount for which this ApiKey should be created |
Responses
Response Schema: application/json
AccessLevel | Array of strings (AccessLevel) Items Enum: "None" "ViewAccount" "ViewContacts" "ViewForms" "ViewTemplates" "ViewCampaigns" "ViewChannels" "ViewAutomations" "ViewSurveys" "ViewSettings" "ViewBilling" "ViewSubAccounts" "ViewUsers" "ViewFiles" "ViewReports" "ModifyAccount" "ModifyContacts" "ModifyForms" "ModifyTemplates" "ModifyCampaigns" "ModifyChannels" "ModifyAutomations" "ModifySurveys" "ModifyFiles" "Export" "SendSmtp" "SendSMS" "ModifySettings" "ModifyBilling" "ModifyProfile" "ModifySubAccounts" "ModifyUsers" "Security" "ModifyLanguage" "ViewSupport" "SendHttp" "Modify2FAEmail" "ModifySupport" "ViewCustomFields" "ModifyCustomFields" "ModifyWebNotifications" "ExtendedLogs" "VerifyEmails" "Modify2FASms" "ModifyLandingPages" "ViewLandingPages" "ModifySuppressions" "ViewSuppressions" "ViewDragDropEditor" "ViewTemplateEditor" "ViewAITools" "ModifySubscriptionAntiSpam" "ViewLandingPagesCheckout" "ModifyLandingPagesCheckout" Access level or permission to be assigned to this ApiKey. |
Name | string <string> Name of the ApiKey. |
DateCreated | string <date-time> Date this ApiKey was created. |
LastUse | string or null <date-time> Date this ApiKey was last used. |
Expires | string or null <date-time> Date this ApiKey expires. |
RestrictAccessToIPRange | Array of strings <string> Which IPs can use this ApiKey |
Request samples
- Payload
{- "Name": "string",
- "AccessLevel": [
- "None"
], - "Expires": null,
- "RestrictAccessToIPRange": [
- "string"
], - "Subaccount": "string"
}
Response samples
- 200
{- "AccessLevel": [
- "None"
], - "Name": "string",
- "DateCreated": "2019-08-24T14:15:22Z",
- "LastUse": null,
- "Expires": null,
- "RestrictAccessToIPRange": [
- "string"
]
}
List SMTP Credentials
List all your existing SMTP Credentials. Required Access Level: Security
Authorizations:
query Parameters
subaccount | string <string> Email of the subaccount of which credentials should be listed |
Responses
Response Schema: application/json
AccessLevel | string (AccessLevel) Default: "None" Enum: "None" "ViewAccount" "ViewContacts" "ViewForms" "ViewTemplates" "ViewCampaigns" "ViewChannels" "ViewAutomations" "ViewSurveys" "ViewSettings" "ViewBilling" "ViewSubAccounts" "ViewUsers" "ViewFiles" "ViewReports" "ModifyAccount" "ModifyContacts" "ModifyForms" "ModifyTemplates" "ModifyCampaigns" "ModifyChannels" "ModifyAutomations" "ModifySurveys" "ModifyFiles" "Export" "SendSmtp" "SendSMS" "ModifySettings" "ModifyBilling" "ModifyProfile" "ModifySubAccounts" "ModifyUsers" "Security" "ModifyLanguage" "ViewSupport" "SendHttp" "Modify2FAEmail" "ModifySupport" "ViewCustomFields" "ModifyCustomFields" "ModifyWebNotifications" "ExtendedLogs" "VerifyEmails" "Modify2FASms" "ModifyLandingPages" "ViewLandingPages" "ModifySuppressions" "ViewSuppressions" "ViewDragDropEditor" "ViewTemplateEditor" "ViewAITools" "ModifySubscriptionAntiSpam" "ViewLandingPagesCheckout" "ModifyLandingPagesCheckout" |
Name | string <string> Name of the key. |
DateCreated | string <date-time> Date this SmtpCredential was created. |
LastUse | string or null <date-time> Date this SmtpCredential was last used. |
Expires | string or null <date-time> Date this SmtpCredential expires. |
RestrictAccessToIPRange | Array of strings <string> Which IPs can use this SmtpCredential |
Response samples
- 200
[- {
- "AccessLevel": "None",
- "Name": "string",
- "DateCreated": "2019-08-24T14:15:22Z",
- "LastUse": null,
- "Expires": null,
- "RestrictAccessToIPRange": [
- "string"
]
}
]
Add SMTP Credential
Add new SMTP Credential. Required Access Level: Security
Authorizations:
Request Body schema: application/json
Name required | string <string> Name of the Credential for ease of reference. It must be a valid email address. |
Expires | string or null <date-time> Date this SmtpCredential expires. |
RestrictAccessToIPRange | Array of strings <string> Which IPs can use this SmtpCredential |
Subaccount | string <string> Email of the subaccount for which this SmtpCredential should be created |
Responses
Response Schema: application/json
Token | string <string> Unique token to be used in the system |
AccessLevel | string (AccessLevel) Default: "None" Enum: "None" "ViewAccount" "ViewContacts" "ViewForms" "ViewTemplates" "ViewCampaigns" "ViewChannels" "ViewAutomations" "ViewSurveys" "ViewSettings" "ViewBilling" "ViewSubAccounts" "ViewUsers" "ViewFiles" "ViewReports" "ModifyAccount" "ModifyContacts" "ModifyForms" "ModifyTemplates" "ModifyCampaigns" "ModifyChannels" "ModifyAutomations" "ModifySurveys" "ModifyFiles" "Export" "SendSmtp" "SendSMS" "ModifySettings" "ModifyBilling" "ModifyProfile" "ModifySubAccounts" "ModifyUsers" "Security" "ModifyLanguage" "ViewSupport" "SendHttp" "Modify2FAEmail" "ModifySupport" "ViewCustomFields" "ModifyCustomFields" "ModifyWebNotifications" "ExtendedLogs" "VerifyEmails" "Modify2FASms" "ModifyLandingPages" "ViewLandingPages" "ModifySuppressions" "ViewSuppressions" "ViewDragDropEditor" "ViewTemplateEditor" "ViewAITools" "ModifySubscriptionAntiSpam" "ViewLandingPagesCheckout" "ModifyLandingPagesCheckout" |
Name | string <string> Name of the key. |
DateCreated | string <date-time> Date this SmtpCredential was created. |
LastUse | string or null <date-time> Date this SmtpCredential was last used. |
Expires | string or null <date-time> Date this SmtpCredential expires. |
RestrictAccessToIPRange | Array of strings <string> Which IPs can use this SmtpCredential |
Request samples
- Payload
{- "Name": "string",
- "Expires": null,
- "RestrictAccessToIPRange": [
- "string"
], - "Subaccount": "string"
}
Response samples
- 201
{- "Token": "string",
- "AccessLevel": "None",
- "Name": "string",
- "DateCreated": "2019-08-24T14:15:22Z",
- "LastUse": null,
- "Expires": null,
- "RestrictAccessToIPRange": [
- "string"
]
}
Load SMTP Credential
Load your existing SMTP Credential info. Required Access Level: Security
Authorizations:
path Parameters
name required | string <string> Name of the SMTP Credential |
query Parameters
subaccount | string <string> Email of the subaccount of which credential should be loaded |
Responses
Response Schema: application/json
AccessLevel | string (AccessLevel) Default: "None" Enum: "None" "ViewAccount" "ViewContacts" "ViewForms" "ViewTemplates" "ViewCampaigns" "ViewChannels" "ViewAutomations" "ViewSurveys" "ViewSettings" "ViewBilling" "ViewSubAccounts" "ViewUsers" "ViewFiles" "ViewReports" "ModifyAccount" "ModifyContacts" "ModifyForms" "ModifyTemplates" "ModifyCampaigns" "ModifyChannels" "ModifyAutomations" "ModifySurveys" "ModifyFiles" "Export" "SendSmtp" "SendSMS" "ModifySettings" "ModifyBilling" "ModifyProfile" "ModifySubAccounts" "ModifyUsers" "Security" "ModifyLanguage" "ViewSupport" "SendHttp" "Modify2FAEmail" "ModifySupport" "ViewCustomFields" "ModifyCustomFields" "ModifyWebNotifications" "ExtendedLogs" "VerifyEmails" "Modify2FASms" "ModifyLandingPages" "ViewLandingPages" "ModifySuppressions" "ViewSuppressions" "ViewDragDropEditor" "ViewTemplateEditor" "ViewAITools" "ModifySubscriptionAntiSpam" "ViewLandingPagesCheckout" "ModifyLandingPagesCheckout" |
Name | string <string> Name of the key. |
DateCreated | string <date-time> Date this SmtpCredential was created. |
LastUse | string or null <date-time> Date this SmtpCredential was last used. |
Expires | string or null <date-time> Date this SmtpCredential expires. |
RestrictAccessToIPRange | Array of strings <string> Which IPs can use this SmtpCredential |
Response samples
- 200
{- "AccessLevel": "None",
- "Name": "string",
- "DateCreated": "2019-08-24T14:15:22Z",
- "LastUse": null,
- "Expires": null,
- "RestrictAccessToIPRange": [
- "string"
]
}
Update SMTP Credential
Update your existing SMTP Credentials. Required Access Level: Security
Authorizations:
path Parameters
name required | string <string> Name of the SMTP Credential |
Request Body schema: application/json
Name required | string <string> Name of the Credential for ease of reference. It must be a valid email address. |
Expires | string or null <date-time> Date this SmtpCredential expires. |
RestrictAccessToIPRange | Array of strings <string> Which IPs can use this SmtpCredential |
Subaccount | string <string> Email of the subaccount for which this SmtpCredential should be created |
Responses
Response Schema: application/json
AccessLevel | string (AccessLevel) Default: "None" Enum: "None" "ViewAccount" "ViewContacts" "ViewForms" "ViewTemplates" "ViewCampaigns" "ViewChannels" "ViewAutomations" "ViewSurveys" "ViewSettings" "ViewBilling" "ViewSubAccounts" "ViewUsers" "ViewFiles" "ViewReports" "ModifyAccount" "ModifyContacts" "ModifyForms" "ModifyTemplates" "ModifyCampaigns" "ModifyChannels" "ModifyAutomations" "ModifySurveys" "ModifyFiles" "Export" "SendSmtp" "SendSMS" "ModifySettings" "ModifyBilling" "ModifyProfile" "ModifySubAccounts" "ModifyUsers" "Security" "ModifyLanguage" "ViewSupport" "SendHttp" "Modify2FAEmail" "ModifySupport" "ViewCustomFields" "ModifyCustomFields" "ModifyWebNotifications" "ExtendedLogs" "VerifyEmails" "Modify2FASms" "ModifyLandingPages" "ViewLandingPages" "ModifySuppressions" "ViewSuppressions" "ViewDragDropEditor" "ViewTemplateEditor" "ViewAITools" "ModifySubscriptionAntiSpam" "ViewLandingPagesCheckout" "ModifyLandingPagesCheckout" |
Name | string <string> Name of the key. |
DateCreated | string <date-time> Date this SmtpCredential was created. |
LastUse | string or null <date-time> Date this SmtpCredential was last used. |
Expires | string or null <date-time> Date this SmtpCredential expires. |
RestrictAccessToIPRange | Array of strings <string> Which IPs can use this SmtpCredential |
Request samples
- Payload
{- "Name": "string",
- "Expires": null,
- "RestrictAccessToIPRange": [
- "string"
], - "Subaccount": "string"
}
Response samples
- 200
{- "AccessLevel": "None",
- "Name": "string",
- "DateCreated": "2019-08-24T14:15:22Z",
- "LastUse": null,
- "Expires": null,
- "RestrictAccessToIPRange": [
- "string"
]
}
Manages your segments - dynamically created lists of contacts. Help for building a segment rule can be found here: https://help.elasticemail.com/en/articles/5162182-segment-rules
Load Segments
Returns a list of all your available Segments. Required Access Level: ViewContacts
Authorizations:
query Parameters
limit | integer <int32> Default: "0" Example: limit=100 Maximum number of returned items. |
offset | integer <int32> Default: "0" Example: offset=20 How many items should be returned ahead. |
Responses
Response Schema: application/json
Name | string <string> Segment name |
Rule | string <string> SQL-like rule to determine which Contacts belong to this Segment. |
Response samples
- 200
[- {
- "Name": "string",
- "Rule": "string"
}
]
Add Segment
Add a new segment, based on specified RULE. Required Access Level: ModifyContacts
Authorizations:
Request Body schema: application/json
Name required | string <string> Segment name |
Rule required | string <string> SQL-like rule to determine which Contacts belong to this Segment. Help for building a segment rule can be found here: https://help.elasticemail.com/en/articles/5162182-segment-rules |
Responses
Response Schema: application/json
Name | string <string> Segment name |
Rule | string <string> SQL-like rule to determine which Contacts belong to this Segment. |
Request samples
- Payload
{- "Name": "string",
- "Rule": "string"
}
Response samples
- 201
{- "Name": "string",
- "Rule": "string"
}
Load Segment
Returns details for the specified segment. Required Access Level: ViewContacts
Authorizations:
path Parameters
name required | string <string> Name of the segment you want to load. Will load all contacts if the 'All Contacts' name has been provided |
Responses
Response Schema: application/json
Name | string <string> Segment name |
Rule | string <string> SQL-like rule to determine which Contacts belong to this Segment. |
Response samples
- 200
{- "Name": "string",
- "Rule": "string"
}
Update Segment
Rename or change RULE for your segment. Required Access Level: ModifyContacts
Authorizations:
path Parameters
name required | string <string> Example: My Segment 1 Name of your segment. |
Request Body schema: application/json
Name required | string <string> Segment name |
Rule required | string <string> SQL-like rule to determine which Contacts belong to this Segment. Help for building a segment rule can be found here: https://help.elasticemail.com/en/articles/5162182-segment-rules |
Responses
Response Schema: application/json
Name | string <string> Segment name |
Rule | string <string> SQL-like rule to determine which Contacts belong to this Segment. |
Request samples
- Payload
{- "Name": "string",
- "Rule": "string"
}
Response samples
- 200
{- "Name": "string",
- "Rule": "string"
}
Load Statistics
Returns basic statistics. Required Access Level: ViewReports
Authorizations:
query Parameters
from required | string <date-time> Example: from=2001-01-01T01:01:01 Starting date for search in YYYY-MM-DDThh:mm:ss format. |
to | string or null <date-time> Example: to=2001-01-01T01:01:01 Ending date for search in YYYY-MM-DDThh:mm:ss format. |
Responses
Response Schema: application/json
Recipients | integer <int64> Number of recipients |
EmailTotal | integer <int64> Number of emails |
SmsTotal | integer <int64> Number of SMS |
Delivered | integer <int64> Number of delivered messages |
Bounced | integer <int64> Number of bounced messages |
InProgress | integer <int64> Number of messages in progress |
Opened | integer <int64> Number of opened messages |
Clicked | integer <int64> Number of clicked messages |
Unsubscribed | integer <int64> Number of unsubscribed messages |
Complaints | integer <int64> Number of complaint messages |
Inbound | integer <int64> Number of inbound messages |
ManualCancel | integer <int64> Number of manually cancelled messages |
NotDelivered | integer <int64> Number of messages flagged with 'Not Delivered' |
Response samples
- 200
{- "Recipients": "1234",
- "EmailTotal": "1234",
- "SmsTotal": "12",
- "Delivered": "1000",
- "Bounced": "1000",
- "InProgress": "1234",
- "Opened": "1000",
- "Clicked": "1000",
- "Unsubscribed": "1000",
- "Complaints": "1000",
- "Inbound": "1000",
- "ManualCancel": "1000",
- "NotDelivered": "0"
}
Load Campaigns Stats
Returns a list of your Campaigns' stats. Required Access Level: ViewChannels
Authorizations:
query Parameters
limit | integer <int32> Default: "0" Example: limit=100 Maximum number of returned items. |
offset | integer <int32> Default: "0" Example: offset=20 How many items should be returned ahead. |
Responses
Response Schema: application/json
ChannelName | string <string> Channel name |
Recipients | integer <int64> Number of recipients |
EmailTotal | integer <int64> Number of emails |
SmsTotal | integer <int64> Number of SMS |
Delivered | integer <int64> Number of delivered messages |
Bounced | integer <int64> Number of bounced messages |
InProgress | integer <int64> Number of messages in progress |
Opened | integer <int64> Number of opened messages |
Clicked | integer <int64> Number of clicked messages |
Unsubscribed | integer <int64> Number of unsubscribed messages |
Complaints | integer <int64> Number of complaint messages |
Inbound | integer <int64> Number of inbound messages |
ManualCancel | integer <int64> Number of manually cancelled messages |
NotDelivered | integer <int64> Number of messages flagged with 'Not Delivered' |
Response samples
- 200
[- {
- "ChannelName": "string",
- "Recipients": "1234",
- "EmailTotal": "1234",
- "SmsTotal": "12",
- "Delivered": "1000",
- "Bounced": "1000",
- "InProgress": "1234",
- "Opened": "1000",
- "Clicked": "1000",
- "Unsubscribed": "1000",
- "Complaints": "1000",
- "Inbound": "1000",
- "ManualCancel": "1000",
- "NotDelivered": "0"
}
]
Load Campaign Stats
Retrieve stats of an existing campaign. Required Access Level: ViewChannels
Authorizations:
path Parameters
name required | string <string> The name of the campaign to get. |
Responses
Response Schema: application/json
ChannelName | string <string> Channel name |
Recipients | integer <int64> Number of recipients |
EmailTotal | integer <int64> Number of emails |
SmsTotal | integer <int64> Number of SMS |
Delivered | integer <int64> Number of delivered messages |
Bounced | integer <int64> Number of bounced messages |
InProgress | integer <int64> Number of messages in progress |
Opened | integer <int64> Number of opened messages |
Clicked | integer <int64> Number of clicked messages |
Unsubscribed | integer <int64> Number of unsubscribed messages |
Complaints | integer <int64> Number of complaint messages |
Inbound | integer <int64> Number of inbound messages |
ManualCancel | integer <int64> Number of manually cancelled messages |
NotDelivered | integer <int64> Number of messages flagged with 'Not Delivered' |
Response samples
- 200
{- "ChannelName": "string",
- "Recipients": "1234",
- "EmailTotal": "1234",
- "SmsTotal": "12",
- "Delivered": "1000",
- "Bounced": "1000",
- "InProgress": "1234",
- "Opened": "1000",
- "Clicked": "1000",
- "Unsubscribed": "1000",
- "Complaints": "1000",
- "Inbound": "1000",
- "ManualCancel": "1000",
- "NotDelivered": "0"
}
Load Channels Stats
Returns a list of your Channels' stats. Required Access Level: ViewChannels
Authorizations:
query Parameters
limit | integer <int32> Default: "0" Example: limit=100 Maximum number of returned items. |
offset | integer <int32> Default: "0" Example: offset=20 How many items should be returned ahead. |
Responses
Response Schema: application/json
ChannelName | string <string> Channel name |
Recipients | integer <int64> Number of recipients |
EmailTotal | integer <int64> Number of emails |
SmsTotal | integer <int64> Number of SMS |
Delivered | integer <int64> Number of delivered messages |
Bounced | integer <int64> Number of bounced messages |
InProgress | integer <int64> Number of messages in progress |
Opened | integer <int64> Number of opened messages |
Clicked | integer <int64> Number of clicked messages |
Unsubscribed | integer <int64> Number of unsubscribed messages |
Complaints | integer <int64> Number of complaint messages |
Inbound | integer <int64> Number of inbound messages |
ManualCancel | integer <int64> Number of manually cancelled messages |
NotDelivered | integer <int64> Number of messages flagged with 'Not Delivered' |
Response samples
- 200
[- {
- "ChannelName": "string",
- "Recipients": "1234",
- "EmailTotal": "1234",
- "SmsTotal": "12",
- "Delivered": "1000",
- "Bounced": "1000",
- "InProgress": "1234",
- "Opened": "1000",
- "Clicked": "1000",
- "Unsubscribed": "1000",
- "Complaints": "1000",
- "Inbound": "1000",
- "ManualCancel": "1000",
- "NotDelivered": "0"
}
]
Load Channel Stats
Retrieve an existing channel stats. Required Access Level: ViewChannels
Authorizations:
path Parameters
name required | string <string> The name of the channel to get. |
Responses
Response Schema: application/json
ChannelName | string <string> Channel name |
Recipients | integer <int64> Number of recipients |
EmailTotal | integer <int64> Number of emails |
SmsTotal | integer <int64> Number of SMS |
Delivered | integer <int64> Number of delivered messages |
Bounced | integer <int64> Number of bounced messages |
InProgress | integer <int64> Number of messages in progress |
Opened | integer <int64> Number of opened messages |
Clicked | integer <int64> Number of clicked messages |
Unsubscribed | integer <int64> Number of unsubscribed messages |
Complaints | integer <int64> Number of complaint messages |
Inbound | integer <int64> Number of inbound messages |
ManualCancel | integer <int64> Number of manually cancelled messages |
NotDelivered | integer <int64> Number of messages flagged with 'Not Delivered' |
Response samples
- 200
{- "ChannelName": "string",
- "Recipients": "1234",
- "EmailTotal": "1234",
- "SmsTotal": "12",
- "Delivered": "1000",
- "Bounced": "1000",
- "InProgress": "1234",
- "Opened": "1000",
- "Clicked": "1000",
- "Unsubscribed": "1000",
- "Complaints": "1000",
- "Inbound": "1000",
- "ManualCancel": "1000",
- "NotDelivered": "0"
}
Load SubAccounts
Returns a list of all your SubAccounts. Required Access Level: ViewSubAccounts
Authorizations:
query Parameters
limit | integer <int32> Default: "0" Example: limit=100 Maximum number of returned items. |
offset | integer <int32> Default: "0" Example: offset=20 How many items should be returned ahead. |
Responses
Response Schema: application/json
PublicAccountID | string <string> Public key for limited access to your Account such as contact/add so you can use it safely on public websites. |
string <string> Proper email address. | |
object (SubaccountSettingsInfo) SubAccount settings | |
LastActivity | string <date-time> Date of last activity on Account |
EmailCredits | integer <int32> Amount of email credits |
TotalEmailsSent | integer <int64> Amount of emails sent from this Account |
Reputation | number <double> Numeric reputation |
Status | string (AccountStatusEnum) Default: "Disabled" Enum: "Disabled" "UnderReview" "NeverSignedIn" "Active" |
ContactsCount | integer <int32> How many contacts this SubAccount has stored |
Response samples
- 200
[- {
- "PublicAccountID": "EB3EBB7A-C20D-4D39-8F2F-5E6842F58E6F",
- "Email": "mail@example.com",
- "Settings": {
- "Email": {
- "MonthlyRefillCredits": "1000",
- "RequiresEmailCredits": "true",
- "EmailSizeLimit": "10",
- "DailySendLimit": "100000",
- "MaxContacts": 0,
- "EnablePrivateIPPurchase": true,
- "PoolName": "My Custom Pool",
- "ValidSenderDomainOnly": null
}
}, - "LastActivity": "2001-01-01T12:00:00",
- "EmailCredits": "1000",
- "TotalEmailsSent": "1000",
- "Reputation": "100",
- "Status": "Disabled",
- "ContactsCount": 0
}
]
Add SubAccount
Add a new SubAccount to your Account. To receive an access token for this SubAccount, make a POST security/apikeys request using the 'subaccount' parameter. Required Access Level: ModifySubAccounts
Authorizations:
Request Body schema: application/json
Email required | string <string> Proper email address. |
Password required | string <string> Current password. |
SendActivation | boolean <boolean> True, if you want to send activation email to this Account to confirm the creation of a new SubAccount. Otherwise, false (SubAccount will immediately be Active). |
object (SubaccountSettingsInfoPayload) SubAccount settings |
Responses
Response Schema: application/json
PublicAccountID | string <string> Public key for limited access to your Account such as contact/add so you can use it safely on public websites. |
string <string> Proper email address. | |
object (SubaccountSettingsInfo) SubAccount settings | |
LastActivity | string <date-time> Date of last activity on Account |
EmailCredits | integer <int32> Amount of email credits |
TotalEmailsSent | integer <int64> Amount of emails sent from this Account |
Reputation | number <double> Numeric reputation |
Status | string (AccountStatusEnum) Default: "Disabled" Enum: "Disabled" "UnderReview" "NeverSignedIn" "Active" |
ContactsCount | integer <int32> How many contacts this SubAccount has stored |
Request samples
- Payload
{- "Email": "mail@example.com",
- "Password": "********",
- "SendActivation": true,
- "Settings": {
- "Email": {
- "RequiresEmailCredits": "true",
- "EmailSizeLimit": "10",
- "DailySendLimit": "100000",
- "MaxContacts": 0,
- "EnablePrivateIPPurchase": true,
- "PoolName": "My Custom Pool",
- "ValidSenderDomainOnly": null
}
}
}
Response samples
- 201
{- "PublicAccountID": "EB3EBB7A-C20D-4D39-8F2F-5E6842F58E6F",
- "Email": "mail@example.com",
- "Settings": {
- "Email": {
- "MonthlyRefillCredits": "1000",
- "RequiresEmailCredits": "true",
- "EmailSizeLimit": "10",
- "DailySendLimit": "100000",
- "MaxContacts": 0,
- "EnablePrivateIPPurchase": true,
- "PoolName": "My Custom Pool",
- "ValidSenderDomainOnly": null
}
}, - "LastActivity": "2001-01-01T12:00:00",
- "EmailCredits": "1000",
- "TotalEmailsSent": "1000",
- "Reputation": "100",
- "Status": "Disabled",
- "ContactsCount": 0
}
Load SubAccount
Returns details for the specified SubAccount. Required Access Level: ViewSubAccounts
Authorizations:
path Parameters
email required | string <string> Example: mail@example.com Email address of Sub-Account |
Responses
Response Schema: application/json
PublicAccountID | string <string> Public key for limited access to your Account such as contact/add so you can use it safely on public websites. |
string <string> Proper email address. | |
object (SubaccountSettingsInfo) SubAccount settings | |
LastActivity | string <date-time> Date of last activity on Account |
EmailCredits | integer <int32> Amount of email credits |
TotalEmailsSent | integer <int64> Amount of emails sent from this Account |
Reputation | number <double> Numeric reputation |
Status | string (AccountStatusEnum) Default: "Disabled" Enum: "Disabled" "UnderReview" "NeverSignedIn" "Active" |
ContactsCount | integer <int32> How many contacts this SubAccount has stored |
Response samples
- 200
{- "PublicAccountID": "EB3EBB7A-C20D-4D39-8F2F-5E6842F58E6F",
- "Email": "mail@example.com",
- "Settings": {
- "Email": {
- "MonthlyRefillCredits": "1000",
- "RequiresEmailCredits": "true",
- "EmailSizeLimit": "10",
- "DailySendLimit": "100000",
- "MaxContacts": 0,
- "EnablePrivateIPPurchase": true,
- "PoolName": "My Custom Pool",
- "ValidSenderDomainOnly": null
}
}, - "LastActivity": "2001-01-01T12:00:00",
- "EmailCredits": "1000",
- "TotalEmailsSent": "1000",
- "Reputation": "100",
- "Status": "Disabled",
- "ContactsCount": 0
}
Add, Subtract Email Credits
Update email credits of a subaccount by the given amount. Required Access Level: ModifySubAccounts
Authorizations:
path Parameters
email required | string <string> Example: mail@example.com Email address of Sub-Account |
Request Body schema: application/json
Amount of email credits to add or subtract from the current SubAccount email credits pool (positive or negative value)
Credits required | integer <int32> Positive or negative value; this will be added or subtracted from Subaccount's current email Credits pool. |
Notes | string <string> Note to append to this credits change, for history. |
Responses
Request samples
- Payload
{- "Credits": 0,
- "Notes": "string"
}
Update SubAccount Email Settings
Update SubAccount email settings. Required Access Level: ModifySubAccounts
Authorizations:
path Parameters
email required | string <string> string |
Request Body schema: application/json
Updated Email Settings
MonthlyRefillCredits | integer <int32> Amount of credits added to Account automatically |
RequiresEmailCredits | boolean <boolean> True, if Account needs credits to send emails. Otherwise, false |
EmailSizeLimit | integer <int32> Maximum size of email including attachments in MB's |
DailySendLimit | integer <int32> Amount of emails Account can send daily |
MaxContacts | integer <int32> Maximum number of contacts the Account can have. 0 means that parent account's limit is used. |
EnablePrivateIPPurchase | boolean <boolean> Can the SubAccount purchase Private IP for themselves |
PoolName | string <string> Name of your custom IP Pool to be used in the sending process |
ValidSenderDomainOnly | boolean or null <boolean> |
Responses
Response Schema: application/json
MonthlyRefillCredits | integer <int32> Amount of credits added to Account automatically |
RequiresEmailCredits | boolean <boolean> True, if Account needs credits to send emails. Otherwise, false |
EmailSizeLimit | integer <int32> Maximum size of email including attachments in MB's |
DailySendLimit | integer <int32> Amount of emails Account can send daily |
MaxContacts | integer <int32> Maximum number of contacts the Account can have. 0 means that parent account's limit is used. |
EnablePrivateIPPurchase | boolean <boolean> Can the SubAccount purchase Private IP for themselves |
PoolName | string <string> Name of your custom IP Pool to be used in the sending process |
ValidSenderDomainOnly | boolean or null <boolean> |
Request samples
- Payload
{- "MonthlyRefillCredits": "1000",
- "RequiresEmailCredits": "true",
- "EmailSizeLimit": "10",
- "DailySendLimit": "100000",
- "MaxContacts": 0,
- "EnablePrivateIPPurchase": true,
- "PoolName": "My Custom Pool",
- "ValidSenderDomainOnly": null
}
Response samples
- 201
{- "MonthlyRefillCredits": "1000",
- "RequiresEmailCredits": "true",
- "EmailSizeLimit": "10",
- "DailySendLimit": "100000",
- "MaxContacts": 0,
- "EnablePrivateIPPurchase": true,
- "PoolName": "My Custom Pool",
- "ValidSenderDomainOnly": null
}
Get Suppressions
Retrieve your suppressions. Required Access Level: ViewContacts, ViewSuppressions
Authorizations:
query Parameters
limit | integer <int32> Default: "0" Example: limit=100 Maximum number of returned items. |
offset | integer <int32> Default: "0" Example: offset=20 How many items should be returned ahead. |
Responses
Response Schema: application/json
string <string> Proper email address. | |
FriendlyErrorMessage | string <string> RFC error message |
ErrorCode | integer or null <int32> SMTP Error code |
DateUpdated | string or null <date-time> Last change date |
Response samples
- 200
[- {
- "Email": "mail@example.com",
- "FriendlyErrorMessage": "Mailbox not found",
- "ErrorCode": null,
- "DateUpdated": "2001-01-01T12:00:00"
}
]
Get Suppression
Retrieve your suppression. Required Access Level: ViewContacts, ViewSuppressions
Authorizations:
path Parameters
email required | string <string> Example: mail@example.com Proper email address. |
Responses
Response Schema: application/json
string <string> Proper email address. | |
FriendlyErrorMessage | string <string> RFC error message |
ErrorCode | integer or null <int32> SMTP Error code |
DateUpdated | string or null <date-time> Last change date |
Response samples
- 200
{- "Email": "mail@example.com",
- "FriendlyErrorMessage": "Mailbox not found",
- "ErrorCode": null,
- "DateUpdated": "2001-01-01T12:00:00"
}
Get Bounce List
Retrieve your list of bounced emails. Required Access Level: ViewContacts, ViewSuppressions
Authorizations:
query Parameters
search | string <string> Example: search=text Text fragment used for searching. |
limit | integer <int32> Default: "0" Example: limit=100 Maximum number of returned items. |
offset | integer <int32> Default: "0" Example: offset=20 How many items should be returned ahead. |
Responses
Response Schema: application/json
string <string> Proper email address. | |
FriendlyErrorMessage | string <string> RFC error message |
ErrorCode | integer or null <int32> SMTP Error code |
DateUpdated | string or null <date-time> Last change date |
Response samples
- 200
[- {
- "Email": "mail@example.com",
- "FriendlyErrorMessage": "Mailbox not found",
- "ErrorCode": null,
- "DateUpdated": "2001-01-01T12:00:00"
}
]
Add Bounces
Add Bounced. Required Access Level: ModifyContacts, ModifySuppressions
Authorizations:
Request Body schema: application/json
Emails to add as bounces. Limited to 1000 per request
Responses
Response Schema: application/json
string <string> Proper email address. | |
FriendlyErrorMessage | string <string> RFC error message |
ErrorCode | integer or null <int32> SMTP Error code |
DateUpdated | string or null <date-time> Last change date |
Request samples
- Payload
[- "string"
]
Response samples
- 201
[- {
- "Email": "mail@example.com",
- "FriendlyErrorMessage": "Mailbox not found",
- "ErrorCode": null,
- "DateUpdated": "2001-01-01T12:00:00"
}
]
Get Complaints List
Retrieve your list of complaints. Required Access Level: ViewContacts, ViewSuppressions
Authorizations:
query Parameters
search | string <string> Example: search=text Text fragment used for searching. |
limit | integer <int32> Default: "0" Example: limit=100 Maximum number of returned items. |
offset | integer <int32> Default: "0" Example: offset=20 How many items should be returned ahead. |
Responses
Response Schema: application/json
string <string> Proper email address. | |
FriendlyErrorMessage | string <string> RFC error message |
ErrorCode | integer or null <int32> SMTP Error code |
DateUpdated | string or null <date-time> Last change date |
Response samples
- 200
[- {
- "Email": "mail@example.com",
- "FriendlyErrorMessage": "Mailbox not found",
- "ErrorCode": null,
- "DateUpdated": "2001-01-01T12:00:00"
}
]
Add Complaints
Add Complaints. Required Access Level: ModifyContacts, ModifySuppressions
Authorizations:
Request Body schema: application/json
Emails to add as complaints. Limited to 1000 per request
Responses
Response Schema: application/json
string <string> Proper email address. | |
FriendlyErrorMessage | string <string> RFC error message |
ErrorCode | integer or null <int32> SMTP Error code |
DateUpdated | string or null <date-time> Last change date |
Request samples
- Payload
[- "string"
]
Response samples
- 201
[- {
- "Email": "mail@example.com",
- "FriendlyErrorMessage": "Mailbox not found",
- "ErrorCode": null,
- "DateUpdated": "2001-01-01T12:00:00"
}
]
Get Unsubscribes List
Retrieve your list of unsubscribes. Required Access Level: ViewContacts, ViewSuppressions
Authorizations:
query Parameters
search | string <string> Example: search=text Text fragment used for searching. |
limit | integer <int32> Default: "0" Example: limit=100 Maximum number of returned items. |
offset | integer <int32> Default: "0" Example: offset=20 How many items should be returned ahead. |
Responses
Response Schema: application/json
string <string> Proper email address. | |
FriendlyErrorMessage | string <string> RFC error message |
ErrorCode | integer or null <int32> SMTP Error code |
DateUpdated | string or null <date-time> Last change date |
Response samples
- 200
[- {
- "Email": "mail@example.com",
- "FriendlyErrorMessage": "Mailbox not found",
- "ErrorCode": null,
- "DateUpdated": "2001-01-01T12:00:00"
}
]
Add Unsubscribes
Add Unsubscribes. Required Access Level: ModifyContacts, ModifySuppressions
Authorizations:
Request Body schema: application/json
Emails to add as unsubscribes. Limited to 1000 per request
Responses
Response Schema: application/json
string <string> Proper email address. | |
FriendlyErrorMessage | string <string> RFC error message |
ErrorCode | integer or null <int32> SMTP Error code |
DateUpdated | string or null <date-time> Last change date |
Request samples
- Payload
[- "string"
]
Response samples
- 201
[- {
- "Email": "mail@example.com",
- "FriendlyErrorMessage": "Mailbox not found",
- "ErrorCode": null,
- "DateUpdated": "2001-01-01T12:00:00"
}
]
Load Templates
Returns a list of templates for the specified type. Required Access Level: ViewTemplates
Authorizations:
query Parameters
scopeType required | Array of strings (TemplateScope) Items Enum: "Personal" "Global" Return templates with specified scope only |
templateTypes | Array of strings (TemplateType) Items Enum: "RawHTML" "DragDropEditor" "LandingPageEditor" "TemplateEditor" "FormTemplate" "LandingPageTemplate" "PaymentConfirmationTemplate" "LandingPageProductTemplate" "LandingPageCheckoutTemplate" "LandingPagePaymentConfirmationTemplate" Return templates with specified type only |
limit | integer <int32> Default: "500" Example: limit=100 Maximum number of returned items. |
offset | integer <int32> Default: "0" Example: offset=20 How many items should be returned ahead. |
Responses
Response Schema: application/json
TemplateType | string (TemplateType) Default: "RawHTML" Enum: "RawHTML" "DragDropEditor" "LandingPageEditor" "TemplateEditor" "FormTemplate" "LandingPageTemplate" "PaymentConfirmationTemplate" "LandingPageProductTemplate" "LandingPageCheckoutTemplate" "LandingPagePaymentConfirmationTemplate" |
Name | string <string> Template name |
DateAdded | string <date-time> Date of creation in YYYY-MM-DDThh:ii:ss format |
Subject | string <string> Default subject of email. |
Array of objects (BodyPart) [ items ] Email content of this template | |
TemplateScope | string (TemplateScope) Default: "Personal" Enum: "Personal" "Global" Visibility of a template |
Response samples
- 200
[- {
- "TemplateType": "RawHTML",
- "Name": "string",
- "DateAdded": "2001-01-01T12:00:00",
- "Subject": "Hello!",
- "Body": [
- {
- "ContentType": "HTML",
- "Content": "string",
- "Charset": "string"
}
], - "TemplateScope": "Personal"
}
]
Add Template
Add a new Template. Required Access Level: ModifyTemplates
Authorizations:
Request Body schema: application/json
Name required | string <string> Template name |
Subject | string <string> Default subject of email. |
Array of objects (BodyPart) [ items ] Email content of this template | |
TemplateScope | string (TemplateScope) Default: "Personal" Enum: "Personal" "Global" Visibility of a template |
Responses
Response Schema: application/json
TemplateType | string (TemplateType) Default: "RawHTML" Enum: "RawHTML" "DragDropEditor" "LandingPageEditor" "TemplateEditor" "FormTemplate" "LandingPageTemplate" "PaymentConfirmationTemplate" "LandingPageProductTemplate" "LandingPageCheckoutTemplate" "LandingPagePaymentConfirmationTemplate" |
Name | string <string> Template name |
DateAdded | string <date-time> Date of creation in YYYY-MM-DDThh:ii:ss format |
Subject | string <string> Default subject of email. |
Array of objects (BodyPart) [ items ] Email content of this template | |
TemplateScope | string (TemplateScope) Default: "Personal" Enum: "Personal" "Global" Visibility of a template |
Request samples
- Payload
{- "Name": "string",
- "Subject": "Hello!",
- "Body": [
- {
- "ContentType": "HTML",
- "Content": "string",
- "Charset": "string"
}
], - "TemplateScope": "Personal"
}
Response samples
- 201
{- "TemplateType": "RawHTML",
- "Name": "string",
- "DateAdded": "2001-01-01T12:00:00",
- "Subject": "Hello!",
- "Body": [
- {
- "ContentType": "HTML",
- "Content": "string",
- "Charset": "string"
}
], - "TemplateScope": "Personal"
}
Load Template
Load detailed information of the specified template. Required Access Level: ViewTemplates
Authorizations:
path Parameters
name required | string <string> Example: Template01 Name of template. |
Responses
Response Schema: application/json
TemplateType | string (TemplateType) Default: "RawHTML" Enum: "RawHTML" "DragDropEditor" "LandingPageEditor" "TemplateEditor" "FormTemplate" "LandingPageTemplate" "PaymentConfirmationTemplate" "LandingPageProductTemplate" "LandingPageCheckoutTemplate" "LandingPagePaymentConfirmationTemplate" |
Name | string <string> Template name |
DateAdded | string <date-time> Date of creation in YYYY-MM-DDThh:ii:ss format |
Subject | string <string> Default subject of email. |
Array of objects (BodyPart) [ items ] Email content of this template | |
TemplateScope | string (TemplateScope) Default: "Personal" Enum: "Personal" "Global" Visibility of a template |
Response samples
- 200
{- "TemplateType": "RawHTML",
- "Name": "string",
- "DateAdded": "2001-01-01T12:00:00",
- "Subject": "Hello!",
- "Body": [
- {
- "ContentType": "HTML",
- "Content": "string",
- "Charset": "string"
}
], - "TemplateScope": "Personal"
}
Update Template
Update existing template, overwriting existing data. Required Access Level: ModifyTemplates
Authorizations:
path Parameters
name required | string <string> Example: Template01 Name of template. |
Request Body schema: application/json
Name required | string <string> Template name |
Subject | string <string> Default subject of email. |
Array of objects (BodyPart) [ items ] Email content of this template | |
TemplateScope | string (TemplateScope) Default: "Personal" Enum: "Personal" "Global" Visibility of a template |
Responses
Response Schema: application/json
TemplateType | string (TemplateType) Default: "RawHTML" Enum: "RawHTML" "DragDropEditor" "LandingPageEditor" "TemplateEditor" "FormTemplate" "LandingPageTemplate" "PaymentConfirmationTemplate" "LandingPageProductTemplate" "LandingPageCheckoutTemplate" "LandingPagePaymentConfirmationTemplate" |
Name | string <string> Template name |
DateAdded | string <date-time> Date of creation in YYYY-MM-DDThh:ii:ss format |
Subject | string <string> Default subject of email. |
Array of objects (BodyPart) [ items ] Email content of this template | |
TemplateScope | string (TemplateScope) Default: "Personal" Enum: "Personal" "Global" Visibility of a template |
Request samples
- Payload
{- "Name": "string",
- "Subject": "Hello!",
- "Body": [
- {
- "ContentType": "HTML",
- "Content": "string",
- "Charset": "string"
}
], - "TemplateScope": "Personal"
}
Response samples
- 200
{- "TemplateType": "RawHTML",
- "Name": "string",
- "DateAdded": "2001-01-01T12:00:00",
- "Subject": "Hello!",
- "Body": [
- {
- "ContentType": "HTML",
- "Content": "string",
- "Charset": "string"
}
], - "TemplateScope": "Personal"
}
Get Emails Verification Results
Returns a results of all verified single emails. Required Access Level: VerifyEmails
Authorizations:
query Parameters
limit | integer <int32> Default: "0" Example: limit=100 Maximum number of returned items. |
offset | integer <int32> Default: "0" Example: offset=20 How many items should be returned ahead. |
Responses
Response Schema: application/json
Account | string <string> Local part of an email |
Domain | string <string> Name of selected domain. |
string <string> Full email address that was verified | |
SuggestedSpelling | string <string> Suggested spelling if a possible mistake was found |
Disposable | boolean <boolean> Does the email have a temporary domain |
Role | boolean <boolean> Is an email a role email (e.g. info@, noreply@ etc.) |
Reason | string <string> All detected issues |
DateAdded | string <date-time> Added date |
Result | string (EmailValidationStatus) Default: "None" Enum: "None" "Valid" "Unknown" "Risky" "Invalid" |
PredictedScore | number <single> Predicted score |
PredictedStatus | string (EmailPredictedValidationStatus) Default: "None" Enum: "None" "Valid" "LowRisk" "HighRisk" "Invalid" |
Response samples
- 200
[- {
- "Account": "string",
- "Domain": "example.com",
- "Email": "string",
- "SuggestedSpelling": "string",
- "Disposable": true,
- "Role": true,
- "Reason": "string",
- "DateAdded": "2019-08-24T14:15:22Z",
- "Result": "None",
- "PredictedScore": 0,
- "PredictedStatus": "None"
}
]
Get Email Verification Result
Returns a result of verified email. Required Access Level: VerifyEmails
Authorizations:
path Parameters
email required | string <string> Email address to view verification result of |
Responses
Response Schema: application/json
Account | string <string> Local part of an email |
Domain | string <string> Name of selected domain. |
string <string> Full email address that was verified | |
SuggestedSpelling | string <string> Suggested spelling if a possible mistake was found |
Disposable | boolean <boolean> Does the email have a temporary domain |
Role | boolean <boolean> Is an email a role email (e.g. info@, noreply@ etc.) |
Reason | string <string> All detected issues |
DateAdded | string <date-time> Added date |
Result | string (EmailValidationStatus) Default: "None" Enum: "None" "Valid" "Unknown" "Risky" "Invalid" |
PredictedScore | number <single> Predicted score |
PredictedStatus | string (EmailPredictedValidationStatus) Default: "None" Enum: "None" "Valid" "LowRisk" "HighRisk" "Invalid" |
Response samples
- 200
{- "Account": "string",
- "Domain": "example.com",
- "Email": "string",
- "SuggestedSpelling": "string",
- "Disposable": true,
- "Role": true,
- "Reason": "string",
- "DateAdded": "2019-08-24T14:15:22Z",
- "Result": "None",
- "PredictedScore": 0,
- "PredictedStatus": "None"
}
Verify Email
Verify single email address and returns result of verification. Required Access Level: VerifyEmails
Authorizations:
path Parameters
email required | string <string> Email address to verify |
Responses
Response Schema: application/json
Account | string <string> Local part of an email |
Domain | string <string> Name of selected domain. |
string <string> Full email address that was verified | |
SuggestedSpelling | string <string> Suggested spelling if a possible mistake was found |
Disposable | boolean <boolean> Does the email have a temporary domain |
Role | boolean <boolean> Is an email a role email (e.g. info@, noreply@ etc.) |
Reason | string <string> All detected issues |
DateAdded | string <date-time> Added date |
Result | string (EmailValidationStatus) Default: "None" Enum: "None" "Valid" "Unknown" "Risky" "Invalid" |
PredictedScore | number <single> Predicted score |
PredictedStatus | string (EmailPredictedValidationStatus) Default: "None" Enum: "None" "Valid" "LowRisk" "HighRisk" "Invalid" |
Response samples
- 200
{- "Account": "string",
- "Domain": "example.com",
- "Email": "string",
- "SuggestedSpelling": "string",
- "Disposable": true,
- "Role": true,
- "Reason": "string",
- "DateAdded": "2019-08-24T14:15:22Z",
- "Result": "None",
- "PredictedScore": 0,
- "PredictedStatus": "None"
}
Upload File with Emails
Uploads a CSV file with list of emails that can then be triggered for verification. An 'email' column is required. Required Access Level: VerifyEmails
Authorizations:
Request Body schema: multipart/form-data
Uploaded file
file | string <binary> |
Responses
Response Schema: application/json
VerificationID | string <string> Identifier of this verification result |
Filename | string <string> Origin file name |
VerificationStatus | string (VerificationStatus) Default: "Processing" Enum: "Processing" "Ready" "Expired" "Verified" "Error" |
object (FileUploadResult) | |
DateAdded | string <date-time> Date of creation in YYYY-MM-DDThh:ii:ss format |
Source | string <string> Origin file extension |
Response samples
- 200
{- "VerificationID": "string",
- "Filename": "string",
- "VerificationStatus": "Processing",
- "FileUploadResult": {
- "EmailsCount": 0,
- "DuplicatedEmailsCount": 0
}, - "DateAdded": "2001-01-01T12:00:00",
- "Source": "string"
}
Get Detailed File Verification Result
Returns status and results (if verified) of file with given ID. Required Access Level: VerifyEmails
Authorizations:
path Parameters
id required | string <string> ID of the Verification to display status of |
query Parameters
limit | integer <int32> Default: "0" Maximum number of returned email verification results |
offset | integer <int32> Default: "0" How many result items should be returned ahead |
Responses
Response Schema: application/json
Array of objects (EmailValidationResult) [ items ] Verification result's details | |
VerificationID | string <string> Identifier of this verification result |
Filename | string <string> Origin file name |
VerificationStatus | string (VerificationStatus) Default: "Processing" Enum: "Processing" "Ready" "Expired" "Verified" "Error" |
object (FileUploadResult) | |
DateAdded | string <date-time> Date of creation in YYYY-MM-DDThh:ii:ss format |
Source | string <string> Origin file extension |
Response samples
- 200
{- "VerificationResult": [
- {
- "Account": "string",
- "Domain": "example.com",
- "Email": "string",
- "SuggestedSpelling": "string",
- "Disposable": true,
- "Role": true,
- "Reason": "string",
- "DateAdded": "2019-08-24T14:15:22Z",
- "Result": "None",
- "PredictedScore": 0,
- "PredictedStatus": "None"
}
], - "VerificationID": "string",
- "Filename": "string",
- "VerificationStatus": "Processing",
- "FileUploadResult": {
- "EmailsCount": 0,
- "DuplicatedEmailsCount": 0
}, - "DateAdded": "2001-01-01T12:00:00",
- "Source": "string"
}
Get Files Verification Results
Returns a list of uploaded files, their statuses and results. Required Access Level: VerifyEmails
Authorizations:
Responses
Response Schema: application/json
VerificationID | string <string> Identifier of this verification result |
Filename | string <string> Origin file name |
VerificationStatus | string (VerificationStatus) Default: "Processing" Enum: "Processing" "Ready" "Expired" "Verified" "Error" |
object (FileUploadResult) | |
DateAdded | string <date-time> Date of creation in YYYY-MM-DDThh:ii:ss format |
Source | string <string> Origin file extension |
Response samples
- 200
[- {
- "VerificationID": "string",
- "Filename": "string",
- "VerificationStatus": "Processing",
- "FileUploadResult": {
- "EmailsCount": 0,
- "DuplicatedEmailsCount": 0
}, - "DateAdded": "2001-01-01T12:00:00",
- "Source": "string"
}
]
To The Top