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

Authentication

apikey

Security Scheme Type API Key
Header parameter name: X-ElasticEmail-ApiKey

Campaigns

Sending and monitoring progress of your Campaigns

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
Array
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

Content type
application/json
[
  • {
    }
]

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

Content type
application/json
{
  • "Content": [
    ],
  • "Name": "string",
  • "Status": "Deleted",
  • "Recipients": {
    },
  • "Options": {
    }
}

Response samples

Content type
application/json
{
  • "Content": [
    ],
  • "Name": "string",
  • "Status": "Deleted",
  • "Recipients": {
    },
  • "Options": {
    }
}

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

Content type
application/json
{
  • "Content": [
    ],
  • "Name": "string",
  • "Status": "Deleted",
  • "Recipients": {
    },
  • "Options": {
    }
}

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

Content type
application/json
{
  • "Content": [
    ],
  • "Name": "string",
  • "Status": "Deleted",
  • "Recipients": {
    },
  • "Options": {
    }
}

Response samples

Content type
application/json
{
  • "Content": [
    ],
  • "Name": "string",
  • "Status": "Deleted",
  • "Recipients": {
    },
  • "Options": {
    }
}

Delete Campaign

Delete the specific campaign. This does not cancel in progress email, see Cancel In Progress. Required Access Level: ModifyCampaigns

Authorizations:
path Parameters
name
required
string <string>

Name of Campaign to delete

Responses

Pause Campaign

Pauses the specific campaign, cancelling emails that are waiting to be sent. Required Access Level: ModifyCampaigns

Authorizations:
path Parameters
name
required
string <string>

Name of Campaign to pause

Responses

Contacts

Methods used to manage your Contacts.

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
Array
Email
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

Content type
application/json
[
  • {
    }
]

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
Array
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
Array
Email
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

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/json
[
  • {
    }
]

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
Email
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

Content type
application/json
{
  • "Email": "mail@example.com",
  • "Status": "Transactional",
  • "FirstName": "Fred",
  • "LastName": "Flintstone",
  • "CustomFields": {
    },
  • "Consent": {
    },
  • "Source": "DeliveryApi",
  • "DateAdded": "2001-01-01T12:00:00",
  • "DateUpdated": "2001-01-01T12:00:00",
  • "StatusChangeDate": "2001-01-01T12:00:00",
  • "Activity": {
    }
}

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
Email
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

Content type
application/json
{
  • "FirstName": "Fred",
  • "LastName": "Flintstone",
  • "CustomFields": {
    }
}

Response samples

Content type
application/json
{
  • "Email": "mail@example.com",
  • "Status": "Transactional",
  • "FirstName": "Fred",
  • "LastName": "Flintstone",
  • "CustomFields": {
    },
  • "Consent": {
    },
  • "Source": "DeliveryApi",
  • "DateAdded": "2001-01-01T12:00:00",
  • "DateUpdated": "2001-01-01T12:00:00",
  • "StatusChangeDate": "2001-01-01T12:00:00",
  • "Activity": {
    }
}

Delete Contact

Deletes the provided contact. Required Access Level: ModifyContacts

Authorizations:
path Parameters
email
required
string <string>
Example: mail@example.com

Proper email address.

Responses

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

Content type
application/json
{
  • "Rule": "string",
  • "Emails": [
    ]
}

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

Content type
application/json
{
  • "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
string (ExportStatus)
Default: "Error"
Enum: "Error" "Loading" "Ready" "Expired"

Current status of the export.

Response samples

Content type
application/json
"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

Domains

Domain Actions

Load Domains

Returns a list of all domains configured for this Account. Required Access Level: ViewSettings

Authorizations:

Responses

Response Schema: application/json
Array
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

Content type
application/json
[
  • {
    }
]

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

Content type
application/json
{
  • "Domain": "example.com",
  • "SetAsDefault": true
}

Response samples

Content type
application/json
{
  • "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

Content type
application/json
{
  • "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

Content type
application/json
{
  • "CertificateStatus": "ErrorOccured",
  • "VERP": true,
  • "CustomBouncesDomain": "string",
  • "IsCustomBouncesDomainDefault": true
}

Response samples

Content type
application/json
{
  • "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"
}

Delete Domain

Deletes configured domain from Account. Required Access Level: ModifySettings

Authorizations:
path Parameters
domain
required
string <string>

Name of the given domain

Responses

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
boolean <boolean>

Response samples

Content type
application/json
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

string
Enum: "None" "Delete" "Http" "ExternalHttps" "InternalCertHttps" "LetsEncryptCert"

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

Content type
application/json
"None"

Response samples

Content type
application/json
{
  • "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

Content type
application/json
{
  • "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"
}

Emails

Send your emails and see their statuses

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

Content type
application/json
{
  • "Recipients": [
    ],
  • "Content": {
    },
  • "Options": {
    }
}

Response samples

Content type
application/json
{
  • "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

Content type
application/json
{
  • "Preview": {
    },
  • "Attachments": [
    ],
  • "Status": {
    }
}

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

Content type
application/json
{
  • "ID": "123456",
  • "Status": "string",
  • "RecipientsCount": 0,
  • "Failed": [
    ],
  • "FailedCount": "1000",
  • "Sent": [
    ],
  • "SentCount": "1000",
  • "Delivered": [
    ],
  • "DeliveredCount": 0,
  • "Pending": [
    ],
  • "PendingCount": 0,
  • "Opened": [
    ],
  • "OpenedCount": "1000",
  • "Clicked": [
    ],
  • "ClickedCount": "1000",
  • "Unsubscribed": [
    ],
  • "UnsubscribedCount": "1000",
  • "AbuseReports": [
    ],
  • "AbuseReportsCount": 0,
  • "MessageIDs": [
    ]
}

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

Content type
application/json
{
  • "MergeFile": {
    },
  • "Content": {
    },
  • "Options": {
    }
}

Response samples

Content type
application/json
{
  • "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

Content type
application/json
{
  • "Recipients": {
    },
  • "Content": {
    },
  • "Options": {
    }
}

Response samples

Content type
application/json
{
  • "TransactionID": "TransactionID",
  • "MessageID": "-HHGPM_9RPhSMiaJq_ab4g3"
}

Events

Methods to check logs of your campaigns

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
Array
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

Content type
application/json
[
  • {
    }
]

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
Array
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

Content type
application/json
[
  • {
    }
]

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
Array
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

Content type
application/json
[
  • {
    }
]

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

Content type
application/json
{
  • "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
string (ExportStatus)
Default: "Error"
Enum: "Error" "Loading" "Ready" "Expired"

Current status of the export.

Response samples

Content type
application/json
"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

Content type
application/json
{
  • "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
string (ExportStatus)
Default: "Error"
Enum: "Error" "Loading" "Ready" "Expired"

Current status of the export.

Response samples

Content type
application/json
"Error"

Files

Manage the files on your account to be used as attachments in your email, templates, etc.

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
Array
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

Content type
application/json
[
  • {
    }
]

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

Content type
application/json
{
  • "BinaryContent": "string",
  • "Name": "attachment.txt",
  • "ContentType": "string"
}

Response samples

Content type
application/json
{
  • "FileName": "filename.txt",
  • "Size": "100",
  • "DateAdded": "2001-01-01T12:00:00",
  • "ExpirationDate": null,
  • "ContentType": "image/jpeg"
}

Download File

Gets content of the specified File. Required Access Level: ViewFiles

Authorizations:
path Parameters
name
required
string <string>
Example: filename.txt

Name of your file including extension.

Responses

Response Schema: application/*
string <binary>

Delete File

Permanently deletes the file from your Account. Required Access Level: ModifyFiles

Authorizations:
path Parameters
name
required
string <string>
Example: filename.txt

Name of your file including extension.

Responses

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

Content type
application/json
{
  • "FileName": "filename.txt",
  • "Size": "100",
  • "DateAdded": "2001-01-01T12:00:00",
  • "ExpirationDate": null,
  • "ContentType": "image/jpeg"
}

InboundRoute

Inbounds operations

Get Routes

Get all your Inbound Routes. Required Access Level: ViewSettings

Authorizations:

Responses

Response Schema: application/json
Array
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

Content type
application/json
[
  • {
    }
]

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

Content type
application/json
{
  • "Filter": "string",
  • "Name": "string",
  • "FilterType": "EmailAddress",
  • "ActionType": "ForwardToEmail",
  • "EmailAddress": "string",
  • "HttpAddress": "string"
}

Response samples

Content type
application/json
{
  • "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

Content type
application/json
{
  • "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

Content type
application/json
{
  • "Filter": "string",
  • "Name": "string",
  • "FilterType": "EmailAddress",
  • "ActionType": "ForwardToEmail",
  • "EmailAddress": "string",
  • "HttpAddress": "string"
}

Response samples

Content type
application/json
{
  • "PublicId": "string",
  • "Name": "string",
  • "FilterType": "EmailAddress",
  • "Filter": "string",
  • "ActionType": "ForwardToEmail",
  • "ActionParameter": "string",
  • "SortOrder": 0
}

Delete Route

Deletes the Inbound Route. Required Access Level: ModifySettings

Authorizations:
path Parameters
id
required
string <guid>

string

Responses

Update Sorting

Required Access Level: ViewSettings

Authorizations:
Request Body schema: application/json

Change the ordering of inbound routes for when matching the inbound

Array
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
Array
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

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/json
[
  • {
    }
]

Lists

API methods for managing your Lists

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
Array
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

Content type
application/json
[
  • {
    }
]

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

Content type
application/json
{
  • "ListName": "My List 1",
  • "AllowUnsubscribe": "true/false",
  • "Emails": [
    ]
}

Response samples

Content type
application/json
{
  • "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
Array
Email
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

Content type
application/json
[
  • {
    }
]

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

Content type
application/json
{
  • "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

Content type
application/json
{
  • "NewListName": "My List 2",
  • "AllowUnsubscribe": "true/false"
}

Response samples

Content type
application/json
{
  • "ListName": "My List 1",
  • "PublicListID": "E33EBA7A-C20D-4D3D-8F2F-5EEF42F58E6F",
  • "DateAdded": "2001-01-01T12:00:00",
  • "AllowUnsubscribe": "true/false"
}

Delete List

Deletes List and removes all the Contacts from it (does not delete Contacts). Required Access Level: ModifyContacts

Authorizations:
path Parameters
name
required
string <string>
Example: My List 1

Name of your list.

Responses

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

Content type
application/json
{
  • "Rule": "string",
  • "Emails": [
    ]
}

Response samples

Content type
application/json
{
  • "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

Content type
application/json
{
  • "Rule": "string",
  • "Emails": [
    ]
}

Security

Security methods

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
Array
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

Content type
application/json
[
  • {
    }
]

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

Content type
application/json
{
  • "Name": "string",
  • "AccessLevel": [
    ],
  • "Expires": null,
  • "RestrictAccessToIPRange": [
    ],
  • "Subaccount": "string"
}

Response samples

Content type
application/json
{
  • "Token": "string",
  • "AccessLevel": [
    ],
  • "Name": "string",
  • "DateCreated": "2019-08-24T14:15:22Z",
  • "LastUse": null,
  • "Expires": null,
  • "RestrictAccessToIPRange": [
    ]
}

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

Content type
application/json
{
  • "AccessLevel": [
    ],
  • "Name": "string",
  • "DateCreated": "2019-08-24T14:15:22Z",
  • "LastUse": null,
  • "Expires": null,
  • "RestrictAccessToIPRange": [
    ]
}

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

Content type
application/json
{
  • "Name": "string",
  • "AccessLevel": [
    ],
  • "Expires": null,
  • "RestrictAccessToIPRange": [
    ],
  • "Subaccount": "string"
}

Response samples

Content type
application/json
{
  • "AccessLevel": [
    ],
  • "Name": "string",
  • "DateCreated": "2019-08-24T14:15:22Z",
  • "LastUse": null,
  • "Expires": null,
  • "RestrictAccessToIPRange": [
    ]
}

Delete ApiKey

Delete your existing ApiKey. 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 deleted

Responses

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
Array
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

Content type
application/json
[
  • {
    }
]

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

Content type
application/json
{
  • "Name": "string",
  • "Expires": null,
  • "RestrictAccessToIPRange": [
    ],
  • "Subaccount": "string"
}

Response samples

Content type
application/json
{
  • "Token": "string",
  • "AccessLevel": "None",
  • "Name": "string",
  • "DateCreated": "2019-08-24T14:15:22Z",
  • "LastUse": null,
  • "Expires": null,
  • "RestrictAccessToIPRange": [
    ]
}

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

Content type
application/json
{
  • "AccessLevel": "None",
  • "Name": "string",
  • "DateCreated": "2019-08-24T14:15:22Z",
  • "LastUse": null,
  • "Expires": null,
  • "RestrictAccessToIPRange": [
    ]
}

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

Content type
application/json
{
  • "Name": "string",
  • "Expires": null,
  • "RestrictAccessToIPRange": [
    ],
  • "Subaccount": "string"
}

Response samples

Content type
application/json
{
  • "AccessLevel": "None",
  • "Name": "string",
  • "DateCreated": "2019-08-24T14:15:22Z",
  • "LastUse": null,
  • "Expires": null,
  • "RestrictAccessToIPRange": [
    ]
}

Delete SMTP Credential

Delete your existing SMTP Credentials. 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 deleted

Responses

Segments

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
Array
Name
string <string>

Segment name

Rule
string <string>

SQL-like rule to determine which Contacts belong to this Segment.

Response samples

Content type
application/json
[
  • {
    }
]

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

Content type
application/json
{
  • "Name": "string",
  • "Rule": "string"
}

Response samples

Content type
application/json
{
  • "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

Content type
application/json
{
  • "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

Content type
application/json
{
  • "Name": "string",
  • "Rule": "string"
}

Response samples

Content type
application/json
{
  • "Name": "string",
  • "Rule": "string"
}

Delete Segment

Delete an existing segment. Required Access Level: ModifyContacts

Authorizations:
path Parameters
name
required
string <string>
Example: My Segment 1

Name of your segment.

Responses

Statistics

Methods to check logs of your campaigns

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

Content type
application/json
{
  • "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
Array
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

Content type
application/json
[
  • {
    }
]

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

Content type
application/json
{
  • "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
Array
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

Content type
application/json
[
  • {
    }
]

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

Content type
application/json
{
  • "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"
}

SubAccounts

Manage your subaccounts

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
Array
PublicAccountID
string <string>

Public key for limited access to your Account such as contact/add so you can use it safely on public websites.

Email
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

Content type
application/json
[
  • {
    }
]

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.

Email
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

Content type
application/json
{
  • "Email": "mail@example.com",
  • "Password": "********",
  • "SendActivation": true,
  • "Settings": {
    }
}

Response samples

Content type
application/json
{
  • "PublicAccountID": "EB3EBB7A-C20D-4D39-8F2F-5E6842F58E6F",
  • "Email": "mail@example.com",
  • "Settings": {
    },
  • "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.

Email
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

Content type
application/json
{
  • "PublicAccountID": "EB3EBB7A-C20D-4D39-8F2F-5E6842F58E6F",
  • "Email": "mail@example.com",
  • "Settings": {
    },
  • "LastActivity": "2001-01-01T12:00:00",
  • "EmailCredits": "1000",
  • "TotalEmailsSent": "1000",
  • "Reputation": "100",
  • "Status": "Disabled",
  • "ContactsCount": 0
}

Delete SubAccount

Deletes specified SubAccount. An email will be sent to confirm this change. Required Access Level: ModifySubAccounts

Authorizations:
path Parameters
email
required
string <string>
Example: mail@example.com

Email address of Sub-Account

Responses

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

Content type
application/json
{
  • "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

Content type
application/json
{
  • "MonthlyRefillCredits": "1000",
  • "RequiresEmailCredits": "true",
  • "EmailSizeLimit": "10",
  • "DailySendLimit": "100000",
  • "MaxContacts": 0,
  • "EnablePrivateIPPurchase": true,
  • "PoolName": "My Custom Pool",
  • "ValidSenderDomainOnly": null
}

Response samples

Content type
application/json
{
  • "MonthlyRefillCredits": "1000",
  • "RequiresEmailCredits": "true",
  • "EmailSizeLimit": "10",
  • "DailySendLimit": "100000",
  • "MaxContacts": 0,
  • "EnablePrivateIPPurchase": true,
  • "PoolName": "My Custom Pool",
  • "ValidSenderDomainOnly": null
}

Suppressions

Methods used to manage your Suppressions.

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
Array
Email
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

Content type
application/json
[
  • {
    }
]

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
Email
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

Content type
application/json
{
  • "Email": "mail@example.com",
  • "FriendlyErrorMessage": "Mailbox not found",
  • "ErrorCode": null,
  • "DateUpdated": "2001-01-01T12:00:00"
}

Delete Suppression

Delete Suppression. Required Access Level: ViewContacts, ViewSuppressions

Authorizations:
path Parameters
email
required
string <string>
Example: mail@example.com

Proper email address.

Responses

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
Array
Email
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

Content type
application/json
[
  • {
    }
]

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

Array
string <string>

Responses

Response Schema: application/json
Array
Email
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

Content type
application/json
[
  • "string"
]

Response samples

Content type
application/json
[
  • {
    }
]

Add Bounces Async

Add Bounced. Required Access Level: ModifyContacts, ModifySuppressions

Authorizations:
Request Body schema: multipart/form-data

Emails to add as bounces.

file
string <binary>

Responses

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
Array
Email
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

Content type
application/json
[
  • {
    }
]

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

Array
string <string>

Responses

Response Schema: application/json
Array
Email
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

Content type
application/json
[
  • "string"
]

Response samples

Content type
application/json
[
  • {
    }
]

Add Complaints Async

Add Complaints. Required Access Level: ModifyContacts, ModifySuppressions

Authorizations:
Request Body schema: multipart/form-data

Emails to add as complaints.

file
string <binary>

Responses

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
Array
Email
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

Content type
application/json
[
  • {
    }
]

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

Array
string <string>

Responses

Response Schema: application/json
Array
Email
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

Content type
application/json
[
  • "string"
]

Response samples

Content type
application/json
[
  • {
    }
]

Add Unsubscribes Async

Add Unsubscribes. Required Access Level: ModifyContacts, ModifySuppressions

Authorizations:
Request Body schema: multipart/form-data

Emails to add as unsubscribes.

file
string <binary>

Responses

Templates

Managing and editing templates of your emails

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
Array
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

Content type
application/json
[
  • {
    }
]

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

Content type
application/json
{
  • "Name": "string",
  • "Subject": "Hello!",
  • "Body": [
    ],
  • "TemplateScope": "Personal"
}

Response samples

Content type
application/json
{
  • "TemplateType": "RawHTML",
  • "Name": "string",
  • "DateAdded": "2001-01-01T12:00:00",
  • "Subject": "Hello!",
  • "Body": [
    ],
  • "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

Content type
application/json
{
  • "TemplateType": "RawHTML",
  • "Name": "string",
  • "DateAdded": "2001-01-01T12:00:00",
  • "Subject": "Hello!",
  • "Body": [
    ],
  • "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

Content type
application/json
{
  • "Name": "string",
  • "Subject": "Hello!",
  • "Body": [
    ],
  • "TemplateScope": "Personal"
}

Response samples

Content type
application/json
{
  • "TemplateType": "RawHTML",
  • "Name": "string",
  • "DateAdded": "2001-01-01T12:00:00",
  • "Subject": "Hello!",
  • "Body": [
    ],
  • "TemplateScope": "Personal"
}

Delete Template

Delete template with the specified name. Required Access Level: ModifyTemplates

Authorizations:
path Parameters
name
required
string <string>
Example: Template01

Name of template.

Responses

Verifications

Verify emails and read the results

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
Array
Account
string <string>

Local part of an email

Domain
string <string>

Name of selected domain.

Email
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

Content type
application/json
[
  • {
    }
]

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.

Email
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

Content type
application/json
{
  • "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.

Email
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

Content type
application/json
{
  • "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"
}

Delete Email Verification Result

Delete a result with given email if exists. Required Access Level: VerifyEmails

Authorizations:
path Parameters
email
required
string <string>

Email address to verification

Responses

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

Content type
application/json
{
  • "VerificationID": "string",
  • "Filename": "string",
  • "VerificationStatus": "Processing",
  • "FileUploadResult": {
    },
  • "DateAdded": "2001-01-01T12:00:00",
  • "Source": "string"
}

Delete File Verification Result

Delete Verification Results if they exist. Required Access Level: VerifyEmails

Authorizations:
path Parameters
id
required
string <string>
Example: E33EBA7A-C20D-4D3D-8F2F-5EEF42F58E6F

ID of the exported file

Responses

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

Content type
application/json
{
  • "VerificationResult": [
    ],
  • "VerificationID": "string",
  • "Filename": "string",
  • "VerificationStatus": "Processing",
  • "FileUploadResult": {
    },
  • "DateAdded": "2001-01-01T12:00:00",
  • "Source": "string"
}

Download File Verification Result

Download verification results as a ZIP file. Required Access Level: VerifyEmails

Authorizations:
path Parameters
id
required
string <string>

Verification ID to download

Responses

Response Schema: application/*
string <binary>

Start verification

Start a verification of the previously uploaded file with emails. Required Access Level: VerifyEmails

Authorizations:
path Parameters
id
required
string <string>

File ID to start verification

Responses

Get Files Verification Results

Returns a list of uploaded files, their statuses and results. Required Access Level: VerifyEmails

Authorizations:

Responses

Response Schema: application/json
Array
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

Content type
application/json
[
  • {
    }
]

To The Top

{"openapi":"3.0.3","info":{"version":"4.0.0","contact":{"email":"support@elasticemail.com"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"description":"This API is based on the REST API architecture, allowing the user to easily manage their data with this resource-based approach.\r\n\r\nEvery API call is established on which specific request type (GET, POST, PUT, DELETE) will be used.\r\n\r\nThe API has a limit of 20 concurrent connections and a hard timeout of 600 seconds per request.\r\n\r\nTo 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.\r\n\r\nDownloadable library clients can be found in our Github repository here","termsOfService":"https://elasticemail.com/resources/usage-policies/terms-of-use/","title":"Elastic Email REST API"},"servers":[{"url":"https://api.elasticemail.com/v4"}],"tags":[{"description":"Sending and monitoring progress of your Campaigns","name":"Campaigns"},{"description":"Methods used to manage your Contacts.","name":"Contacts"},{"description":"Domain Actions","name":"Domains"},{"description":"Send your emails and see their statuses","name":"Emails"},{"description":"Methods to check logs of your campaigns","name":"Events"},{"description":"Manage the files on your account to be used as attachments in your email, templates, etc.","name":"Files"},{"description":"Inbounds operations","name":"InboundRoute"},{"description":"API methods for managing your Lists","name":"Lists"},{"description":"Security methods","name":"Security"},{"description":"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","name":"Segments"},{"description":"Methods to check logs of your campaigns","name":"Statistics"},{"description":"Manage your subaccounts","name":"SubAccounts"},{"description":"Methods used to manage your Suppressions.","name":"Suppressions"},{"description":"Managing and editing templates of your emails","name":"Templates"},{"description":"Verify emails and read the results","name":"Verifications"}],"paths":{"/campaigns":{"get":{"tags":["Campaigns"],"summary":"Load Campaigns","description":"Returns a list all of your campaigns. Limited to 1000 results. Required Access Level: ViewCampaigns","operationId":"campaignsGet","parameters":[{"name":"search","description":"Text fragment used for searching in Campaign name (using the 'contains' rule)","in":"query","required":false,"schema":{"format":"string","type":"string","description":"string"}},{"name":"offset","description":"How many items should be returned ahead.","in":"query","required":false,"schema":{"default":"0","example":"20","format":"int32","type":"integer","description":"integer"}},{"name":"limit","description":"Maximum number of returned items.","in":"query","required":false,"schema":{"default":"0","example":"100","format":"int32","type":"integer","description":"integer"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/Campaign"},"type":"array"}}}}}},"post":{"tags":["Campaigns"],"summary":"Add Campaign","description":"Add a campaign for processing. Required Access Level: ModifyCampaigns","operationId":"campaignsPost","responses":{"201":{"description":"Created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Campaign"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Campaign"}}},"description":"JSON representation of a campaign","required":true}}},"/campaigns/{name}":{"get":{"tags":["Campaigns"],"summary":"Load Campaign","description":"Returns the specified campaign details. Required Access Level: ViewCampaigns","operationId":"campaignsByNameGet","parameters":[{"name":"name","description":"Name of Campaign to get","in":"path","required":true,"schema":{"format":"string","type":"string","description":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Campaign"}}}}}},"put":{"tags":["Campaigns"],"summary":"Update Campaign","description":"Updates a previously added campaign. Only Active and Paused campaigns can be updated. Required Access Level: ModifyCampaigns","operationId":"campaignsByNamePut","parameters":[{"name":"name","description":"Name of Campaign to update","in":"path","required":true,"schema":{"format":"string","type":"string","description":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Campaign"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Campaign"}}},"description":"JSON representation of a campaign","required":true}},"delete":{"tags":["Campaigns"],"summary":"Delete Campaign","description":"Delete the specific campaign. This does not cancel in progress email, see Cancel In Progress. Required Access Level: ModifyCampaigns","operationId":"campaignsByNameDelete","parameters":[{"name":"name","description":"Name of Campaign to delete","in":"path","required":true,"schema":{"format":"string","type":"string","description":"string"}}],"responses":{"200":{"description":"OK"}}}},"/campaigns/{name}/pause":{"put":{"tags":["Campaigns"],"summary":"Pause Campaign","description":"Pauses the specific campaign, cancelling emails that are waiting to be sent. Required Access Level: ModifyCampaigns","operationId":"campaignsByNamePausePut","parameters":[{"name":"name","description":"Name of Campaign to pause","in":"path","required":true,"schema":{"format":"string","type":"string","description":"string"}}],"responses":{"200":{"description":"OK"}}}},"/contacts":{"get":{"tags":["Contacts"],"summary":"Load Contacts","description":"Returns a list of contacts. Required Access Level: ViewContacts","operationId":"contactsGet","parameters":[{"name":"limit","description":"Maximum number of returned items.","in":"query","required":false,"schema":{"default":"20","example":"100","format":"int32","type":"integer","description":"integer"}},{"name":"offset","description":"How many items should be returned ahead.","in":"query","required":false,"schema":{"default":"0","example":"20","format":"int32","type":"integer","description":"integer"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/Contact"},"type":"array"}}}}}},"post":{"tags":["Contacts"],"summary":"Add Contact","description":"Add new Contacts to your Lists. Up to 1000 can be added (for more please refer to the import request). Required Access Level: ModifyContacts","operationId":"contactsPost","parameters":[{"name":"listnames","description":"Names of lists to which the uploaded contacts should be added to","in":"query","required":false,"schema":{"items":{"format":"string","type":"string"},"type":"array","description":"array"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/Contact"},"type":"array"}}}}},"requestBody":{"content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/ContactPayload"},"type":"array"}}},"required":true}}},"/contacts/{email}":{"get":{"tags":["Contacts"],"summary":"Load Contact","description":"Load detailed contact information for specified email. Required Access Level: ViewContacts","operationId":"contactsByEmailGet","parameters":[{"name":"email","description":"Proper email address.","in":"path","required":true,"schema":{"example":"mail@example.com","format":"string","type":"string","description":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Contact"}}}}}},"put":{"tags":["Contacts"],"summary":"Update Contact","description":"Update selected contact. Omitted contact's fields will not be changed. Required Access Level: ModifyContacts","operationId":"contactsByEmailPut","parameters":[{"name":"email","description":"Proper email address.","in":"path","required":true,"schema":{"example":"mail@example.com","format":"string","type":"string","description":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Contact"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContactUpdatePayload"}}},"required":true}},"delete":{"tags":["Contacts"],"summary":"Delete Contact","description":"Deletes the provided contact. Required Access Level: ModifyContacts","operationId":"contactsByEmailDelete","parameters":[{"name":"email","description":"Proper email address.","in":"path","required":true,"schema":{"example":"mail@example.com","format":"string","type":"string","description":"string"}}],"responses":{"200":{"description":"OK"}}}},"/contacts/delete":{"post":{"tags":["Contacts"],"summary":"Delete Contacts Bulk","description":"Deletes provided contacts in bulk. Required Access Level: ModifyContacts","operationId":"contactsDeletePost","responses":{"200":{"description":"OK"}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/EmailsPayload"}}},"description":"Provide either rule or a list of emails, not both.","required":true}}},"/contacts/export":{"post":{"tags":["Contacts"],"summary":"Export Contacts","description":"Request an Export of specified Contacts. Required Access Level: Export","operationId":"contactsExportPost","parameters":[{"name":"fileFormat","description":"Format of the exported file","in":"query","required":false,"schema":{"$ref":"#/components/schemas/ExportFileFormats"}},{"name":"rule","description":"Query used for filtering.","in":"query","required":false,"schema":{"example":"Status%20=%20Engaged","format":"string","type":"string","description":"string"}},{"name":"emails","description":"Comma delimited list of contact emails","in":"query","required":false,"schema":{"example":["mail@contact.com,mail1@contact.com,mail2@contact.com"],"items":{"format":"string","type":"string"},"type":"array","description":"array"}},{"name":"compressionFormat","description":"FileResponse compression format. None or Zip.","in":"query","required":false,"schema":{"$ref":"#/components/schemas/CompressionFormat"}},{"name":"fileName","description":"Name of your file including extension.","in":"query","required":false,"schema":{"example":"filename.txt","format":"string","type":"string","description":"string"}}],"responses":{"202":{"description":"Accepted","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExportLink"}}}}}}},"/contacts/export/{id}/status":{"get":{"tags":["Contacts"],"summary":"Check Export Status","description":"Check the current status of the export. Required Access Level: Export","operationId":"contactsExportByIdStatusGet","parameters":[{"name":"id","description":"ID of the exported file","in":"path","required":true,"schema":{"example":"E33EBA7A-C20D-4D3D-8F2F-5EEF42F58E6F","format":"guid","type":"string","description":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExportStatus"}}}}}}},"/contacts/import":{"post":{"tags":["Contacts"],"summary":"Upload Contacts","description":"Upload contacts from a file. Required Access Level: ModifyContacts","operationId":"contactsImportPost","parameters":[{"name":"listName","description":"Name of an existing list to add these contacts to","in":"query","required":false,"schema":{"format":"string","type":"string","description":"string"}},{"name":"encodingName","description":"In what encoding the file is uploaded","in":"query","required":false,"schema":{"format":"string","type":"string","description":"string"}},{"name":"fileUrl","description":"Optional url of csv to import","in":"query","required":false,"schema":{"format":"string","type":"string","description":"string"}}],"responses":{"202":{"description":"Accepted"}},"requestBody":{"content":{"multipart/form-data":{"schema":{"format":"binary","properties":{"file":{"format":"binary","type":"string"}},"type":"object"}}},"description":"File in CSV format with columns to upload as Contact fields. Required columns: Email. Suggested columns: AllowUnsubscribe, Status, ConsentDate, ConsentIP, ConsentTracking.","required":true}}},"/domains":{"get":{"tags":["Domains"],"summary":"Load Domains","description":"Returns a list of all domains configured for this Account. Required Access Level: ViewSettings","operationId":"domainsGet","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/DomainDetail"},"type":"array"}}}}}},"post":{"tags":["Domains"],"summary":"Add Domain","description":"Add new domain to Account. Required Access Level: ModifySettings","operationId":"domainsPost","responses":{"201":{"description":"Created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DomainDetail"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DomainPayload"}}},"description":"Domain to add","required":true}}},"/domains/{domain}":{"get":{"tags":["Domains"],"summary":"Load Domain","description":"Retrieve a domain configured for this Account. Required Access Level: ViewSettings","operationId":"domainsByDomainGet","parameters":[{"name":"domain","description":"Name of the given domain","in":"path","required":true,"schema":{"format":"string","type":"string","description":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DomainData"}}}}}},"put":{"tags":["Domains"],"summary":"Update Domain","description":"Updates the specified domain. Required Access Level: ModifySettings","operationId":"domainsByDomainPut","parameters":[{"name":"domain","description":"Name of the given domain","in":"path","required":true,"schema":{"format":"string","type":"string","description":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DomainDetail"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DomainUpdatePayload"}}},"description":"Updated Domain resource","required":true}},"delete":{"tags":["Domains"],"summary":"Delete Domain","description":"Deletes configured domain from Account. Required Access Level: ModifySettings","operationId":"domainsByDomainDelete","parameters":[{"name":"domain","description":"Name of the given domain","in":"path","required":true,"schema":{"format":"string","type":"string","description":"string"}}],"responses":{"200":{"description":"OK"}}}},"/domains/{domain}/restricted":{"get":{"tags":["Domains"],"summary":"Check for domain restriction","description":"Checking if domain is from free provider, or restricted. Required Access Level: ViewSettings","operationId":"domainsByDomainRestrictedGet","parameters":[{"name":"domain","description":"Name of the given domain","in":"path","required":true,"schema":{"format":"string","type":"string","description":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"format":"boolean","type":"boolean"}}}}}}},"/domains/{domain}/verification":{"put":{"tags":["Domains"],"summary":"Verify Domain","description":"Verifies that required DNS records exist for specified domain. Required Access Level: ModifySettings","operationId":"domainsByDomainVerificationPut","parameters":[{"name":"domain","description":"Name of the given domain","in":"path","required":true,"schema":{"format":"string","type":"string","description":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DomainData"}}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"string","enum":["None","Delete","Http","ExternalHttps","InternalCertHttps","LetsEncryptCert"]}}},"description":"Tracking type used in the Tracking verification","required":true}}},"/domains/{email}/default":{"patch":{"tags":["Domains"],"summary":"Set Default","description":"Sets a verified email address as default sender. Required Access Level: ModifySettings","operationId":"domainsByEmailDefaultPatch","parameters":[{"name":"email","description":"Default email sender, example: mail@yourdomain.com","in":"path","required":true,"schema":{"format":"string","type":"string","description":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DomainDetail"}}}}}}},"/emails":{"post":{"tags":["Emails"],"summary":"Send Bulk Emails","description":"Send bulk merge email. Required Access Level: SendHttp","operationId":"emailsPost","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EmailSend"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/EmailMessageData"}}},"description":"Email data","required":true}}},"/emails/{msgid}/view":{"get":{"tags":["Emails"],"summary":"View Email","description":"Returns email details for viewing or rendering. Required Access Level: None","operationId":"emailsByMsgidViewGet","parameters":[{"name":"msgid","description":"Message identifier","in":"path","required":true,"schema":{"format":"string","type":"string","description":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EmailData"}}}}}}},"/emails/{transactionid}/status":{"get":{"tags":["Emails"],"summary":"Get Status","description":"Get status details of an email transaction. Required Access Level: ViewReports","operationId":"emailsByTransactionidStatusGet","parameters":[{"name":"transactionid","description":"Transaction identifier","in":"path","required":true,"schema":{"format":"string","type":"string","description":"string"}},{"name":"showFailed","description":"Include Bounced email addresses.","in":"query","required":false,"schema":{"default":"False","format":"boolean","type":"boolean","description":"boolean"}},{"name":"showSent","description":"Include Sent email addresses.","in":"query","required":false,"schema":{"default":"False","format":"boolean","type":"boolean","description":"boolean"}},{"name":"showDelivered","description":"Include all delivered email addresses.","in":"query","required":false,"schema":{"default":"False","format":"boolean","type":"boolean","description":"boolean"}},{"name":"showPending","description":"Include Ready to send email addresses.","in":"query","required":false,"schema":{"default":"False","format":"boolean","type":"boolean","description":"boolean"}},{"name":"showOpened","description":"Include Opened email addresses.","in":"query","required":false,"schema":{"default":"False","format":"boolean","type":"boolean","description":"boolean"}},{"name":"showClicked","description":"Include Clicked email addresses.","in":"query","required":false,"schema":{"default":"False","format":"boolean","type":"boolean","description":"boolean"}},{"name":"showAbuse","description":"Include Reported as abuse email addresses.","in":"query","required":false,"schema":{"default":"False","format":"boolean","type":"boolean","description":"boolean"}},{"name":"showUnsubscribed","description":"Include Unsubscribed email addresses.","in":"query","required":false,"schema":{"default":"False","format":"boolean","type":"boolean","description":"boolean"}},{"name":"showErrors","description":"Include error messages for bounced emails.","in":"query","required":false,"schema":{"default":"False","format":"boolean","type":"boolean","description":"boolean"}},{"name":"showMessageIDs","description":"Include all MessageIDs for this transaction","in":"query","required":false,"schema":{"default":"False","format":"boolean","type":"boolean","description":"boolean"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EmailJobStatus"}}}}}}},"/emails/mergefile":{"post":{"tags":["Emails"],"summary":"Send Bulk Emails CSV","description":"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.\n \n Example CSV:\n \n email, firstname, lastname\n test1@gmail.com, michael, smith\n test2@gmail.com, janet, smith\n \n Merge file must not be empty. Required Access Level: SendHttp","operationId":"emailsMergefilePost","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EmailSend"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MergeEmailPayload"}}},"description":"Email data","required":true}}},"/emails/transactional":{"post":{"tags":["Emails"],"summary":"Send Transactional Email","description":"Send transactional emails (recipients will be known to each other). Required Access Level: SendHttp","operationId":"emailsTransactionalPost","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EmailSend"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/EmailTransactionalMessageData"}}},"description":"Email data","required":true}}},"/events":{"get":{"tags":["Events"],"summary":"Load Events","description":"Returns a log of delivery events filtered by specified parameters. Required Access Level: ViewReports","operationId":"eventsGet","parameters":[{"name":"eventTypes","description":"Types of Events to return","in":"query","required":false,"schema":{"items":{"$ref":"#/components/schemas/EventType"},"type":"array","description":"array"}},{"name":"from","description":"Starting date for search in YYYY-MM-DDThh:mm:ss format.","in":"query","required":false,"schema":{"example":"2001-01-01T01:01:01","format":"date-time","nullable":true,"type":"string","description":"string"}},{"name":"to","description":"Ending date for search in YYYY-MM-DDThh:mm:ss format.","in":"query","required":false,"schema":{"example":"2001-01-01T01:01:01","format":"date-time","nullable":true,"type":"string","description":"string"}},{"name":"orderBy","in":"query","required":false,"schema":{"$ref":"#/components/schemas/EventsOrderBy"}},{"name":"limit","description":"How many items to load. Maximum for this request is 1000 items","in":"query","required":false,"schema":{"default":"0","format":"int32","type":"integer","description":"integer"}},{"name":"offset","description":"How many items should be returned ahead.","in":"query","required":false,"schema":{"default":"0","example":"20","format":"int32","type":"integer","description":"integer"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/RecipientEvent"},"type":"array"}}}}}}},"/events/{transactionid}":{"get":{"tags":["Events"],"summary":"Load Email Events","description":"Returns a log of delivery events for the specific transaction ID. Required Access Level: ViewReports","operationId":"eventsByTransactionidGet","parameters":[{"name":"transactionid","description":"ID number of transaction","in":"path","required":true,"schema":{"example":"TransactionID","format":"string","type":"string","description":"string"}},{"name":"from","description":"Starting date for search in YYYY-MM-DDThh:mm:ss format.","in":"query","required":false,"schema":{"example":"2001-01-01T01:01:01","format":"date-time","nullable":true,"type":"string","description":"string"}},{"name":"to","description":"Ending date for search in YYYY-MM-DDThh:mm:ss format.","in":"query","required":false,"schema":{"example":"2001-01-01T01:01:01","format":"date-time","nullable":true,"type":"string","description":"string"}},{"name":"orderBy","in":"query","required":false,"schema":{"$ref":"#/components/schemas/EventsOrderBy"}},{"name":"limit","description":"Maximum number of returned items.","in":"query","required":false,"schema":{"default":"0","example":"100","format":"int32","type":"integer","description":"integer"}},{"name":"offset","description":"How many items should be returned ahead.","in":"query","required":false,"schema":{"default":"0","example":"20","format":"int32","type":"integer","description":"integer"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/RecipientEvent"},"type":"array"}}}}}}},"/events/channels/{name}":{"get":{"tags":["Events"],"summary":"Load Channel Events","description":"Returns a log of delivery events filtered by specified parameters. Required Access Level: ViewReports","operationId":"eventsChannelsByNameGet","parameters":[{"name":"name","description":"Name of selected channel.","in":"path","required":true,"schema":{"example":"Channel01","format":"string","type":"string","description":"string"}},{"name":"eventTypes","description":"Types of Events to return","in":"query","required":false,"schema":{"items":{"$ref":"#/components/schemas/EventType"},"type":"array","description":"array"}},{"name":"from","description":"Starting date for search in YYYY-MM-DDThh:mm:ss format.","in":"query","required":false,"schema":{"example":"2001-01-01T01:01:01","format":"date-time","nullable":true,"type":"string","description":"string"}},{"name":"to","description":"Ending date for search in YYYY-MM-DDThh:mm:ss format.","in":"query","required":false,"schema":{"example":"2001-01-01T01:01:01","format":"date-time","nullable":true,"type":"string","description":"string"}},{"name":"orderBy","in":"query","required":false,"schema":{"$ref":"#/components/schemas/EventsOrderBy"}},{"name":"limit","description":"How many items to load. Maximum for this request is 1000 items","in":"query","required":false,"schema":{"default":"0","format":"int32","type":"integer","description":"integer"}},{"name":"offset","description":"How many items should be returned ahead.","in":"query","required":false,"schema":{"default":"0","example":"20","format":"int32","type":"integer","description":"integer"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/RecipientEvent"},"type":"array"}}}}}}},"/events/channels/{name}/export":{"post":{"tags":["Events"],"summary":"Export Channel Events","description":"Export delivery events log information to the specified file format. Required Access Level: Export","operationId":"eventsChannelsByNameExportPost","parameters":[{"name":"name","description":"Name of selected channel.","in":"path","required":true,"schema":{"example":"Channel01","format":"string","type":"string","description":"string"}},{"name":"eventTypes","description":"Types of Events to return","in":"query","required":false,"schema":{"items":{"$ref":"#/components/schemas/EventType"},"type":"array","description":"array"}},{"name":"from","description":"Starting date for search in YYYY-MM-DDThh:mm:ss format.","in":"query","required":false,"schema":{"example":"2001-01-01T01:01:01","format":"date-time","nullable":true,"type":"string","description":"string"}},{"name":"to","description":"Ending date for search in YYYY-MM-DDThh:mm:ss format.","in":"query","required":false,"schema":{"example":"2001-01-01T01:01:01","format":"date-time","nullable":true,"type":"string","description":"string"}},{"name":"fileFormat","description":"Format of the exported file","in":"query","required":false,"schema":{"$ref":"#/components/schemas/ExportFileFormats"}},{"name":"compressionFormat","description":"FileResponse compression format. None or Zip.","in":"query","required":false,"schema":{"$ref":"#/components/schemas/CompressionFormat"}},{"name":"fileName","description":"Name of your file including extension.","in":"query","required":false,"schema":{"example":"filename.txt","format":"string","type":"string","description":"string"}}],"responses":{"202":{"description":"Accepted","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExportLink"}}}}}}},"/events/channels/export/{id}/status":{"get":{"tags":["Events"],"summary":"Check Channel Export Status","description":"Check the current status of the channel export. Required Access Level: Export","operationId":"eventsChannelsExportByIdStatusGet","parameters":[{"name":"id","description":"ID of the exported file","in":"path","required":true,"schema":{"example":"E33EBA7A-C20D-4D3D-8F2F-5EEF42F58E6F","format":"guid","type":"string","description":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExportStatus"}}}}}}},"/events/export":{"post":{"tags":["Events"],"summary":"Export Events","description":"Export delivery events log information to the specified file format. Required Access Level: Export","operationId":"eventsExportPost","parameters":[{"name":"eventTypes","description":"Types of Events to return","in":"query","required":false,"schema":{"items":{"$ref":"#/components/schemas/EventType"},"type":"array","description":"array"}},{"name":"from","description":"Starting date for search in YYYY-MM-DDThh:mm:ss format.","in":"query","required":false,"schema":{"example":"2001-01-01T01:01:01","format":"date-time","nullable":true,"type":"string","description":"string"}},{"name":"to","description":"Ending date for search in YYYY-MM-DDThh:mm:ss format.","in":"query","required":false,"schema":{"example":"2001-01-01T01:01:01","format":"date-time","nullable":true,"type":"string","description":"string"}},{"name":"fileFormat","description":"Format of the exported file","in":"query","required":false,"schema":{"$ref":"#/components/schemas/ExportFileFormats"}},{"name":"compressionFormat","description":"FileResponse compression format. None or Zip.","in":"query","required":false,"schema":{"$ref":"#/components/schemas/CompressionFormat"}},{"name":"fileName","description":"Name of your file including extension.","in":"query","required":false,"schema":{"example":"filename.txt","format":"string","type":"string","description":"string"}}],"responses":{"202":{"description":"Accepted","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExportLink"}}}}}}},"/events/export/{id}/status":{"get":{"tags":["Events"],"summary":"Check Export Status","description":"Check the current status of the export. Required Access Level: Export","operationId":"eventsExportByIdStatusGet","parameters":[{"name":"id","description":"ID of the exported file","in":"path","required":true,"schema":{"example":"E33EBA7A-C20D-4D3D-8F2F-5EEF42F58E6F","format":"guid","type":"string","description":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExportStatus"}}}}}}},"/files":{"get":{"tags":["Files"],"summary":"List Files","description":"Returns a list of all your available files. Required Access Level: ViewFiles","operationId":"filesGet","parameters":[{"name":"limit","description":"Maximum number of returned items.","in":"query","required":false,"schema":{"default":"0","example":"100","format":"int32","type":"integer","description":"integer"}},{"name":"offset","description":"How many items should be returned ahead.","in":"query","required":false,"schema":{"default":"0","example":"20","format":"int32","type":"integer","description":"integer"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/FileInfo"},"type":"array"}}}}}},"post":{"tags":["Files"],"summary":"Upload File","description":"Uploads selected file to the server. Required Access Level: ModifyFiles","operationId":"filesPost","parameters":[{"name":"expiresAfterDays","description":"After how many days should the file be deleted.","in":"query","required":false,"schema":{"default":"35","example":null,"format":"int32","nullable":true,"type":"integer","description":"integer"}}],"responses":{"201":{"description":"Created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FileInfo"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FilePayload"}}},"required":true}}},"/files/{name}":{"get":{"tags":["Files"],"summary":"Download File","description":"Gets content of the specified File. Required Access Level: ViewFiles","operationId":"filesByNameGet","parameters":[{"name":"name","description":"Name of your file including extension.","in":"path","required":true,"schema":{"example":"filename.txt","format":"string","type":"string","description":"string"}}],"responses":{"200":{"description":"OK","content":{"application/*":{"schema":{"format":"binary","type":"string"}}}}}},"delete":{"tags":["Files"],"summary":"Delete File","description":"Permanently deletes the file from your Account. Required Access Level: ModifyFiles","operationId":"filesByNameDelete","parameters":[{"name":"name","description":"Name of your file including extension.","in":"path","required":true,"schema":{"example":"filename.txt","format":"string","type":"string","description":"string"}}],"responses":{"200":{"description":"OK"}}}},"/files/{name}/info":{"get":{"tags":["Files"],"summary":"Load File Details","description":"Returns the specified File's details. Required Access Level: ViewFiles","operationId":"filesByNameInfoGet","parameters":[{"name":"name","description":"Name of your file including extension.","in":"path","required":true,"schema":{"example":"filename.txt","format":"string","type":"string","description":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FileInfo"}}}}}}},"/inboundroute":{"get":{"tags":["InboundRoute"],"summary":"Get Routes","description":"Get all your Inbound Routes. Required Access Level: ViewSettings","operationId":"inboundrouteGet","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/InboundRoute"},"type":"array"}}}}}},"post":{"tags":["InboundRoute"],"summary":"Create Route","description":"Create new Inbound Route. Required Access Level: ModifySettings","operationId":"inboundroutePost","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InboundRoute"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InboundPayload"}}},"required":true}}},"/inboundroute/{id}":{"get":{"tags":["InboundRoute"],"summary":"Get Route","description":"Load an Inbound Route. Required Access Level: ViewSettings","operationId":"inboundrouteByIdGet","parameters":[{"name":"id","description":"ID number of your attachment","in":"path","required":true,"schema":{"example":"123456","format":"guid","type":"string","description":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InboundRoute"}}}}}},"put":{"tags":["InboundRoute"],"summary":"Update Route","description":"Update the Inbound Route. Required Access Level: ModifySettings","operationId":"inboundrouteByIdPut","parameters":[{"name":"id","in":"path","required":true,"schema":{"format":"guid","type":"string","description":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InboundRoute"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InboundPayload"}}},"required":true}},"delete":{"tags":["InboundRoute"],"summary":"Delete Route","description":"Deletes the Inbound Route. Required Access Level: ModifySettings","operationId":"inboundrouteByIdDelete","parameters":[{"name":"id","in":"path","required":true,"schema":{"format":"guid","type":"string","description":"string"}}],"responses":{"200":{"description":"OK"}}}},"/inboundroute/order":{"put":{"tags":["InboundRoute"],"summary":"Update Sorting","description":"Required Access Level: ViewSettings","operationId":"inboundrouteOrderPut","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/InboundRoute"},"type":"array"}}}}},"requestBody":{"content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/SortOrderItem"},"type":"array"}}},"description":"Change the ordering of inbound routes for when matching the inbound","required":true}}},"/lists":{"get":{"tags":["Lists"],"summary":"Load Lists","description":"Returns all your existing lists. Required Access Level: ViewContacts","operationId":"listsGet","parameters":[{"name":"limit","description":"Maximum number of returned items.","in":"query","required":false,"schema":{"default":"0","example":"100","format":"int32","type":"integer","description":"integer"}},{"name":"offset","description":"How many items should be returned ahead.","in":"query","required":false,"schema":{"default":"0","example":"20","format":"int32","type":"integer","description":"integer"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/ContactsList"},"type":"array"}}}}}},"post":{"tags":["Lists"],"summary":"Add List","description":"Add a new list. Required Access Level: ModifyContacts","operationId":"listsPost","responses":{"201":{"description":"Created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContactsList"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListPayload"}}},"required":true}}},"/lists/{listname}/contacts":{"get":{"tags":["Lists"],"summary":"Load Contacts in List","description":"Returns a list of contacts. Required Access Level: ViewContacts","operationId":"listsByListnameContactsGet","parameters":[{"name":"listname","description":"Name of your list.","in":"path","required":true,"schema":{"example":"My List 1","format":"string","type":"string","description":"string"}},{"name":"limit","description":"Maximum number of returned items.","in":"query","required":false,"schema":{"default":"20","example":"100","format":"int32","type":"integer","description":"integer"}},{"name":"offset","description":"How many items should be returned ahead.","in":"query","required":false,"schema":{"default":"0","example":"20","format":"int32","type":"integer","description":"integer"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/Contact"},"type":"array"}}}}}}},"/lists/{name}":{"get":{"tags":["Lists"],"summary":"Load List","description":"Returns detailed information about specified list. Required Access Level: ViewContacts","operationId":"listsByNameGet","parameters":[{"name":"name","description":"Name of your list.","in":"path","required":true,"schema":{"example":"My List 1","format":"string","type":"string","description":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContactsList"}}}}}},"put":{"tags":["Lists"],"summary":"Update List","description":"Update existing list. Required Access Level: ModifyContacts","operationId":"listsByNamePut","parameters":[{"name":"name","description":"Name of your list.","in":"path","required":true,"schema":{"example":"My List 1","format":"string","type":"string","description":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContactsList"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListUpdatePayload"}}},"required":true}},"delete":{"tags":["Lists"],"summary":"Delete List","description":"Deletes List and removes all the Contacts from it (does not delete Contacts). Required Access Level: ModifyContacts","operationId":"listsByNameDelete","parameters":[{"name":"name","description":"Name of your list.","in":"path","required":true,"schema":{"example":"My List 1","format":"string","type":"string","description":"string"}}],"responses":{"200":{"description":"OK"}}}},"/lists/{name}/contacts":{"post":{"tags":["Lists"],"summary":"Add Contacts to List","description":"Add existing Contacts to specified list. Required Access Level: ModifyContacts","operationId":"listsByNameContactsPost","parameters":[{"name":"name","description":"Name of your list.","in":"path","required":true,"schema":{"example":"My List 1","format":"string","type":"string","description":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContactsList"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/EmailsPayload"}}},"description":"Provide either rule or a list of emails, not both.","required":true}}},"/lists/{name}/contacts/remove":{"post":{"tags":["Lists"],"summary":"Remove Contacts from List","description":"Remove specified Contacts from your list. Required Access Level: ModifyContacts","operationId":"listsByNameContactsRemovePost","parameters":[{"name":"name","description":"Name of your list.","in":"path","required":true,"schema":{"example":"My List 1","format":"string","type":"string","description":"string"}}],"responses":{"200":{"description":"OK"}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/EmailsPayload"}}},"description":"Provide either rule or a list of emails, not both.","required":true}}},"/security/apikeys":{"get":{"tags":["Security"],"summary":"List ApiKeys","description":"List all your existing ApiKeys. Required Access Level: Security","operationId":"securityApikeysGet","parameters":[{"name":"subaccount","description":"Email of the subaccount of which ApiKeys should be loaded","in":"query","required":false,"schema":{"format":"string","type":"string","description":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/ApiKey"},"type":"array"}}}}}},"post":{"tags":["Security"],"summary":"Add ApiKey","description":"Add a new ApiKey. Required Access Level: Security","operationId":"securityApikeysPost","responses":{"201":{"description":"Created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NewApiKey"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiKeyPayload"}}},"required":true}}},"/security/apikeys/{name}":{"get":{"tags":["Security"],"summary":"Load ApiKey","description":"Load your existing ApiKey info. Required Access Level: Security","operationId":"securityApikeysByNameGet","parameters":[{"name":"name","description":"Name of the ApiKey","in":"path","required":true,"schema":{"format":"string","type":"string","description":"string"}},{"name":"subaccount","description":"Email of the subaccount of which ApiKey should be loaded","in":"query","required":false,"schema":{"format":"string","type":"string","description":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiKey"}}}}}},"put":{"tags":["Security"],"summary":"Update ApiKey","description":"Update your existing ApiKey. Required Access Level: Security","operationId":"securityApikeysByNamePut","parameters":[{"name":"name","description":"Name of the ApiKey","in":"path","required":true,"schema":{"format":"string","type":"string","description":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiKey"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiKeyPayload"}}},"required":true}},"delete":{"tags":["Security"],"summary":"Delete ApiKey","description":"Delete your existing ApiKey. Required Access Level: Security","operationId":"securityApikeysByNameDelete","parameters":[{"name":"name","description":"Name of the ApiKey","in":"path","required":true,"schema":{"format":"string","type":"string","description":"string"}},{"name":"subaccount","description":"Email of the subaccount of which ApiKey should be deleted","in":"query","required":false,"schema":{"format":"string","type":"string","description":"string"}}],"responses":{"200":{"description":"OK"}}}},"/security/smtp":{"get":{"tags":["Security"],"summary":"List SMTP Credentials","description":"List all your existing SMTP Credentials. Required Access Level: Security","operationId":"securitySmtpGet","parameters":[{"name":"subaccount","description":"Email of the subaccount of which credentials should be listed","in":"query","required":false,"schema":{"format":"string","type":"string","description":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/SmtpCredentials"},"type":"array"}}}}}},"post":{"tags":["Security"],"summary":"Add SMTP Credential","description":"Add new SMTP Credential. Required Access Level: Security","operationId":"securitySmtpPost","responses":{"201":{"description":"Created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NewSmtpCredentials"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SmtpCredentialsPayload"}}},"required":true}}},"/security/smtp/{name}":{"get":{"tags":["Security"],"summary":"Load SMTP Credential","description":"Load your existing SMTP Credential info. Required Access Level: Security","operationId":"securitySmtpByNameGet","parameters":[{"name":"name","description":"Name of the SMTP Credential","in":"path","required":true,"schema":{"format":"string","type":"string","description":"string"}},{"name":"subaccount","description":"Email of the subaccount of which credential should be loaded","in":"query","required":false,"schema":{"format":"string","type":"string","description":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SmtpCredentials"}}}}}},"put":{"tags":["Security"],"summary":"Update SMTP Credential","description":"Update your existing SMTP Credentials. Required Access Level: Security","operationId":"securitySmtpByNamePut","parameters":[{"name":"name","description":"Name of the SMTP Credential","in":"path","required":true,"schema":{"format":"string","type":"string","description":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SmtpCredentials"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SmtpCredentialsPayload"}}},"required":true}},"delete":{"tags":["Security"],"summary":"Delete SMTP Credential","description":"Delete your existing SMTP Credentials. Required Access Level: Security","operationId":"securitySmtpByNameDelete","parameters":[{"name":"name","description":"Name of the SMTP Credential","in":"path","required":true,"schema":{"format":"string","type":"string","description":"string"}},{"name":"subaccount","description":"Email of the subaccount of which credential should be deleted","in":"query","required":false,"schema":{"format":"string","type":"string","description":"string"}}],"responses":{"200":{"description":"OK"}}}},"/segments":{"get":{"tags":["Segments"],"summary":"Load Segments","description":"Returns a list of all your available Segments. Required Access Level: ViewContacts","operationId":"segmentsGet","parameters":[{"name":"limit","description":"Maximum number of returned items.","in":"query","required":false,"schema":{"default":"0","example":"100","format":"int32","type":"integer","description":"integer"}},{"name":"offset","description":"How many items should be returned ahead.","in":"query","required":false,"schema":{"default":"0","example":"20","format":"int32","type":"integer","description":"integer"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/Segment"},"type":"array"}}}}}},"post":{"tags":["Segments"],"summary":"Add Segment","description":"Add a new segment, based on specified RULE. Required Access Level: ModifyContacts","operationId":"segmentsPost","responses":{"201":{"description":"Created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Segment"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SegmentPayload"}}},"required":true}}},"/segments/{name}":{"get":{"tags":["Segments"],"summary":"Load Segment","description":"Returns details for the specified segment. Required Access Level: ViewContacts","operationId":"segmentsByNameGet","parameters":[{"name":"name","description":"Name of the segment you want to load. Will load all contacts if the 'All Contacts' name has been provided","in":"path","required":true,"schema":{"format":"string","type":"string","description":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Segment"}}}}}},"put":{"tags":["Segments"],"summary":"Update Segment","description":"Rename or change RULE for your segment. Required Access Level: ModifyContacts","operationId":"segmentsByNamePut","parameters":[{"name":"name","description":"Name of your segment.","in":"path","required":true,"schema":{"example":"My Segment 1","format":"string","type":"string","description":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Segment"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SegmentPayload"}}},"required":true}},"delete":{"tags":["Segments"],"summary":"Delete Segment","description":"Delete an existing segment. Required Access Level: ModifyContacts","operationId":"segmentsByNameDelete","parameters":[{"name":"name","description":"Name of your segment.","in":"path","required":true,"schema":{"example":"My Segment 1","format":"string","type":"string","description":"string"}}],"responses":{"200":{"description":"OK"}}}},"/statistics":{"get":{"tags":["Statistics"],"summary":"Load Statistics","description":"Returns basic statistics. Required Access Level: ViewReports","operationId":"statisticsGet","parameters":[{"name":"from","description":"Starting date for search in YYYY-MM-DDThh:mm:ss format.","in":"query","required":true,"schema":{"example":"2001-01-01T01:01:01","format":"date-time","type":"string","description":"string"}},{"name":"to","description":"Ending date for search in YYYY-MM-DDThh:mm:ss format.","in":"query","required":false,"schema":{"example":"2001-01-01T01:01:01","format":"date-time","nullable":true,"type":"string","description":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LogStatusSummary"}}}}}}},"/statistics/campaigns":{"get":{"tags":["Statistics"],"summary":"Load Campaigns Stats","description":"Returns a list of your Campaigns' stats. Required Access Level: ViewChannels","operationId":"statisticsCampaignsGet","parameters":[{"name":"limit","description":"Maximum number of returned items.","in":"query","required":false,"schema":{"default":"0","example":"100","format":"int32","type":"integer","description":"integer"}},{"name":"offset","description":"How many items should be returned ahead.","in":"query","required":false,"schema":{"default":"0","example":"20","format":"int32","type":"integer","description":"integer"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/ChannelLogStatusSummary"},"type":"array"}}}}}}},"/statistics/campaigns/{name}":{"get":{"tags":["Statistics"],"summary":"Load Campaign Stats","description":"Retrieve stats of an existing campaign. Required Access Level: ViewChannels","operationId":"statisticsCampaignsByNameGet","parameters":[{"name":"name","description":"The name of the campaign to get.","in":"path","required":true,"schema":{"format":"string","type":"string","description":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ChannelLogStatusSummary"}}}}}}},"/statistics/channels":{"get":{"tags":["Statistics"],"summary":"Load Channels Stats","description":"Returns a list of your Channels' stats. Required Access Level: ViewChannels","operationId":"statisticsChannelsGet","parameters":[{"name":"limit","description":"Maximum number of returned items.","in":"query","required":false,"schema":{"default":"0","example":"100","format":"int32","type":"integer","description":"integer"}},{"name":"offset","description":"How many items should be returned ahead.","in":"query","required":false,"schema":{"default":"0","example":"20","format":"int32","type":"integer","description":"integer"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/ChannelLogStatusSummary"},"type":"array"}}}}}}},"/statistics/channels/{name}":{"get":{"tags":["Statistics"],"summary":"Load Channel Stats","description":"Retrieve an existing channel stats. Required Access Level: ViewChannels","operationId":"statisticsChannelsByNameGet","parameters":[{"name":"name","description":"The name of the channel to get.","in":"path","required":true,"schema":{"format":"string","type":"string","description":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ChannelLogStatusSummary"}}}}}}},"/subaccounts":{"get":{"tags":["SubAccounts"],"summary":"Load SubAccounts","description":"Returns a list of all your SubAccounts. Required Access Level: ViewSubAccounts","operationId":"subaccountsGet","parameters":[{"name":"limit","description":"Maximum number of returned items.","in":"query","required":false,"schema":{"default":"0","example":"100","format":"int32","type":"integer","description":"integer"}},{"name":"offset","description":"How many items should be returned ahead.","in":"query","required":false,"schema":{"default":"0","example":"20","format":"int32","type":"integer","description":"integer"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/SubAccountInfo"},"type":"array"}}}}}},"post":{"tags":["SubAccounts"],"summary":"Add SubAccount","description":"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","operationId":"subaccountsPost","responses":{"201":{"description":"Created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SubAccountInfo"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SubaccountPayload"}}},"required":true}}},"/subaccounts/{email}":{"get":{"tags":["SubAccounts"],"summary":"Load SubAccount","description":"Returns details for the specified SubAccount. Required Access Level: ViewSubAccounts","operationId":"subaccountsByEmailGet","parameters":[{"name":"email","description":"Email address of Sub-Account","in":"path","required":true,"schema":{"example":"mail@example.com","format":"string","type":"string","description":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SubAccountInfo"}}}}}},"delete":{"tags":["SubAccounts"],"summary":"Delete SubAccount","description":"Deletes specified SubAccount. An email will be sent to confirm this change. Required Access Level: ModifySubAccounts","operationId":"subaccountsByEmailDelete","parameters":[{"name":"email","description":"Email address of Sub-Account","in":"path","required":true,"schema":{"example":"mail@example.com","format":"string","type":"string","description":"string"}}],"responses":{"200":{"description":"OK"}}}},"/subaccounts/{email}/credits":{"patch":{"tags":["SubAccounts"],"summary":"Add, Subtract Email Credits","description":"Update email credits of a subaccount by the given amount. Required Access Level: ModifySubAccounts","operationId":"subaccountsByEmailCreditsPatch","parameters":[{"name":"email","description":"Email address of Sub-Account","in":"path","required":true,"schema":{"example":"mail@example.com","format":"string","type":"string","description":"string"}}],"responses":{"200":{"description":"OK"}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SubaccountEmailCreditsPayload"}}},"description":"Amount of email credits to add or subtract from the current SubAccount email credits pool (positive or negative value)","required":true}}},"/subaccounts/{email}/settings/email":{"put":{"tags":["SubAccounts"],"summary":"Update SubAccount Email Settings","description":"Update SubAccount email settings. Required Access Level: ModifySubAccounts","operationId":"subaccountsByEmailSettingsEmailPut","parameters":[{"name":"email","in":"path","required":true,"schema":{"format":"string","type":"string","description":"string"}}],"responses":{"201":{"description":"Created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SubaccountEmailSettings"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SubaccountEmailSettings"}}},"description":"Updated Email Settings","required":true}}},"/suppressions":{"get":{"tags":["Suppressions"],"summary":"Get Suppressions","description":"Retrieve your suppressions. Required Access Level: ViewContacts, ViewSuppressions","operationId":"suppressionsGet","parameters":[{"name":"limit","description":"Maximum number of returned items.","in":"query","required":false,"schema":{"default":"0","example":"100","format":"int32","type":"integer","description":"integer"}},{"name":"offset","description":"How many items should be returned ahead.","in":"query","required":false,"schema":{"default":"0","example":"20","format":"int32","type":"integer","description":"integer"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/Suppression"},"type":"array"}}}}}}},"/suppressions/{email}":{"get":{"tags":["Suppressions"],"summary":"Get Suppression","description":"Retrieve your suppression. Required Access Level: ViewContacts, ViewSuppressions","operationId":"suppressionsByEmailGet","parameters":[{"name":"email","description":"Proper email address.","in":"path","required":true,"schema":{"example":"mail@example.com","format":"string","type":"string","description":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Suppression"}}}}}},"delete":{"tags":["Suppressions"],"summary":"Delete Suppression","description":"Delete Suppression. Required Access Level: ViewContacts, ViewSuppressions","operationId":"suppressionsByEmailDelete","parameters":[{"name":"email","description":"Proper email address.","in":"path","required":true,"schema":{"example":"mail@example.com","format":"string","type":"string","description":"string"}}],"responses":{"200":{"description":"OK"}}}},"/suppressions/bounces":{"get":{"tags":["Suppressions"],"summary":"Get Bounce List","description":"Retrieve your list of bounced emails. Required Access Level: ViewContacts, ViewSuppressions","operationId":"suppressionsBouncesGet","parameters":[{"name":"search","description":"Text fragment used for searching.","in":"query","required":false,"schema":{"example":"text","format":"string","type":"string","description":"string"}},{"name":"limit","description":"Maximum number of returned items.","in":"query","required":false,"schema":{"default":"0","example":"100","format":"int32","type":"integer","description":"integer"}},{"name":"offset","description":"How many items should be returned ahead.","in":"query","required":false,"schema":{"default":"0","example":"20","format":"int32","type":"integer","description":"integer"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/Suppression"},"type":"array"}}}}}},"post":{"tags":["Suppressions"],"summary":"Add Bounces","description":"Add Bounced. Required Access Level: ModifyContacts, ModifySuppressions","operationId":"suppressionsBouncesPost","responses":{"201":{"description":"Created","content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/Suppression"},"type":"array"}}}}},"requestBody":{"content":{"application/json":{"schema":{"items":{"format":"string","type":"string"},"type":"array"}}},"description":"Emails to add as bounces. Limited to 1000 per request","required":true}}},"/suppressions/bounces/import":{"post":{"tags":["Suppressions"],"summary":"Add Bounces Async","description":"Add Bounced. Required Access Level: ModifyContacts, ModifySuppressions","operationId":"suppressionsBouncesImportPost","responses":{"202":{"description":"Accepted"}},"requestBody":{"content":{"multipart/form-data":{"schema":{"format":"binary","properties":{"file":{"format":"binary","type":"string"}},"type":"object"}}},"description":"Emails to add as bounces.","required":true}}},"/suppressions/complaints":{"get":{"tags":["Suppressions"],"summary":"Get Complaints List","description":"Retrieve your list of complaints. Required Access Level: ViewContacts, ViewSuppressions","operationId":"suppressionsComplaintsGet","parameters":[{"name":"search","description":"Text fragment used for searching.","in":"query","required":false,"schema":{"example":"text","format":"string","type":"string","description":"string"}},{"name":"limit","description":"Maximum number of returned items.","in":"query","required":false,"schema":{"default":"0","example":"100","format":"int32","type":"integer","description":"integer"}},{"name":"offset","description":"How many items should be returned ahead.","in":"query","required":false,"schema":{"default":"0","example":"20","format":"int32","type":"integer","description":"integer"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/Suppression"},"type":"array"}}}}}},"post":{"tags":["Suppressions"],"summary":"Add Complaints","description":"Add Complaints. Required Access Level: ModifyContacts, ModifySuppressions","operationId":"suppressionsComplaintsPost","responses":{"201":{"description":"Created","content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/Suppression"},"type":"array"}}}}},"requestBody":{"content":{"application/json":{"schema":{"items":{"format":"string","type":"string"},"type":"array"}}},"description":"Emails to add as complaints. Limited to 1000 per request","required":true}}},"/suppressions/complaints/import":{"post":{"tags":["Suppressions"],"summary":"Add Complaints Async","description":"Add Complaints. Required Access Level: ModifyContacts, ModifySuppressions","operationId":"suppressionsComplaintsImportPost","responses":{"202":{"description":"Accepted"}},"requestBody":{"content":{"multipart/form-data":{"schema":{"format":"binary","properties":{"file":{"format":"binary","type":"string"}},"type":"object"}}},"description":"Emails to add as complaints.","required":true}}},"/suppressions/unsubscribes":{"get":{"tags":["Suppressions"],"summary":"Get Unsubscribes List","description":"Retrieve your list of unsubscribes. Required Access Level: ViewContacts, ViewSuppressions","operationId":"suppressionsUnsubscribesGet","parameters":[{"name":"search","description":"Text fragment used for searching.","in":"query","required":false,"schema":{"example":"text","format":"string","type":"string","description":"string"}},{"name":"limit","description":"Maximum number of returned items.","in":"query","required":false,"schema":{"default":"0","example":"100","format":"int32","type":"integer","description":"integer"}},{"name":"offset","description":"How many items should be returned ahead.","in":"query","required":false,"schema":{"default":"0","example":"20","format":"int32","type":"integer","description":"integer"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/Suppression"},"type":"array"}}}}}},"post":{"tags":["Suppressions"],"summary":"Add Unsubscribes","description":"Add Unsubscribes. Required Access Level: ModifyContacts, ModifySuppressions","operationId":"suppressionsUnsubscribesPost","responses":{"201":{"description":"Created","content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/Suppression"},"type":"array"}}}}},"requestBody":{"content":{"application/json":{"schema":{"items":{"format":"string","type":"string"},"type":"array"}}},"description":"Emails to add as unsubscribes. Limited to 1000 per request","required":true}}},"/suppressions/unsubscribes/import":{"post":{"tags":["Suppressions"],"summary":"Add Unsubscribes Async","description":"Add Unsubscribes. Required Access Level: ModifyContacts, ModifySuppressions","operationId":"suppressionsUnsubscribesImportPost","responses":{"202":{"description":"Accepted"}},"requestBody":{"content":{"multipart/form-data":{"schema":{"format":"binary","properties":{"file":{"format":"binary","type":"string"}},"type":"object"}}},"description":"Emails to add as unsubscribes.","required":true}}},"/templates":{"get":{"tags":["Templates"],"summary":"Load Templates","description":"Returns a list of templates for the specified type. Required Access Level: ViewTemplates","operationId":"templatesGet","parameters":[{"name":"scopeType","description":"Return templates with specified scope only","in":"query","required":true,"schema":{"items":{"$ref":"#/components/schemas/TemplateScope"},"type":"array","description":"array"}},{"name":"templateTypes","description":"Return templates with specified type only","in":"query","required":false,"schema":{"items":{"$ref":"#/components/schemas/TemplateType"},"type":"array","description":"array"}},{"name":"limit","description":"Maximum number of returned items.","in":"query","required":false,"schema":{"default":"500","example":"100","format":"int32","type":"integer","description":"integer"}},{"name":"offset","description":"How many items should be returned ahead.","in":"query","required":false,"schema":{"default":"0","example":"20","format":"int32","type":"integer","description":"integer"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/Template"},"type":"array"}}}}}},"post":{"tags":["Templates"],"summary":"Add Template","description":"Add a new Template. Required Access Level: ModifyTemplates","operationId":"templatesPost","responses":{"201":{"description":"Template","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Template"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TemplatePayload"}}},"required":true}}},"/templates/{name}":{"get":{"tags":["Templates"],"summary":"Load Template","description":"Load detailed information of the specified template. Required Access Level: ViewTemplates","operationId":"templatesByNameGet","parameters":[{"name":"name","description":"Name of template.","in":"path","required":true,"schema":{"example":"Template01","format":"string","type":"string","description":"string"}}],"responses":{"200":{"description":"Serialized template","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Template"}}}}}},"put":{"tags":["Templates"],"summary":"Update Template","description":"Update existing template, overwriting existing data. Required Access Level: ModifyTemplates","operationId":"templatesByNamePut","parameters":[{"name":"name","description":"Name of template.","in":"path","required":true,"schema":{"example":"Template01","format":"string","type":"string","description":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Template"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TemplatePayload"}}},"required":true}},"delete":{"tags":["Templates"],"summary":"Delete Template","description":"Delete template with the specified name. Required Access Level: ModifyTemplates","operationId":"templatesByNameDelete","parameters":[{"name":"name","description":"Name of template.","in":"path","required":true,"schema":{"example":"Template01","format":"string","type":"string","description":"string"}}],"responses":{"200":{"description":"OK"}}}},"/verifications":{"get":{"tags":["Verifications"],"summary":"Get Emails Verification Results","description":"Returns a results of all verified single emails. Required Access Level: VerifyEmails","operationId":"verificationsGet","parameters":[{"name":"limit","description":"Maximum number of returned items.","in":"query","required":false,"schema":{"default":"0","example":"100","format":"int32","type":"integer","description":"integer"}},{"name":"offset","description":"How many items should be returned ahead.","in":"query","required":false,"schema":{"default":"0","example":"20","format":"int32","type":"integer","description":"integer"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/EmailValidationResult"},"type":"array"}}}}}}},"/verifications/{email}":{"get":{"tags":["Verifications"],"summary":"Get Email Verification Result","description":"Returns a result of verified email. Required Access Level: VerifyEmails","operationId":"verificationsByEmailGet","parameters":[{"name":"email","description":"Email address to view verification result of","in":"path","required":true,"schema":{"format":"string","type":"string","description":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EmailValidationResult"}}}}}},"post":{"tags":["Verifications"],"summary":"Verify Email","description":"Verify single email address and returns result of verification. Required Access Level: VerifyEmails","operationId":"verificationsByEmailPost","parameters":[{"name":"email","description":"Email address to verify","in":"path","required":true,"schema":{"format":"string","type":"string","description":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EmailValidationResult"}}}}}},"delete":{"tags":["Verifications"],"summary":"Delete Email Verification Result","description":"Delete a result with given email if exists. Required Access Level: VerifyEmails","operationId":"verificationsByEmailDelete","parameters":[{"name":"email","description":"Email address to verification","in":"path","required":true,"schema":{"format":"string","type":"string","description":"string"}}],"responses":{"200":{"description":"OK"}}}},"/verifications/files":{"post":{"tags":["Verifications"],"summary":"Upload File with Emails","description":"Uploads a CSV file with list of emails that can then be triggered for verification. An 'email' column is required. Required Access Level: VerifyEmails","operationId":"verificationsFilesPost","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/VerificationFileResult"}}}}},"requestBody":{"content":{"multipart/form-data":{"schema":{"format":"binary","properties":{"file":{"format":"binary","type":"string"}},"type":"object"}}},"description":"Uploaded file","required":true}}},"/verifications/files/{id}":{"delete":{"tags":["Verifications"],"summary":"Delete File Verification Result","description":"Delete Verification Results if they exist. Required Access Level: VerifyEmails","operationId":"verificationsFilesByIdDelete","parameters":[{"name":"id","description":"ID of the exported file","in":"path","required":true,"schema":{"example":"E33EBA7A-C20D-4D3D-8F2F-5EEF42F58E6F","format":"string","type":"string","description":"string"}}],"responses":{"200":{"description":"OK"}}}},"/verifications/files/{id}/result":{"get":{"tags":["Verifications"],"summary":"Get Detailed File Verification Result","description":"Returns status and results (if verified) of file with given ID. Required Access Level: VerifyEmails","operationId":"verificationsFilesByIdResultGet","parameters":[{"name":"id","description":"ID of the Verification to display status of","in":"path","required":true,"schema":{"format":"string","type":"string","description":"string"}},{"name":"limit","description":"Maximum number of returned email verification results","in":"query","required":false,"schema":{"default":"0","format":"int32","type":"integer","description":"integer"}},{"name":"offset","description":"How many result items should be returned ahead","in":"query","required":false,"schema":{"default":"0","format":"int32","type":"integer","description":"integer"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/VerificationFileResultDetails"}}}}}}},"/verifications/files/{id}/result/download":{"get":{"tags":["Verifications"],"summary":"Download File Verification Result","description":"Download verification results as a ZIP file. Required Access Level: VerifyEmails","operationId":"verificationsFilesByIdResultDownloadGet","parameters":[{"name":"id","description":"Verification ID to download","in":"path","required":true,"schema":{"format":"string","type":"string","description":"string"}}],"responses":{"200":{"description":"A ZIP file with verification details","content":{"application/*":{"schema":{"format":"binary","type":"string"}}}}}}},"/verifications/files/{id}/verification":{"post":{"tags":["Verifications"],"summary":"Start verification","description":"Start a verification of the previously uploaded file with emails. Required Access Level: VerifyEmails","operationId":"verificationsFilesByIdVerificationPost","parameters":[{"name":"id","description":"File ID to start verification","in":"path","required":true,"schema":{"format":"string","type":"string","description":"string"}}],"responses":{"200":{"description":"OK"}}}},"/verifications/files/result":{"get":{"tags":["Verifications"],"summary":"Get Files Verification Results","description":"Returns a list of uploaded files, their statuses and results. Required Access Level: VerifyEmails","operationId":"verificationsFilesResultGet","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/VerificationFileResult"},"type":"array"}}}}}}}},"components":{"schemas":{"AccessLevel":{"default":"None","type":"string","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"]},"AccountStatusEnum":{"default":"Disabled","type":"string","enum":["Disabled","UnderReview","NeverSignedIn","Active"]},"ApiKey":{"properties":{"AccessLevel":{"items":{"$ref":"#/components/schemas/AccessLevel"},"type":"array","description":"Access level or permission to be assigned to this ApiKey."},"Name":{"format":"string","type":"string","description":"Name of the ApiKey."},"DateCreated":{"format":"date-time","type":"string","description":"Date this ApiKey was created."},"LastUse":{"example":null,"format":"date-time","nullable":true,"type":"string","description":"Date this ApiKey was last used."},"Expires":{"example":null,"format":"date-time","nullable":true,"type":"string","description":"Date this ApiKey expires."},"RestrictAccessToIPRange":{"items":{"format":"string","type":"string"},"type":"array","description":"Which IPs can use this ApiKey"}},"type":"object","description":"ApiKey info"},"ApiKeyPayload":{"properties":{"Name":{"format":"string","type":"string","description":"Name of the ApiKey for ease of reference."},"AccessLevel":{"items":{"$ref":"#/components/schemas/AccessLevel"},"type":"array","description":"Access level or permission to be assigned to this ApiKey."},"Expires":{"example":null,"format":"date-time","nullable":true,"type":"string","description":"Date this ApiKey expires."},"RestrictAccessToIPRange":{"items":{"format":"string","type":"string"},"type":"array","description":"Which IPs can use this ApiKey"},"Subaccount":{"format":"string","type":"string","description":"Email of the subaccount for which this ApiKey should be created"}},"required":["Name","AccessLevel"],"type":"object","description":"Create a new ApiKey"},"BodyContentType":{"default":"HTML","type":"string","description":"Type of body part","enum":["HTML","PlainText","AMP","CSS"]},"BodyPart":{"properties":{"ContentType":{"$ref":"#/components/schemas/BodyContentType"},"Content":{"format":"string","type":"string","description":"Actual content of the body part"},"Charset":{"format":"string","type":"string","description":"Text value of charset encoding for example: iso-8859-1, windows-1251, utf-8, us-ascii, windows-1250 and more..."}},"required":["ContentType"],"type":"object","description":"Email body part with user-provided MIME type (text/html, text/plain, etc)"},"Campaign":{"properties":{"Content":{"items":{"$ref":"#/components/schemas/CampaignTemplate"},"type":"array","description":"Campaign's email content. Provide multiple items to send an A/X Split Campaign"},"Name":{"format":"string","type":"string","description":"Campaign name"},"Status":{"$ref":"#/components/schemas/CampaignStatus"},"Recipients":{"$ref":"#/components/schemas/CampaignRecipient"},"Options":{"$ref":"#/components/schemas/CampaignOptions"}},"required":["Name","Recipients"],"type":"object"},"CampaignOptions":{"properties":{"DeliveryOptimization":{"$ref":"#/components/schemas/DeliveryOptimizationType"},"TrackOpens":{"example":"true","format":"boolean","nullable":true,"type":"boolean","description":"Should the opens be tracked? If no value has been provided, Account's default setting will be used."},"TrackClicks":{"example":"true","format":"boolean","nullable":true,"type":"boolean","description":"Should the clicks be tracked? If no value has been provided, Account's default setting will be used."},"ScheduleFor":{"example":null,"format":"date-time","nullable":true,"type":"string","description":"Date when this Campaign is scheduled to be sent on"},"TriggerFrequency":{"format":"double","type":"number","description":"How often (in minutes) to send the campaign"},"TriggerCount":{"format":"int32","type":"integer","description":"How many times send the campaign"},"SplitOptions":{"$ref":"#/components/schemas/SplitOptions"}},"type":"object","description":"Different send options for a Campaign"},"CampaignRecipient":{"properties":{"ListNames":{"items":{"format":"string","type":"string"},"type":"array","description":"Names of lists from your Account to read recipients from"},"SegmentNames":{"items":{"format":"string","type":"string"},"type":"array","description":"Names of segments from your Account to read recipients from"}},"type":"object","description":"A set of lists and segments names to read recipients from"},"CampaignStatus":{"default":"Deleted","type":"string","enum":["Deleted","Active","Processing","Sending","Completed","Paused","Cancelled","Draft"]},"CampaignTemplate":{"properties":{"Poolname":{"example":"My Custom Pool","format":"string","type":"string","description":"Name of your custom IP Pool to be used in the sending process"},"From":{"example":"John Doe ","format":"string","type":"string","description":"Your e-mail with an optional name (e.g.: John Doe )"},"ReplyTo":{"example":"John Doe ","format":"string","type":"string","description":"To what address should the recipients reply to (e.g. John Doe )"},"Subject":{"example":"Hello!","format":"string","type":"string","description":"Default subject of email."},"TemplateName":{"example":"Template01","format":"string","type":"string","description":"Name of template."},"AttachFiles":{"example":["preuploaded.jpg"],"items":{"format":"string","type":"string"},"type":"array","description":"Names of previously uploaded files that should be sent as downloadable attachments"},"Utm":{"$ref":"#/components/schemas/Utm"}},"required":["From"],"type":"object","description":"Content of a Campaign"},"CertificateValidationStatus":{"default":"ErrorOccured","type":"string","enum":["ErrorOccured","CertNotSet","Valid","NotValid"]},"ChannelLogStatusSummary":{"properties":{"ChannelName":{"format":"string","type":"string","description":"Channel name"},"Recipients":{"example":"1234","format":"int64","type":"integer","description":"Number of recipients"},"EmailTotal":{"example":"1234","format":"int64","type":"integer","description":"Number of emails"},"SmsTotal":{"example":"12","format":"int64","type":"integer","description":"Number of SMS"},"Delivered":{"example":"1000","format":"int64","type":"integer","description":"Number of delivered messages"},"Bounced":{"example":"1000","format":"int64","type":"integer","description":"Number of bounced messages"},"InProgress":{"example":"1234","format":"int64","type":"integer","description":"Number of messages in progress"},"Opened":{"example":"1000","format":"int64","type":"integer","description":"Number of opened messages"},"Clicked":{"example":"1000","format":"int64","type":"integer","description":"Number of clicked messages"},"Unsubscribed":{"example":"1000","format":"int64","type":"integer","description":"Number of unsubscribed messages"},"Complaints":{"example":"1000","format":"int64","type":"integer","description":"Number of complaint messages"},"Inbound":{"example":"1000","format":"int64","type":"integer","description":"Number of inbound messages"},"ManualCancel":{"example":"1000","format":"int64","type":"integer","description":"Number of manually cancelled messages"},"NotDelivered":{"example":"0","format":"int64","type":"integer","description":"Number of messages flagged with 'Not Delivered'"}},"type":"object","description":"Summary of channel log status"},"CompressionFormat":{"default":"None","type":"string","description":"FileResponse compression format","enum":["None","Zip"]},"ConsentData":{"properties":{"ConsentIP":{"example":"192.168.0.1","format":"string","type":"string","description":"IP address of consent to send this contact(s) your email. If not provided your current public IP address is used for consent."},"ConsentDate":{"example":"1/1/2015 0:00:00 AM","format":"date-time","nullable":true,"type":"string","description":"Date of consent to send this contact(s) your email. If not provided current date is used for consent."},"ConsentTracking":{"$ref":"#/components/schemas/ConsentTracking"}},"type":"object"},"ConsentTracking":{"default":"Unknown","type":"string","enum":["Unknown","Allow","Deny"]},"Contact":{"properties":{"Email":{"example":"mail@example.com","format":"string","type":"string","description":"Proper email address."},"Status":{"$ref":"#/components/schemas/ContactStatus"},"FirstName":{"example":"Fred","format":"string","type":"string","description":"First name."},"LastName":{"example":"Flintstone","format":"string","type":"string","description":"Last name."},"CustomFields":{"example":{"city":"New York","age":"34"},"additionalProperties":{"type":"string"},"type":"object","description":"A key-value collection of custom contact fields which can be used in the system."},"Consent":{"$ref":"#/components/schemas/ConsentData"},"Source":{"$ref":"#/components/schemas/ContactSource"},"DateAdded":{"example":"2001-01-01T12:00:00","format":"date-time","type":"string","description":"Date of creation in YYYY-MM-DDThh:ii:ss format"},"DateUpdated":{"example":"2001-01-01T12:00:00","format":"date-time","nullable":true,"type":"string","description":"Last change date"},"StatusChangeDate":{"example":"2001-01-01T12:00:00","format":"date-time","nullable":true,"type":"string","description":"Date of last status change."},"Activity":{"$ref":"#/components/schemas/ContactActivity"}},"type":"object","description":"Contact"},"ContactActivity":{"properties":{"TotalSent":{"example":"1000","format":"int32","type":"integer","description":"Total emails sent."},"TotalOpened":{"example":"1000","format":"int32","type":"integer","description":"Total emails opened."},"TotalClicked":{"example":"1000","format":"int32","type":"integer","description":"Total emails clicked"},"TotalFailed":{"example":"1000","format":"int32","type":"integer","description":"Total emails failed."},"LastSent":{"example":null,"format":"date-time","nullable":true,"type":"string","description":"Last date when an email was sent to this contact"},"LastOpened":{"example":"2014-01-01","format":"date-time","nullable":true,"type":"string","description":"Date this contact last opened an email"},"LastClicked":{"example":null,"format":"date-time","nullable":true,"type":"string","description":"Date this contact last clicked an email"},"LastFailed":{"example":null,"format":"date-time","nullable":true,"type":"string","description":"Last date when an email sent to this contact bounced"},"LastIP":{"format":"string","type":"string","description":"IP from which this contact opened or clicked their email last time"},"ErrorCode":{"example":null,"format":"int32","nullable":true,"type":"integer","description":"Last RFC Error code if any occurred"},"FriendlyErrorMessage":{"format":"string","type":"string","description":"Last RFC error message if any occurred"}},"type":"object"},"ContactPayload":{"properties":{"Email":{"example":"mail@example.com","format":"string","type":"string","description":"Proper email address."},"Status":{"$ref":"#/components/schemas/ContactStatus"},"FirstName":{"example":"Fred","format":"string","type":"string","description":"First name."},"LastName":{"example":"Flintstone","format":"string","type":"string","description":"Last name."},"CustomFields":{"example":{"city":"New York","age":"34"},"additionalProperties":{"type":"string"},"type":"object","description":"A key-value collection of custom contact fields which can be used in the system. Only already existing custom fields will be saved."},"Consent":{"$ref":"#/components/schemas/ConsentData"}},"required":["Email"],"type":"object"},"ContactSource":{"default":"DeliveryApi","type":"string","enum":["DeliveryApi","ManualInput","FileUpload","WebForm","ContactApi","VerificationApi","FileVerificationApi"]},"ContactStatus":{"default":"Transactional","type":"string","enum":["Transactional","Engaged","Active","Bounced","Unsubscribed","Abuse","Inactive","Stale","NotConfirmed"]},"ContactUpdatePayload":{"properties":{"FirstName":{"example":"Fred","format":"string","type":"string","description":"First name."},"LastName":{"example":"Flintstone","format":"string","type":"string","description":"Last name."},"CustomFields":{"example":{"city":"New York","age":"34"},"additionalProperties":{"type":"string"},"type":"object","description":"A key-value collection of custom contact fields which can be used in the system."}},"type":"object"},"DeliveryOptimizationType":{"default":"None","type":"string","enum":["None","ToEngagedFirst","ByOpenTime"]},"DomainData":{"properties":{"ValidationLog":{"format":"string","type":"string","description":"Domain validation results - when domain has been running through validation process"},"Domain":{"example":"example.com","format":"string","type":"string","description":"Name of selected domain."},"DefaultDomain":{"format":"boolean","type":"boolean","description":"True, if domain is used as default. Otherwise, false,"},"Spf":{"example":"true","format":"boolean","type":"boolean","description":"True, if SPF record is verified"},"Dkim":{"example":"true","format":"boolean","type":"boolean","description":"True, if DKIM record is verified"},"MX":{"example":"true","format":"boolean","type":"boolean","description":"True, if MX record is verified"},"DMARC":{"format":"boolean","type":"boolean"},"IsRewriteDomainValid":{"example":"true","format":"boolean","type":"boolean","description":"True, if tracking CNAME record is verified"},"Verify":{"example":"true","format":"boolean","type":"boolean","description":"True, if DKIM, SPF, or tracking are still to be verified"},"Type":{"$ref":"#/components/schemas/TrackingType"},"TrackingStatus":{"$ref":"#/components/schemas/TrackingValidationStatus"},"CertificateStatus":{"$ref":"#/components/schemas/CertificateValidationStatus"},"CertificateValidationError":{"format":"string","type":"string"},"TrackingTypeUserRequest":{"$ref":"#/components/schemas/TrackingType"},"VERP":{"format":"boolean","type":"boolean"},"CustomBouncesDomain":{"format":"string","type":"string"},"IsCustomBouncesDomainDefault":{"format":"boolean","type":"boolean"},"IsMarkedForDeletion":{"format":"boolean","type":"boolean"},"Ownership":{"$ref":"#/components/schemas/DomainOwner"}},"type":"object","description":"Domain data, with information about domain records."},"DomainDetail":{"properties":{"Domain":{"example":"example.com","format":"string","type":"string","description":"Name of selected domain."},"DefaultDomain":{"format":"boolean","type":"boolean","description":"True, if domain is used as default. Otherwise, false,"},"Spf":{"example":"true","format":"boolean","type":"boolean","description":"True, if SPF record is verified"},"Dkim":{"example":"true","format":"boolean","type":"boolean","description":"True, if DKIM record is verified"},"MX":{"example":"true","format":"boolean","type":"boolean","description":"True, if MX record is verified"},"DMARC":{"format":"boolean","type":"boolean"},"IsRewriteDomainValid":{"example":"true","format":"boolean","type":"boolean","description":"True, if tracking CNAME record is verified"},"Verify":{"example":"true","format":"boolean","type":"boolean","description":"True, if DKIM, SPF, or tracking are still to be verified"},"Type":{"$ref":"#/components/schemas/TrackingType"},"TrackingStatus":{"$ref":"#/components/schemas/TrackingValidationStatus"},"CertificateStatus":{"$ref":"#/components/schemas/CertificateValidationStatus"},"CertificateValidationError":{"format":"string","type":"string"},"TrackingTypeUserRequest":{"$ref":"#/components/schemas/TrackingType"},"VERP":{"format":"boolean","type":"boolean"},"CustomBouncesDomain":{"format":"string","type":"string"},"IsCustomBouncesDomainDefault":{"format":"boolean","type":"boolean"},"IsMarkedForDeletion":{"format":"boolean","type":"boolean"},"Ownership":{"$ref":"#/components/schemas/DomainOwner"}},"type":"object","description":"Domain data, with information about domain records."},"DomainOwner":{"default":"Current","type":"string","enum":["Current","Parent"]},"DomainPayload":{"properties":{"Domain":{"example":"example.com","format":"string","type":"string","description":"Name of selected domain."},"SetAsDefault":{"format":"boolean","type":"boolean"}},"type":"object"},"DomainUpdatePayload":{"properties":{"CertificateStatus":{"$ref":"#/components/schemas/CertificateValidationStatus"},"VERP":{"format":"boolean","type":"boolean"},"CustomBouncesDomain":{"format":"string","type":"string"},"IsCustomBouncesDomainDefault":{"format":"boolean","type":"boolean"}},"type":"object"},"EmailContent":{"properties":{"Body":{"items":{"$ref":"#/components/schemas/BodyPart"},"type":"array","description":"List of e-mail body parts, with user-provided MIME types (text/html, text/plain etc)"},"Merge":{"example":{"city":"New York","age":"34"},"additionalProperties":{"type":"string"},"type":"object","description":"A key-value collection of custom merge fields, shared between recipients. Should be used in e-mail body like so: {firstname}, {lastname} etc."},"Attachments":{"items":{"$ref":"#/components/schemas/MessageAttachment"},"type":"array","description":"Attachments provided by sending binary data"},"Headers":{"example":{"city":"New York","age":"34"},"additionalProperties":{"type":"string"},"type":"object","description":"A key-value collection of custom e-mail headers."},"Postback":{"format":"string","type":"string","description":"Postback header."},"EnvelopeFrom":{"example":"John Doe ","format":"string","type":"string","description":"E-mail with an optional name to be used as the envelope from address (e.g.: John Doe )"},"From":{"example":"John Doe ","format":"string","type":"string","description":"Your e-mail with an optional name (e.g.: John Doe )"},"ReplyTo":{"example":"John Doe ","format":"string","type":"string","description":"To what address should the recipients reply to (e.g. John Doe )"},"Subject":{"example":"Hello!","format":"string","type":"string","description":"Default subject of email."},"TemplateName":{"example":"Template01","format":"string","type":"string","description":"Name of template."},"AttachFiles":{"example":["preuploaded.jpg"],"items":{"format":"string","type":"string"},"type":"array","description":"Names of previously uploaded files that should be sent as downloadable attachments"},"Utm":{"$ref":"#/components/schemas/Utm"}},"required":["From"],"type":"object","description":"Proper e-mail content"},"EmailData":{"properties":{"Preview":{"$ref":"#/components/schemas/EmailView"},"Attachments":{"items":{"$ref":"#/components/schemas/FileInfo"},"type":"array","description":"Attachments sent with the email"},"Status":{"$ref":"#/components/schemas/EmailStatus"}},"type":"object"},"EmailJobFailedStatus":{"properties":{"Address":{"format":"string","type":"string"},"Error":{"format":"string","type":"string"},"ErrorCode":{"example":"550","format":"int32","type":"integer","description":"RFC Error code"},"Category":{"format":"string","type":"string"}},"type":"object"},"EmailJobStatus":{"properties":{"ID":{"example":"123456","format":"string","type":"string","description":"ID number of your attachment"},"Status":{"format":"string","type":"string","description":"Name of status: submitted, complete, in_progress"},"RecipientsCount":{"format":"int32","type":"integer"},"Failed":{"items":{"$ref":"#/components/schemas/EmailJobFailedStatus"},"type":"array"},"FailedCount":{"example":"1000","format":"int32","type":"integer","description":"Total emails failed."},"Sent":{"items":{"format":"string","type":"string"},"type":"array"},"SentCount":{"example":"1000","format":"int32","type":"integer","description":"Total emails sent."},"Delivered":{"example":["1000"],"items":{"format":"string","type":"string"},"type":"array","description":"Number of delivered messages"},"DeliveredCount":{"format":"int32","type":"integer"},"Pending":{"items":{"format":"string","type":"string"},"type":"array"},"PendingCount":{"format":"int32","type":"integer"},"Opened":{"example":["1000"],"items":{"format":"string","type":"string"},"type":"array","description":"Number of opened messages"},"OpenedCount":{"example":"1000","format":"int32","type":"integer","description":"Total emails opened."},"Clicked":{"example":["1000"],"items":{"format":"string","type":"string"},"type":"array","description":"Number of clicked messages"},"ClickedCount":{"example":"1000","format":"int32","type":"integer","description":"Total emails clicked"},"Unsubscribed":{"example":["1000"],"items":{"format":"string","type":"string"},"type":"array","description":"Number of unsubscribed messages"},"UnsubscribedCount":{"example":"1000","format":"int32","type":"integer","description":"Total emails unsubscribed"},"AbuseReports":{"items":{"format":"string","type":"string"},"type":"array"},"AbuseReportsCount":{"format":"int32","type":"integer"},"MessageIDs":{"items":{"format":"string","type":"string"},"type":"array","description":"List of all MessageIDs for this job."}},"type":"object"},"EmailMessageData":{"properties":{"Recipients":{"items":{"$ref":"#/components/schemas/EmailRecipient"},"type":"array","description":"List of recipients"},"Content":{"$ref":"#/components/schemas/EmailContent"},"Options":{"$ref":"#/components/schemas/Options"}},"required":["Recipients","Content"],"type":"object","description":"Email data"},"EmailPredictedValidationStatus":{"default":"None","type":"string","enum":["None","Valid","LowRisk","HighRisk","Invalid"]},"EmailRecipient":{"properties":{"Email":{"example":"mail@example.com","format":"string","type":"string","description":"Proper email address."},"Fields":{"example":{"city":"New York","age":"34"},"additionalProperties":{"type":"string"},"type":"object","description":"A key-value collection of merge fields which can be used in e-mail body."}},"required":["Email"],"type":"object","description":"List of recipients"},"EmailSend":{"properties":{"TransactionID":{"example":"TransactionID","format":"string","type":"string","description":"ID number of transaction"},"MessageID":{"example":"-HHGPM_9RPhSMiaJq_ab4g3","format":"string","type":"string","description":"Unique identifier for this email."}},"type":"object"},"EmailsPayload":{"properties":{"Rule":{"format":"string","type":"string","description":"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":{"example":["john.doe@sample.com"],"items":{"format":"string","type":"string"},"type":"array","description":"Comma delimited list of contact emails"}},"type":"object","description":"Provide either rule or a list of emails, not both."},"EmailStatus":{"properties":{"From":{"format":"string","type":"string","description":"Email address this email was sent from."},"To":{"format":"string","type":"string","description":"Email address this email was sent to."},"Date":{"format":"date-time","type":"string","description":"Date the email was submitted."},"Status":{"$ref":"#/components/schemas/LogJobStatus"},"StatusName":{"format":"string","type":"string","description":"Name of email's status"},"StatusChangeDate":{"example":"2001-01-01T12:00:00","format":"date-time","type":"string","description":"Date of last status change."},"DateSent":{"example":"2001-01-01T12:00:00","format":"date-time","type":"string","description":"Date when the email was sent"},"DateOpened":{"example":"2001-01-01T12:00:00","format":"date-time","nullable":true,"type":"string","description":"Date when the email changed the status to 'opened'"},"DateClicked":{"example":"2001-01-01T12:00:00","format":"date-time","nullable":true,"type":"string","description":"Date when the email changed the status to 'clicked'"},"ErrorMessage":{"format":"string","type":"string","description":"Detailed error or bounced message."},"TransactionID":{"example":"TransactionID","format":"guid","type":"string","description":"ID number of transaction"},"EnvelopeFrom":{"format":"string","type":"string","description":"Envelope from address"},"ErrorCategory":{"$ref":"#/components/schemas/MessageCategoryEnum"}},"type":"object","description":"Status information of the specified email"},"EmailTransactionalMessageData":{"properties":{"Recipients":{"$ref":"#/components/schemas/TransactionalRecipient"},"Content":{"$ref":"#/components/schemas/EmailContent"},"Options":{"$ref":"#/components/schemas/Options"}},"required":["Recipients","Content"],"type":"object","description":"Email data"},"EmailValidationResult":{"properties":{"Account":{"format":"string","type":"string","description":"Local part of an email"},"Domain":{"example":"example.com","format":"string","type":"string","description":"Name of selected domain."},"Email":{"format":"string","type":"string","description":"Full email address that was verified"},"SuggestedSpelling":{"format":"string","type":"string","description":"Suggested spelling if a possible mistake was found"},"Disposable":{"format":"boolean","type":"boolean","description":"Does the email have a temporary domain"},"Role":{"format":"boolean","type":"boolean","description":"Is an email a role email (e.g. info@, noreply@ etc.)"},"Reason":{"format":"string","type":"string","description":"All detected issues"},"DateAdded":{"format":"date-time","type":"string","description":"Added date"},"Result":{"$ref":"#/components/schemas/EmailValidationStatus"},"PredictedScore":{"format":"single","type":"number","description":"Predicted score"},"PredictedStatus":{"$ref":"#/components/schemas/EmailPredictedValidationStatus"}},"type":"object"},"EmailValidationStatus":{"default":"None","type":"string","enum":["None","Valid","Unknown","Risky","Invalid"]},"EmailView":{"properties":{"Body":{"format":"string","type":"string","description":"Body (HTML, otherwise plain text) of email"},"Subject":{"example":"Hello!","format":"string","type":"string","description":"Default subject of email."},"From":{"format":"string","type":"string","description":"From email address"}},"type":"object","description":"Email details formatted in json"},"EncodingType":{"default":"UserProvided","type":"string","description":"Encoding type for the email headers","enum":["UserProvided","None","Raw7bit","Raw8bit","QuotedPrintable","Base64","Uue"]},"EventsOrderBy":{"default":"DateDescending","type":"string","enum":["DateDescending","DateAscending"]},"EventType":{"default":"Submission","type":"string","description":"Type of event","enum":["Submission","FailedAttempt","Bounce","Sent","Open","Click","Unsubscribe","Complaint"]},"ExportFileFormats":{"default":"Csv","type":"string","description":"Format of the exported file.","enum":["Csv","Xml","Json"]},"ExportLink":{"properties":{"Link":{"format":"string","type":"string","description":"Direct URL to the exported file"},"PublicExportID":{"example":"E33EBA7A-C20D-4D3D-8F2F-5EEF42F58E6F","format":"guid","type":"string","description":"ID of the exported file"}},"type":"object"},"ExportStatus":{"default":"Error","type":"string","description":"Current status of the export.","enum":["Error","Loading","Ready","Expired"]},"FileInfo":{"properties":{"FileName":{"example":"filename.txt","format":"string","type":"string","description":"Name of your file including extension."},"Size":{"example":"100","format":"int32","nullable":true,"type":"integer","description":"Size of your attachment (in bytes)."},"DateAdded":{"example":"2001-01-01T12:00:00","format":"date-time","type":"string","description":"Date of creation in YYYY-MM-DDThh:ii:ss format"},"ExpirationDate":{"example":null,"format":"date-time","nullable":true,"type":"string","description":"Date when the file will be deleted from your Account."},"ContentType":{"example":"image/jpeg","format":"string","type":"string","description":"Content type of the file."}},"type":"object","description":"File information"},"FilePayload":{"properties":{"BinaryContent":{"format":"byte","type":"string","description":"Content of the file sent as binary data"},"Name":{"example":"attachment.txt","format":"string","type":"string","description":"Filename"},"ContentType":{"format":"string","type":"string","description":"Type of file's content (e.g. image/jpeg)"}},"required":["BinaryContent"],"type":"object"},"FileUploadResult":{"properties":{"EmailsCount":{"format":"int32","type":"integer","description":"How many unique emails were detected the file"},"DuplicatedEmailsCount":{"format":"int32","type":"integer","description":"How many email duplicates were detected"}},"type":"object"},"InboundPayload":{"properties":{"Filter":{"format":"string","type":"string","description":"Filter of the inbound data"},"Name":{"format":"string","type":"string","description":"Name of this route"},"FilterType":{"$ref":"#/components/schemas/InboundRouteFilterType"},"ActionType":{"$ref":"#/components/schemas/InboundRouteActionType"},"EmailAddress":{"format":"string","type":"string","description":"Email to forward the inbound to"},"HttpAddress":{"format":"string","type":"string","description":"Address to notify about the inbound"}},"required":["Filter","Name","FilterType","ActionType"],"type":"object"},"InboundRoute":{"properties":{"PublicId":{"format":"string","type":"string"},"Name":{"format":"string","type":"string","description":"Name of this route"},"FilterType":{"$ref":"#/components/schemas/InboundRouteFilterType"},"Filter":{"format":"string","type":"string","description":"Filter of the inbound data"},"ActionType":{"$ref":"#/components/schemas/InboundRouteActionType"},"ActionParameter":{"format":"string","type":"string","description":"URL address or Email to notify about the inbound"},"SortOrder":{"format":"int32","type":"integer","description":"Place of this route in your routes queue's order"}},"type":"object"},"InboundRouteActionType":{"default":"ForwardToEmail","type":"string","enum":["ForwardToEmail","NotifyViaHttp","Stop"]},"InboundRouteFilterType":{"default":"EmailAddress","type":"string","enum":["EmailAddress","Subject"]},"ContactsList":{"properties":{"ListName":{"example":"My List 1","format":"string","type":"string","description":"Name of your list."},"PublicListID":{"example":"E33EBA7A-C20D-4D3D-8F2F-5EEF42F58E6F","format":"guid","nullable":true,"type":"string","description":"ID code of list. Please note that this is different from the listid field."},"DateAdded":{"example":"2001-01-01T12:00:00","format":"date-time","type":"string","description":"Date of creation in YYYY-MM-DDThh:ii:ss format"},"AllowUnsubscribe":{"example":"true/false","format":"boolean","type":"boolean","description":"True: Allow unsubscribing from this list. Otherwise, false"}},"type":"object","description":"List of Lists, with detailed data about its contents."},"ListPayload":{"properties":{"ListName":{"example":"My List 1","format":"string","type":"string","description":"Name of your list."},"AllowUnsubscribe":{"example":"true/false","format":"boolean","type":"boolean","description":"True: Allow unsubscribing from this list. Otherwise, false"},"Emails":{"example":["john.doe@sample.com"],"items":{"format":"string","type":"string"},"type":"array","description":"Comma delimited list of existing contact emails that should be added to this list. Leave empty for all contacts"}},"required":["ListName"],"type":"object"},"ListUpdatePayload":{"properties":{"NewListName":{"example":"My List 2","format":"string","type":"string","description":"Name of your list if you want to change it."},"AllowUnsubscribe":{"example":"true/false","format":"boolean","type":"boolean","description":"True: Allow unsubscribing from this list. Otherwise, false"}},"type":"object"},"LogJobStatus":{"default":"All","type":"string","enum":["All","ReadyToSend","WaitingToRetry","Sending","Error","Sent","Opened","Clicked","Unsubscribed","AbuseReport"]},"LogStatusSummary":{"properties":{"Recipients":{"example":"1234","format":"int64","type":"integer","description":"Number of recipients"},"EmailTotal":{"example":"1234","format":"int64","type":"integer","description":"Number of emails"},"SmsTotal":{"example":"12","format":"int64","type":"integer","description":"Number of SMS"},"Delivered":{"example":"1000","format":"int64","type":"integer","description":"Number of delivered messages"},"Bounced":{"example":"1000","format":"int64","type":"integer","description":"Number of bounced messages"},"InProgress":{"example":"1234","format":"int64","type":"integer","description":"Number of messages in progress"},"Opened":{"example":"1000","format":"int64","type":"integer","description":"Number of opened messages"},"Clicked":{"example":"1000","format":"int64","type":"integer","description":"Number of clicked messages"},"Unsubscribed":{"example":"1000","format":"int64","type":"integer","description":"Number of unsubscribed messages"},"Complaints":{"example":"1000","format":"int64","type":"integer","description":"Number of complaint messages"},"Inbound":{"example":"1000","format":"int64","type":"integer","description":"Number of inbound messages"},"ManualCancel":{"example":"1000","format":"int64","type":"integer","description":"Number of manually cancelled messages"},"NotDelivered":{"example":"0","format":"int64","type":"integer","description":"Number of messages flagged with 'Not Delivered'"}},"type":"object","description":"Summary of log status"},"MergeEmailPayload":{"properties":{"MergeFile":{"$ref":"#/components/schemas/MessageAttachment"},"Content":{"$ref":"#/components/schemas/EmailContent"},"Options":{"$ref":"#/components/schemas/Options"}},"required":["MergeFile","Content"],"type":"object"},"MessageAttachment":{"properties":{"BinaryContent":{"format":"byte","type":"string","description":"File's content as byte array (or a Base64 string)"},"Name":{"format":"string","type":"string","description":"Display name of the file"},"ContentType":{"format":"string","type":"string","description":"MIME content type"},"Size":{"example":"100","format":"int32","type":"integer","description":"Size of your attachment (in bytes)."}},"required":["BinaryContent","Name"],"type":"object"},"MessageCategory":{"default":"Unknown","type":"string","enum":["Unknown","Ignore","Spam","BlackListed","NoMailbox","GreyListed","Throttled","Timeout","ConnectionProblem","SPFProblem","AccountProblem","DNSProblem","NotDeliveredCancelled","CodeError","ManualCancel","ConnectionTerminated","NotDelivered"]},"MessageCategoryEnum":{"default":"Unknown","type":"string","enum":["Unknown","Ignore","Spam","BlackListed","NoMailbox","GreyListed","Throttled","Timeout","ConnectionProblem","SPFProblem","AccountProblem","DNSProblem","NotDeliveredCancelled","CodeError","ManualCancel","ConnectionTerminated","NotDelivered"]},"NewApiKey":{"properties":{"Token":{"format":"string","type":"string","description":"Unique token to be used in the system"},"AccessLevel":{"items":{"$ref":"#/components/schemas/AccessLevel"},"type":"array","description":"Access level or permission to be assigned to this ApiKey."},"Name":{"format":"string","type":"string","description":"Name of the ApiKey."},"DateCreated":{"format":"date-time","type":"string","description":"Date this ApiKey was created."},"LastUse":{"example":null,"format":"date-time","nullable":true,"type":"string","description":"Date this ApiKey was last used."},"Expires":{"example":null,"format":"date-time","nullable":true,"type":"string","description":"Date this ApiKey expires."},"RestrictAccessToIPRange":{"items":{"format":"string","type":"string"},"type":"array","description":"Which IPs can use this ApiKey"}},"type":"object","description":"Newly generated ApiKey with Token"},"NewSmtpCredentials":{"properties":{"Token":{"format":"string","type":"string","description":"Unique token to be used in the system"},"AccessLevel":{"$ref":"#/components/schemas/AccessLevel"},"Name":{"format":"string","type":"string","description":"Name of the key."},"DateCreated":{"format":"date-time","type":"string","description":"Date this SmtpCredential was created."},"LastUse":{"example":null,"format":"date-time","nullable":true,"type":"string","description":"Date this SmtpCredential was last used."},"Expires":{"example":null,"format":"date-time","nullable":true,"type":"string","description":"Date this SmtpCredential expires."},"RestrictAccessToIPRange":{"items":{"format":"string","type":"string"},"type":"array","description":"Which IPs can use this SmtpCredential"}},"type":"object","description":"Newly generated SMTP Credentials with Token"},"Options":{"properties":{"TimeOffset":{"example":null,"format":"int32","nullable":true,"type":"integer","description":"By how long should an e-mail be delayed (in minutes). Maximum is 35 days."},"PoolName":{"example":"My Custom Pool","format":"string","type":"string","description":"Name of your custom IP Pool to be used in the sending process"},"ChannelName":{"example":"Channel01","format":"string","type":"string","description":"Name of selected channel."},"Encoding":{"$ref":"#/components/schemas/EncodingType"},"TrackOpens":{"example":"true","format":"boolean","nullable":true,"type":"boolean","description":"Should the opens be tracked? If no value has been provided, Account's default setting will be used."},"TrackClicks":{"example":"true","format":"boolean","nullable":true,"type":"boolean","description":"Should the clicks be tracked? If no value has been provided, Account's default setting will be used."}},"type":"object","description":"E-mail configuration"},"RecipientEvent":{"properties":{"TransactionID":{"example":"TransactionID","format":"string","type":"string","description":"ID number of transaction"},"MsgID":{"example":"ABCDE_9RPhSWiaJq_ab1g1","format":"string","type":"string","description":"ID number of selected message."},"FromEmail":{"example":"sender@yourdomain.com","format":"string","type":"string","description":"Default From: email address."},"To":{"example":"2001-01-01T01:01:01","format":"string","type":"string","description":"Ending date for search in YYYY-MM-DDThh:mm:ss format."},"Subject":{"example":"Hello!","format":"string","type":"string","description":"Default subject of email."},"EventType":{"$ref":"#/components/schemas/EventType"},"EventDate":{"format":"date-time","type":"string","description":"Creation date"},"ChannelName":{"example":"Channel01","format":"string","type":"string","description":"Name of selected channel."},"MessageCategory":{"$ref":"#/components/schemas/MessageCategory"},"NextTryOn":{"example":"2001-01-01T12:00:00","format":"date-time","nullable":true,"type":"string","description":"Date of next try"},"Message":{"example":"Lorem ipsum","format":"string","type":"string","description":"Content of message, HTML encoded"},"IPAddress":{"format":"string","type":"string","description":"IP which this email was sent through"},"PoolName":{"format":"string","type":"string","description":"Name of an IP pool this email was sent through"}},"type":"object","description":"Detailed information about message recipient"},"Segment":{"properties":{"Name":{"format":"string","type":"string","description":"Segment name"},"Rule":{"format":"string","type":"string","description":"SQL-like rule to determine which Contacts belong to this Segment."}},"type":"object","description":"Dynamic collection of Contacts, managed by SQL-like rule."},"SegmentPayload":{"properties":{"Name":{"format":"string","type":"string","description":"Segment name"},"Rule":{"format":"string","type":"string","description":"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"}},"required":["Name","Rule"],"type":"object"},"SmtpCredentials":{"properties":{"AccessLevel":{"$ref":"#/components/schemas/AccessLevel"},"Name":{"format":"string","type":"string","description":"Name of the key."},"DateCreated":{"format":"date-time","type":"string","description":"Date this SmtpCredential was created."},"LastUse":{"example":null,"format":"date-time","nullable":true,"type":"string","description":"Date this SmtpCredential was last used."},"Expires":{"example":null,"format":"date-time","nullable":true,"type":"string","description":"Date this SmtpCredential expires."},"RestrictAccessToIPRange":{"items":{"format":"string","type":"string"},"type":"array","description":"Which IPs can use this SmtpCredential"}},"type":"object","description":"SMTP Credentials info"},"SmtpCredentialsPayload":{"properties":{"Name":{"format":"string","type":"string","description":"Name of the Credential for ease of reference. It must be a valid email address."},"Expires":{"example":null,"format":"date-time","nullable":true,"type":"string","description":"Date this SmtpCredential expires."},"RestrictAccessToIPRange":{"items":{"format":"string","type":"string"},"type":"array","description":"Which IPs can use this SmtpCredential"},"Subaccount":{"format":"string","type":"string","description":"Email of the subaccount for which this SmtpCredential should be created"}},"required":["Name"],"type":"object","description":"Create new SMTP Credentials"},"SortOrderItem":{"properties":{"PublicInboundId":{"format":"guid","type":"string","description":"ID of the route to change the order of"},"SortOrder":{"format":"int32","type":"integer","description":"1 - route will be used first"}},"required":["PublicInboundId","SortOrder"],"type":"object","description":"Change the ordering of this inbound route for when matching the inbound"},"SplitOptimizationType":{"default":"Opens","type":"string","enum":["Opens","Clicks"]},"SplitOptions":{"properties":{"OptimizeFor":{"$ref":"#/components/schemas/SplitOptimizationType"},"OptimizePeriodMinutes":{"example":"30","format":"int32","type":"integer","description":"For how long should the results be measured until determining the winner template (content)"}},"type":"object","description":"Optional A/X split campaign options"},"SubaccountEmailCreditsPayload":{"properties":{"Credits":{"format":"int32","type":"integer","description":"Positive or negative value; this will be added or subtracted from Subaccount's current email Credits pool."},"Notes":{"format":"string","type":"string","description":"Note to append to this credits change, for history."}},"required":["Credits"],"type":"object","description":"A change to SubAccount email credits pool, with an additional note."},"SubaccountEmailSettings":{"properties":{"MonthlyRefillCredits":{"example":"1000","format":"int32","type":"integer","description":"Amount of credits added to Account automatically"},"RequiresEmailCredits":{"example":"true","format":"boolean","type":"boolean","description":"True, if Account needs credits to send emails. Otherwise, false"},"EmailSizeLimit":{"example":"10","format":"int32","type":"integer","description":"Maximum size of email including attachments in MB's"},"DailySendLimit":{"example":"100000","format":"int32","type":"integer","description":"Amount of emails Account can send daily"},"MaxContacts":{"format":"int32","type":"integer","description":"Maximum number of contacts the Account can have. 0 means that parent account's limit is used."},"EnablePrivateIPPurchase":{"format":"boolean","type":"boolean","description":"Can the SubAccount purchase Private IP for themselves"},"PoolName":{"example":"My Custom Pool","format":"string","type":"string","description":"Name of your custom IP Pool to be used in the sending process"},"ValidSenderDomainOnly":{"example":null,"format":"boolean","nullable":true,"type":"boolean"}},"type":"object","description":"Settings related to sending emails"},"SubaccountEmailSettingsPayload":{"properties":{"RequiresEmailCredits":{"example":"true","format":"boolean","type":"boolean","description":"True, if Account needs credits to send emails. Otherwise, false"},"EmailSizeLimit":{"example":"10","format":"int32","type":"integer","description":"Maximum size of email including attachments in MB's"},"DailySendLimit":{"example":"100000","format":"int32","type":"integer","description":"Amount of emails Account can send daily"},"MaxContacts":{"format":"int32","type":"integer","description":"Maximum number of contacts the Account can have. 0 means that parent account's limit is used."},"EnablePrivateIPPurchase":{"format":"boolean","type":"boolean","description":"Can the SubAccount purchase Private IP for themselves"},"PoolName":{"example":"My Custom Pool","format":"string","type":"string","description":"Name of your custom IP Pool to be used in the sending process"},"ValidSenderDomainOnly":{"example":null,"format":"boolean","nullable":true,"type":"boolean"}},"type":"object","description":"Settings related to sending emails"},"SubAccountInfo":{"properties":{"PublicAccountID":{"example":"EB3EBB7A-C20D-4D39-8F2F-5E6842F58E6F","format":"string","type":"string","description":"Public key for limited access to your Account such as contact/add so you can use it safely on public websites."},"Email":{"example":"mail@example.com","format":"string","type":"string","description":"Proper email address."},"Settings":{"$ref":"#/components/schemas/SubaccountSettingsInfo"},"LastActivity":{"example":"2001-01-01T12:00:00","format":"date-time","type":"string","description":"Date of last activity on Account"},"EmailCredits":{"example":"1000","format":"int32","type":"integer","description":"Amount of email credits"},"TotalEmailsSent":{"example":"1000","format":"int64","type":"integer","description":"Amount of emails sent from this Account"},"Reputation":{"example":"100","format":"double","type":"number","description":"Numeric reputation"},"Status":{"$ref":"#/components/schemas/AccountStatusEnum"},"ContactsCount":{"format":"int32","type":"integer","description":"How many contacts this SubAccount has stored"}},"type":"object","description":"Detailed information about SubAccount."},"SubaccountPayload":{"properties":{"Email":{"example":"mail@example.com","format":"string","type":"string","description":"Proper email address."},"Password":{"example":"********","format":"string","type":"string","description":"Current password."},"SendActivation":{"format":"boolean","type":"boolean","description":"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)."},"Settings":{"$ref":"#/components/schemas/SubaccountSettingsInfoPayload"}},"required":["Email","Password"],"type":"object","description":"New SubAccount payload"},"SubaccountSettingsInfo":{"properties":{"Email":{"$ref":"#/components/schemas/SubaccountEmailSettings"}},"type":"object","description":"SubAccount settings"},"SubaccountSettingsInfoPayload":{"properties":{"Email":{"$ref":"#/components/schemas/SubaccountEmailSettingsPayload"}},"type":"object","description":"SubAccount settings"},"Suppression":{"properties":{"Email":{"example":"mail@example.com","format":"string","type":"string","description":"Proper email address."},"FriendlyErrorMessage":{"example":"Mailbox not found","format":"string","type":"string","description":"RFC error message"},"ErrorCode":{"example":null,"format":"int32","nullable":true,"type":"integer","description":"SMTP Error code"},"DateUpdated":{"example":"2001-01-01T12:00:00","format":"date-time","nullable":true,"type":"string","description":"Last change date"}},"type":"object","description":"Suppression - Email returning Hard Bounces"},"Template":{"properties":{"TemplateType":{"$ref":"#/components/schemas/TemplateType"},"Name":{"format":"string","type":"string","description":"Template name"},"DateAdded":{"example":"2001-01-01T12:00:00","format":"date-time","type":"string","description":"Date of creation in YYYY-MM-DDThh:ii:ss format"},"Subject":{"example":"Hello!","format":"string","type":"string","description":"Default subject of email."},"Body":{"items":{"$ref":"#/components/schemas/BodyPart"},"type":"array","description":"Email content of this template"},"TemplateScope":{"$ref":"#/components/schemas/TemplateScope"}},"type":"object","description":"Template info"},"TemplatePayload":{"properties":{"Name":{"format":"string","type":"string","description":"Template name"},"Subject":{"example":"Hello!","format":"string","type":"string","description":"Default subject of email."},"Body":{"items":{"$ref":"#/components/schemas/BodyPart"},"type":"array","description":"Email content of this template"},"TemplateScope":{"$ref":"#/components/schemas/TemplateScope"}},"required":["Name"],"type":"object","description":"New template object"},"TemplateScope":{"default":"Personal","type":"string","description":"Visibility of a template","enum":["Personal","Global"]},"TemplateType":{"default":"RawHTML","type":"string","enum":["RawHTML","DragDropEditor","LandingPageEditor","TemplateEditor","FormTemplate","LandingPageTemplate","PaymentConfirmationTemplate","LandingPageProductTemplate","LandingPageCheckoutTemplate","LandingPagePaymentConfirmationTemplate"]},"TrackingType":{"default":"None","type":"string","description":"HTTP or HTTPS Protocal used for link tracking.","enum":["None","Delete","Http","ExternalHttps","InternalCertHttps","LetsEncryptCert"]},"TrackingValidationStatus":{"default":"Validated","type":"string","description":"Status of ValidDomain to determine how often tracking validation should be performed.","enum":["Validated","NotValidated","Invalid","Broken"]},"TransactionalRecipient":{"properties":{"To":{"items":{"format":"string","type":"string"},"type":"array","description":"List of recipients (visible to others)"},"CC":{"items":{"format":"string","type":"string"},"type":"array","description":"List of Carbon Copy recipients (visible to others)"},"BCC":{"items":{"format":"string","type":"string"},"type":"array","description":"List of Blind Carbon Copy recipients (hidden from other recipients)"}},"required":["To"],"type":"object","description":"List of transactional recipients"},"Utm":{"properties":{"Source":{"format":"string","type":"string","description":"utmsource value"},"Medium":{"format":"string","type":"string","description":"utmmedium value"},"Campaign":{"format":"string","type":"string","description":"utmcampaign value"},"Content":{"format":"string","type":"string","description":"utmcontent value"}},"type":"object","description":"Utm marketing data to be attached to every link in this e-mail."},"VerificationFileResult":{"properties":{"VerificationID":{"format":"string","type":"string","description":"Identifier of this verification result"},"Filename":{"format":"string","type":"string","description":"Origin file name"},"VerificationStatus":{"$ref":"#/components/schemas/VerificationStatus"},"FileUploadResult":{"$ref":"#/components/schemas/FileUploadResult"},"DateAdded":{"example":"2001-01-01T12:00:00","format":"date-time","type":"string","description":"Date of creation in YYYY-MM-DDThh:ii:ss format"},"Source":{"format":"string","type":"string","description":"Origin file extension"}},"type":"object","description":"Simple verification file result info"},"VerificationFileResultDetails":{"properties":{"VerificationResult":{"items":{"$ref":"#/components/schemas/EmailValidationResult"},"type":"array","description":"Verification result's details"},"VerificationID":{"format":"string","type":"string","description":"Identifier of this verification result"},"Filename":{"format":"string","type":"string","description":"Origin file name"},"VerificationStatus":{"$ref":"#/components/schemas/VerificationStatus"},"FileUploadResult":{"$ref":"#/components/schemas/FileUploadResult"},"DateAdded":{"example":"2001-01-01T12:00:00","format":"date-time","type":"string","description":"Date of creation in YYYY-MM-DDThh:ii:ss format"},"Source":{"format":"string","type":"string","description":"Origin file extension"}},"type":"object","description":"Detailed verification file result info"},"VerificationStatus":{"default":"Processing","type":"string","enum":["Processing","Ready","Expired","Verified","Error"]}},"securitySchemes":{"apikey":{"name":"X-ElasticEmail-ApiKey","in":"header","type":"apiKey"}}},"security":[{"apikey":[]}]}