API Documentation
Labnify REST API
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.
Version: 4.0.0
BasePath:/v4
MIT
https://opensource.org/licenses/MIT
Access
API endpoint URL: https://relay.labnify.com/v4/emails
- APIKey KeyParamName:X-ElasticEmail-ApiKey KeyInQuery:false KeyInHeader:true
[ Jump to
Models ]
Table of Contents
Updelete /campaigns/{name}
Delete Campaign (campaignsByNameDelete)
Delete the specific campaign. This does not cancel in progress email, see Cancel In Progress. Required Access Level: ModifyCampaigns
Path parameters
name (required)
Path Parameter — Name of Campaign to delete format: string
Responses
200
OK
Load Campaign (campaignsByNameGet)
Returns the specified campaign details. Required Access Level: ViewCampaigns
Path parameters
name (required)
Path Parameter — Name of Campaign to get format: string
Return type
Example data
Content-Type: application/json
{
"Status" : "Deleted",
"Options" : {
"TrackClicks" : true,
"ScheduleFor" : "2000-01-23T04:56:07.000+00:00",
"DeliveryOptimization" : "None",
"TrackOpens" : true,
"SplitOptions" : {
"OptimizeFor" : "Opens",
"OptimizePeriodMinutes" : 30
}
},
"Recipients" : {
"SegmentNames" : [ "SegmentNames", "SegmentNames" ],
"ListNames" : [ "ListNames", "ListNames" ]
},
"Content" : [ {
"ReplyTo" : "John Doe ",
"Poolname" : "My Custom Pool",
"TemplateName" : "Template01",
"From" : "John Doe ",
"AttachFiles" : "[ \"preuploaded.jpg\" ]",
"Subject" : "Hello!",
"Utm" : {
"Campaign" : "Campaign",
"Medium" : "Medium",
"Content" : "Content",
"Source" : "Source"
}
}, {
"ReplyTo" : "John Doe ",
"Poolname" : "My Custom Pool",
"TemplateName" : "Template01",
"From" : "John Doe ",
"AttachFiles" : "[ \"preuploaded.jpg\" ]",
"Subject" : "Hello!",
"Utm" : {
"Campaign" : "Campaign",
"Medium" : "Medium",
"Content" : "Content",
"Source" : "Source"
}
} ],
"Name" : "Name"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
OK
Campaign
Update Campaign (campaignsByNamePut)
Updates a previously added campaign. Only Active and Paused campaigns can be updated. Required Access Level: ModifyCampaigns
Path parameters
name (required)
Path Parameter — Name of Campaign to update format: string
Consumes
This API call consumes the following media types via the request header:
Request body
Body Parameter — JSON representation of a campaign
Return type
Example data
Content-Type: application/json
{
"Status" : "Deleted",
"Options" : {
"TrackClicks" : true,
"ScheduleFor" : "2000-01-23T04:56:07.000+00:00",
"DeliveryOptimization" : "None",
"TrackOpens" : true,
"SplitOptions" : {
"OptimizeFor" : "Opens",
"OptimizePeriodMinutes" : 30
}
},
"Recipients" : {
"SegmentNames" : [ "SegmentNames", "SegmentNames" ],
"ListNames" : [ "ListNames", "ListNames" ]
},
"Content" : [ {
"ReplyTo" : "John Doe ",
"Poolname" : "My Custom Pool",
"TemplateName" : "Template01",
"From" : "John Doe ",
"AttachFiles" : "[ \"preuploaded.jpg\" ]",
"Subject" : "Hello!",
"Utm" : {
"Campaign" : "Campaign",
"Medium" : "Medium",
"Content" : "Content",
"Source" : "Source"
}
}, {
"ReplyTo" : "John Doe ",
"Poolname" : "My Custom Pool",
"TemplateName" : "Template01",
"From" : "John Doe ",
"AttachFiles" : "[ \"preuploaded.jpg\" ]",
"Subject" : "Hello!",
"Utm" : {
"Campaign" : "Campaign",
"Medium" : "Medium",
"Content" : "Content",
"Source" : "Source"
}
} ],
"Name" : "Name"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
OK
Campaign
Load Campaigns (campaignsGet)
Returns a list all of your campaigns. Limited to 1000 results. Required Access Level: ViewCampaigns
Query parameters
search (optional)
Query Parameter — Text fragment used for searching in Campaign name (using the 'contains' rule) format: string
offset (optional)
Query Parameter — How many items should be returned ahead. format: int32
limit (optional)
Query Parameter — Maximum number of returned items. format: int32
Return type
Example data
Content-Type: application/json
[ {
"Status" : "Deleted",
"Options" : {
"TrackClicks" : true,
"ScheduleFor" : "2000-01-23T04:56:07.000+00:00",
"DeliveryOptimization" : "None",
"TrackOpens" : true,
"SplitOptions" : {
"OptimizeFor" : "Opens",
"OptimizePeriodMinutes" : 30
}
},
"Recipients" : {
"SegmentNames" : [ "SegmentNames", "SegmentNames" ],
"ListNames" : [ "ListNames", "ListNames" ]
},
"Content" : [ {
"ReplyTo" : "John Doe ",
"Poolname" : "My Custom Pool",
"TemplateName" : "Template01",
"From" : "John Doe ",
"AttachFiles" : "[ \"preuploaded.jpg\" ]",
"Subject" : "Hello!",
"Utm" : {
"Campaign" : "Campaign",
"Medium" : "Medium",
"Content" : "Content",
"Source" : "Source"
}
}, {
"ReplyTo" : "John Doe ",
"Poolname" : "My Custom Pool",
"TemplateName" : "Template01",
"From" : "John Doe ",
"AttachFiles" : "[ \"preuploaded.jpg\" ]",
"Subject" : "Hello!",
"Utm" : {
"Campaign" : "Campaign",
"Medium" : "Medium",
"Content" : "Content",
"Source" : "Source"
}
} ],
"Name" : "Name"
}, {
"Status" : "Deleted",
"Options" : {
"TrackClicks" : true,
"ScheduleFor" : "2000-01-23T04:56:07.000+00:00",
"DeliveryOptimization" : "None",
"TrackOpens" : true,
"SplitOptions" : {
"OptimizeFor" : "Opens",
"OptimizePeriodMinutes" : 30
}
},
"Recipients" : {
"SegmentNames" : [ "SegmentNames", "SegmentNames" ],
"ListNames" : [ "ListNames", "ListNames" ]
},
"Content" : [ {
"ReplyTo" : "John Doe ",
"Poolname" : "My Custom Pool",
"TemplateName" : "Template01",
"From" : "John Doe ",
"AttachFiles" : "[ \"preuploaded.jpg\" ]",
"Subject" : "Hello!",
"Utm" : {
"Campaign" : "Campaign",
"Medium" : "Medium",
"Content" : "Content",
"Source" : "Source"
}
}, {
"ReplyTo" : "John Doe ",
"Poolname" : "My Custom Pool",
"TemplateName" : "Template01",
"From" : "John Doe ",
"AttachFiles" : "[ \"preuploaded.jpg\" ]",
"Subject" : "Hello!",
"Utm" : {
"Campaign" : "Campaign",
"Medium" : "Medium",
"Content" : "Content",
"Source" : "Source"
}
} ],
"Name" : "Name"
} ]
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
OK
Add Campaign (campaignsPost)
Add a campaign for processing. Required Access Level: ModifyCampaigns
Consumes
This API call consumes the following media types via the request header:
Request body
Body Parameter — JSON representation of a campaign
Return type
Example data
Content-Type: application/json
{
"Status" : "Deleted",
"Options" : {
"TrackClicks" : true,
"ScheduleFor" : "2000-01-23T04:56:07.000+00:00",
"DeliveryOptimization" : "None",
"TrackOpens" : true,
"SplitOptions" : {
"OptimizeFor" : "Opens",
"OptimizePeriodMinutes" : 30
}
},
"Recipients" : {
"SegmentNames" : [ "SegmentNames", "SegmentNames" ],
"ListNames" : [ "ListNames", "ListNames" ]
},
"Content" : [ {
"ReplyTo" : "John Doe ",
"Poolname" : "My Custom Pool",
"TemplateName" : "Template01",
"From" : "John Doe ",
"AttachFiles" : "[ \"preuploaded.jpg\" ]",
"Subject" : "Hello!",
"Utm" : {
"Campaign" : "Campaign",
"Medium" : "Medium",
"Content" : "Content",
"Source" : "Source"
}
}, {
"ReplyTo" : "John Doe ",
"Poolname" : "My Custom Pool",
"TemplateName" : "Template01",
"From" : "John Doe ",
"AttachFiles" : "[ \"preuploaded.jpg\" ]",
"Subject" : "Hello!",
"Utm" : {
"Campaign" : "Campaign",
"Medium" : "Medium",
"Content" : "Content",
"Source" : "Source"
}
} ],
"Name" : "Name"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
201
Created
Campaign
Updelete /contacts/{email}
Delete Contact (contactsByEmailDelete)
Deletes the provided contact. Required Access Level: ModifyContacts
Path parameters
email (required)
Path Parameter — Proper email address. format: string
Responses
200
OK
Load Contact (contactsByEmailGet)
Load detailed contact information for specified email. Required Access Level: ViewContacts
Path parameters
email (required)
Path Parameter — Proper email address. format: string
Return type
Example data
Content-Type: application/json
{
"Status" : "Transactional",
"CustomFields" : {
"city" : "New York",
"age" : "34"
},
"Email" : "[email protected]",
"StatusChangeDate" : "2000-01-23T04:56:07.000+00:00",
"Consent" : {
"ConsentTracking" : "Unknown",
"ConsentDate" : "2000-01-23T04:56:07.000+00:00",
"ConsentIP" : "192.168.0.1"
},
"FirstName" : "Fred",
"DateUpdated" : "2000-01-23T04:56:07.000+00:00",
"Activity" : {
"LastIP" : "LastIP",
"LastOpened" : "2000-01-23T04:56:07.000+00:00",
"TotalFailed" : 1000,
"LastSent" : "2000-01-23T04:56:07.000+00:00",
"LastFailed" : "2000-01-23T04:56:07.000+00:00",
"LastClicked" : "2000-01-23T04:56:07.000+00:00",
"TotalSent" : 1000,
"FriendlyErrorMessage" : "FriendlyErrorMessage",
"TotalClicked" : 1000,
"ErrorCode" : 0,
"TotalOpened" : 1000
},
"LastName" : "Flintstone",
"DateAdded" : "2000-01-23T04:56:07.000+00:00",
"Source" : "DeliveryApi"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
OK
Contact
Update Contact (contactsByEmailPut)
Update selected contact. Omitted contact's fields will not be changed. Required Access Level: ModifyContacts
Path parameters
email (required)
Path Parameter — Proper email address. format: string
Consumes
This API call consumes the following media types via the request header:
Request body
Return type
Example data
Content-Type: application/json
{
"Status" : "Transactional",
"CustomFields" : {
"city" : "New York",
"age" : "34"
},
"Email" : "[email protected]",
"StatusChangeDate" : "2000-01-23T04:56:07.000+00:00",
"Consent" : {
"ConsentTracking" : "Unknown",
"ConsentDate" : "2000-01-23T04:56:07.000+00:00",
"ConsentIP" : "192.168.0.1"
},
"FirstName" : "Fred",
"DateUpdated" : "2000-01-23T04:56:07.000+00:00",
"Activity" : {
"LastIP" : "LastIP",
"LastOpened" : "2000-01-23T04:56:07.000+00:00",
"TotalFailed" : 1000,
"LastSent" : "2000-01-23T04:56:07.000+00:00",
"LastFailed" : "2000-01-23T04:56:07.000+00:00",
"LastClicked" : "2000-01-23T04:56:07.000+00:00",
"TotalSent" : 1000,
"FriendlyErrorMessage" : "FriendlyErrorMessage",
"TotalClicked" : 1000,
"ErrorCode" : 0,
"TotalOpened" : 1000
},
"LastName" : "Flintstone",
"DateAdded" : "2000-01-23T04:56:07.000+00:00",
"Source" : "DeliveryApi"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
OK
Contact
Delete Contacts Bulk (contactsDeletePost)
Deletes provided contacts in bulk. Required Access Level: ModifyContacts
Consumes
This API call consumes the following media types via the request header:
Request body
Body Parameter — Provide either rule or a list of emails, not both.
Responses
200
OK
Upget /contacts/export/{id}/status
Check Export Status (contactsExportByIdStatusGet)
Check the current status of the export. Required Access Level: Export
Path parameters
id (required)
Path Parameter — ID of the exported file format: guid
Return type
Example data
Content-Type: application/json
"Error"
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
OK
ExportStatus
Export Contacts (contactsExportPost)
Request an Export of specified Contacts. Required Access Level: Export
Query parameters
fileFormat (optional)
Query Parameter — Format of the exported file
rule (optional)
Query Parameter — Query used for filtering. format: string
emails (optional)
Query Parameter — Comma delimited list of contact emails format: string
compressionFormat (optional)
Query Parameter — FileResponse compression format. None or Zip.
fileName (optional)
Query Parameter — Name of your file including extension. format: string
Return type
Example data
Content-Type: application/json
{
"PublicExportID" : "E33EBA7A-C20D-4D3D-8F2F-5EEF42F58E6F",
"Link" : "Link"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
202
Accepted
ExportLink
Load Contacts (contactsGet)
Returns a list of contacts. Required Access Level: ViewContacts
Query parameters
limit (optional)
Query Parameter — Maximum number of returned items. format: int32
offset (optional)
Query Parameter — How many items should be returned ahead. format: int32
Return type
Example data
Content-Type: application/json
[ {
"Status" : "Transactional",
"CustomFields" : {
"city" : "New York",
"age" : "34"
},
"Email" : "[email protected]",
"StatusChangeDate" : "2000-01-23T04:56:07.000+00:00",
"Consent" : {
"ConsentTracking" : "Unknown",
"ConsentDate" : "2000-01-23T04:56:07.000+00:00",
"ConsentIP" : "192.168.0.1"
},
"FirstName" : "Fred",
"DateUpdated" : "2000-01-23T04:56:07.000+00:00",
"Activity" : {
"LastIP" : "LastIP",
"LastOpened" : "2000-01-23T04:56:07.000+00:00",
"TotalFailed" : 1000,
"LastSent" : "2000-01-23T04:56:07.000+00:00",
"LastFailed" : "2000-01-23T04:56:07.000+00:00",
"LastClicked" : "2000-01-23T04:56:07.000+00:00",
"TotalSent" : 1000,
"FriendlyErrorMessage" : "FriendlyErrorMessage",
"TotalClicked" : 1000,
"ErrorCode" : 0,
"TotalOpened" : 1000
},
"LastName" : "Flintstone",
"DateAdded" : "2000-01-23T04:56:07.000+00:00",
"Source" : "DeliveryApi"
}, {
"Status" : "Transactional",
"CustomFields" : {
"city" : "New York",
"age" : "34"
},
"Email" : "[email protected]",
"StatusChangeDate" : "2000-01-23T04:56:07.000+00:00",
"Consent" : {
"ConsentTracking" : "Unknown",
"ConsentDate" : "2000-01-23T04:56:07.000+00:00",
"ConsentIP" : "192.168.0.1"
},
"FirstName" : "Fred",
"DateUpdated" : "2000-01-23T04:56:07.000+00:00",
"Activity" : {
"LastIP" : "LastIP",
"LastOpened" : "2000-01-23T04:56:07.000+00:00",
"TotalFailed" : 1000,
"LastSent" : "2000-01-23T04:56:07.000+00:00",
"LastFailed" : "2000-01-23T04:56:07.000+00:00",
"LastClicked" : "2000-01-23T04:56:07.000+00:00",
"TotalSent" : 1000,
"FriendlyErrorMessage" : "FriendlyErrorMessage",
"TotalClicked" : 1000,
"ErrorCode" : 0,
"TotalOpened" : 1000
},
"LastName" : "Flintstone",
"DateAdded" : "2000-01-23T04:56:07.000+00:00",
"Source" : "DeliveryApi"
} ]
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
OK
Upload Contacts (contactsImportPost)
Upload contacts from a file. Required Access Level: ModifyContacts
Consumes
This API call consumes the following media types via the request header:
Query parameters
listName (optional)
Query Parameter — Name of an existing list to add these contacts to format: string
encodingName (optional)
Query Parameter — In what encoding the file is uploaded format: string
fileUrl (optional)
Query Parameter — Optional url of csv to import format: string
Form parameters
file (required)
Form Parameter — format: binary
Responses
202
Accepted
Add Contact (contactsPost)
Add new Contacts to your Lists. Up to 1000 can be added (for more please refer to the import request). Required Access Level: ModifyContacts
Consumes
This API call consumes the following media types via the request header:
Request body
Query parameters
listnames (optional)
Query Parameter — Names of lists to which the uploaded contacts should be added to format: string
Return type
Example data
Content-Type: application/json
[ {
"Status" : "Transactional",
"CustomFields" : {
"city" : "New York",
"age" : "34"
},
"Email" : "[email protected]",
"StatusChangeDate" : "2000-01-23T04:56:07.000+00:00",
"Consent" : {
"ConsentTracking" : "Unknown",
"ConsentDate" : "2000-01-23T04:56:07.000+00:00",
"ConsentIP" : "192.168.0.1"
},
"FirstName" : "Fred",
"DateUpdated" : "2000-01-23T04:56:07.000+00:00",
"Activity" : {
"LastIP" : "LastIP",
"LastOpened" : "2000-01-23T04:56:07.000+00:00",
"TotalFailed" : 1000,
"LastSent" : "2000-01-23T04:56:07.000+00:00",
"LastFailed" : "2000-01-23T04:56:07.000+00:00",
"LastClicked" : "2000-01-23T04:56:07.000+00:00",
"TotalSent" : 1000,
"FriendlyErrorMessage" : "FriendlyErrorMessage",
"TotalClicked" : 1000,
"ErrorCode" : 0,
"TotalOpened" : 1000
},
"LastName" : "Flintstone",
"DateAdded" : "2000-01-23T04:56:07.000+00:00",
"Source" : "DeliveryApi"
}, {
"Status" : "Transactional",
"CustomFields" : {
"city" : "New York",
"age" : "34"
},
"Email" : "[email protected]",
"StatusChangeDate" : "2000-01-23T04:56:07.000+00:00",
"Consent" : {
"ConsentTracking" : "Unknown",
"ConsentDate" : "2000-01-23T04:56:07.000+00:00",
"ConsentIP" : "192.168.0.1"
},
"FirstName" : "Fred",
"DateUpdated" : "2000-01-23T04:56:07.000+00:00",
"Activity" : {
"LastIP" : "LastIP",
"LastOpened" : "2000-01-23T04:56:07.000+00:00",
"TotalFailed" : 1000,
"LastSent" : "2000-01-23T04:56:07.000+00:00",
"LastFailed" : "2000-01-23T04:56:07.000+00:00",
"LastClicked" : "2000-01-23T04:56:07.000+00:00",
"TotalSent" : 1000,
"FriendlyErrorMessage" : "FriendlyErrorMessage",
"TotalClicked" : 1000,
"ErrorCode" : 0,
"TotalOpened" : 1000
},
"LastName" : "Flintstone",
"DateAdded" : "2000-01-23T04:56:07.000+00:00",
"Source" : "DeliveryApi"
} ]
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
OK
Upget /emails/{msgid}/view
View Email (emailsByMsgidViewGet)
Returns email details for viewing or rendering. Required Access Level: None
Path parameters
msgid (required)
Path Parameter — Message identifier format: string
Return type
Example data
Content-Type: application/json
{
"Status" : {
"Status" : "All",
"DateOpened" : "2000-01-23T04:56:07.000+00:00",
"DateSent" : "2000-01-23T04:56:07.000+00:00",
"StatusChangeDate" : "2000-01-23T04:56:07.000+00:00",
"DateClicked" : "2000-01-23T04:56:07.000+00:00",
"EnvelopeFrom" : "EnvelopeFrom",
"StatusName" : "StatusName",
"From" : "From",
"To" : "To",
"ErrorMessage" : "ErrorMessage",
"Date" : "2000-01-23T04:56:07.000+00:00",
"TransactionID" : "TransactionID"
},
"Preview" : {
"From" : "From",
"Body" : "Body",
"Subject" : "Hello!"
},
"Attachments" : [ {
"ExpirationDate" : "2000-01-23T04:56:07.000+00:00",
"ContentType" : "image/jpeg",
"Size" : 100,
"FileName" : "filename.txt",
"DateAdded" : "2000-01-23T04:56:07.000+00:00"
}, {
"ExpirationDate" : "2000-01-23T04:56:07.000+00:00",
"ContentType" : "image/jpeg",
"Size" : 100,
"FileName" : "filename.txt",
"DateAdded" : "2000-01-23T04:56:07.000+00:00"
} ]
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
OK
EmailData
Send Bulk Emails CSV (emailsMergefilePost)
Send bulk merge email. Required Access Level: SendHttp
Consumes
This API call consumes the following media types via the request header:
Request body
Body Parameter — Email data
Return type
Example data
Content-Type: application/json
{
"TransactionID" : "TransactionID",
"MessageID" : "-HHGPM_9RPhSMiaJq_ab4g3"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
OK
EmailSend
Send Bulk Emails (emailsPost)
Send bulk merge email. Required Access Level: SendHttp
Consumes
This API call consumes the following media types via the request header:
Request body
Body Parameter — Email data
Return type
Example data
Content-Type: application/json
{
"TransactionID" : "TransactionID",
"MessageID" : "-HHGPM_9RPhSMiaJq_ab4g3"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
OK
EmailSend
Uppost /emails/transactional
Send Transactional Email (emailsTransactionalPost)
Send transactional emails (recipients will be known to each other). Required Access Level: SendHttp
Consumes
This API call consumes the following media types via the request header:
Request body
Body Parameter — Email data
Return type
Example data
Content-Type: application/json
{
"TransactionID" : "TransactionID",
"MessageID" : "-HHGPM_9RPhSMiaJq_ab4g3"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
OK
EmailSend
Upget /events/{transactionid}
Load Email Events (eventsByTransactionidGet)
Returns a log of delivery events for the specific transaction ID. Required Access Level: ViewReports
Path parameters
transactionid (required)
Path Parameter — ID number of transaction format: string
Query parameters
from (optional)
Query Parameter — Starting date for search in YYYY-MM-DDThh:mm:ss format. format: date-time
to (optional)
Query Parameter — Ending date for search in YYYY-MM-DDThh:mm:ss format. format: date-time
orderBy (optional)
Query Parameter —
limit (optional)
Query Parameter — Maximum number of returned items. format: int32
offset (optional)
Query Parameter — How many items should be returned ahead. format: int32
Return type
Example data
Content-Type: application/json
[ {
"EventDate" : "2000-01-23T04:56:07.000+00:00",
"NextTryOn" : "2000-01-23T04:56:07.000+00:00",
"Message" : "Lorem ipsum",
"EventType" : "Submission",
"MsgID" : "ABCDE_9RPhSWiaJq_ab1g1",
"Subject" : "Hello!",
"TransactionID" : "TransactionID",
"ChannelName" : "Channel01",
"PoolName" : "PoolName",
"To" : "2001-01-01T01:01:01",
"MessageCategory" : "Unknown",
"IPAddress" : "IPAddress",
"FromEmail" : "[email protected]"
}, {
"EventDate" : "2000-01-23T04:56:07.000+00:00",
"NextTryOn" : "2000-01-23T04:56:07.000+00:00",
"Message" : "Lorem ipsum",
"EventType" : "Submission",
"MsgID" : "ABCDE_9RPhSWiaJq_ab1g1",
"Subject" : "Hello!",
"TransactionID" : "TransactionID",
"ChannelName" : "Channel01",
"PoolName" : "PoolName",
"To" : "2001-01-01T01:01:01",
"MessageCategory" : "Unknown",
"IPAddress" : "IPAddress",
"FromEmail" : "[email protected]"
} ]
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
OK
Uppost /events/channels/{name}/export
Export Channel Events (eventsChannelsByNameExportPost)
Export delivery events log information to the specified file format. Required Access Level: Export
Path parameters
name (required)
Path Parameter — Name of selected channel. format: string
Query parameters
eventTypes (optional)
Query Parameter — Types of Events to return
from (optional)
Query Parameter — Starting date for search in YYYY-MM-DDThh:mm:ss format. format: date-time
to (optional)
Query Parameter — Ending date for search in YYYY-MM-DDThh:mm:ss format. format: date-time
fileFormat (optional)
Query Parameter — Format of the exported file
compressionFormat (optional)
Query Parameter — FileResponse compression format. None or Zip.
fileName (optional)
Query Parameter — Name of your file including extension. format: string
Return type
Example data
Content-Type: application/json
{
"PublicExportID" : "E33EBA7A-C20D-4D3D-8F2F-5EEF42F58E6F",
"Link" : "Link"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
202
Accepted
ExportLink
Upget /events/channels/{name}
Load Channel Events (eventsChannelsByNameGet)
Returns a log of delivery events filtered by specified parameters. Required Access Level: ViewReports
Path parameters
name (required)
Path Parameter — Name of selected channel. format: string
Query parameters
eventTypes (optional)
Query Parameter — Types of Events to return
from (optional)
Query Parameter — Starting date for search in YYYY-MM-DDThh:mm:ss format. format: date-time
to (optional)
Query Parameter — Ending date for search in YYYY-MM-DDThh:mm:ss format. format: date-time
orderBy (optional)
Query Parameter —
limit (optional)
Query Parameter — How many items to load. Maximum for this request is 1000 items format: int32
offset (optional)
Query Parameter — How many items should be returned ahead. format: int32
Return type
Example data
Content-Type: application/json
[ {
"EventDate" : "2000-01-23T04:56:07.000+00:00",
"NextTryOn" : "2000-01-23T04:56:07.000+00:00",
"Message" : "Lorem ipsum",
"EventType" : "Submission",
"MsgID" : "ABCDE_9RPhSWiaJq_ab1g1",
"Subject" : "Hello!",
"TransactionID" : "TransactionID",
"ChannelName" : "Channel01",
"PoolName" : "PoolName",
"To" : "2001-01-01T01:01:01",
"MessageCategory" : "Unknown",
"IPAddress" : "IPAddress",
"FromEmail" : "[email protected]"
}, {
"EventDate" : "2000-01-23T04:56:07.000+00:00",
"NextTryOn" : "2000-01-23T04:56:07.000+00:00",
"Message" : "Lorem ipsum",
"EventType" : "Submission",
"MsgID" : "ABCDE_9RPhSWiaJq_ab1g1",
"Subject" : "Hello!",
"TransactionID" : "TransactionID",
"ChannelName" : "Channel01",
"PoolName" : "PoolName",
"To" : "2001-01-01T01:01:01",
"MessageCategory" : "Unknown",
"IPAddress" : "IPAddress",
"FromEmail" : "[email protected]"
} ]
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
OK
Upget /events/channels/export/{id}/status
Check Channel Export Status (eventsChannelsExportByIdStatusGet)
Check the current status of the channel export. Required Access Level: Export
Path parameters
id (required)
Path Parameter — ID of the exported file format: guid
Return type
Example data
Content-Type: application/json
"Error"
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
OK
ExportStatus
Upget /events/export/{id}/status
Check Export Status (eventsExportByIdStatusGet)
Check the current status of the export. Required Access Level: Export
Path parameters
id (required)
Path Parameter — ID of the exported file format: guid
Return type
Example data
Content-Type: application/json
"Error"
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
OK
ExportStatus
Export Events (eventsExportPost)
Export delivery events log information to the specified file format. Required Access Level: Export
Query parameters
eventTypes (optional)
Query Parameter — Types of Events to return
from (optional)
Query Parameter — Starting date for search in YYYY-MM-DDThh:mm:ss format. format: date-time
to (optional)
Query Parameter — Ending date for search in YYYY-MM-DDThh:mm:ss format. format: date-time
fileFormat (optional)
Query Parameter — Format of the exported file
compressionFormat (optional)
Query Parameter — FileResponse compression format. None or Zip.
fileName (optional)
Query Parameter — Name of your file including extension. format: string
Return type
Example data
Content-Type: application/json
{
"PublicExportID" : "E33EBA7A-C20D-4D3D-8F2F-5EEF42F58E6F",
"Link" : "Link"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
202
Accepted
ExportLink
Load Events (eventsGet)
Returns a log of delivery events filtered by specified parameters. Required Access Level: ViewReports
Query parameters
eventTypes (optional)
Query Parameter — Types of Events to return
from (optional)
Query Parameter — Starting date for search in YYYY-MM-DDThh:mm:ss format. format: date-time
to (optional)
Query Parameter — Ending date for search in YYYY-MM-DDThh:mm:ss format. format: date-time
orderBy (optional)
Query Parameter —
limit (optional)
Query Parameter — How many items to load. Maximum for this request is 1000 items format: int32
offset (optional)
Query Parameter — How many items should be returned ahead. format: int32
Return type
Example data
Content-Type: application/json
[ {
"EventDate" : "2000-01-23T04:56:07.000+00:00",
"NextTryOn" : "2000-01-23T04:56:07.000+00:00",
"Message" : "Lorem ipsum",
"EventType" : "Submission",
"MsgID" : "ABCDE_9RPhSWiaJq_ab1g1",
"Subject" : "Hello!",
"TransactionID" : "TransactionID",
"ChannelName" : "Channel01",
"PoolName" : "PoolName",
"To" : "2001-01-01T01:01:01",
"MessageCategory" : "Unknown",
"IPAddress" : "IPAddress",
"FromEmail" : "[email protected]"
}, {
"EventDate" : "2000-01-23T04:56:07.000+00:00",
"NextTryOn" : "2000-01-23T04:56:07.000+00:00",
"Message" : "Lorem ipsum",
"EventType" : "Submission",
"MsgID" : "ABCDE_9RPhSWiaJq_ab1g1",
"Subject" : "Hello!",
"TransactionID" : "TransactionID",
"ChannelName" : "Channel01",
"PoolName" : "PoolName",
"To" : "2001-01-01T01:01:01",
"MessageCategory" : "Unknown",
"IPAddress" : "IPAddress",
"FromEmail" : "[email protected]"
} ]
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
OK
Delete File (filesByNameDelete)
Permanently deletes the file from your Account. Required Access Level: ModifyFiles
Path parameters
name (required)
Path Parameter — Name of your file including extension. format: string
Responses
200
OK
Download File (filesByNameGet)
Gets content of the specified File. Required Access Level: ViewFiles
Path parameters
name (required)
Path Parameter — Name of your file including extension. format: string
Return type
byte[]
Example data
Content-Type: application/json
""
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
OK
byte[]
Load File Details (filesByNameInfoGet)
Returns the specified File's details. Required Access Level: ViewFiles
Path parameters
name (required)
Path Parameter — Name of your file including extension. format: string
Return type
Example data
Content-Type: application/json
{
"ExpirationDate" : "2000-01-23T04:56:07.000+00:00",
"ContentType" : "image/jpeg",
"Size" : 100,
"FileName" : "filename.txt",
"DateAdded" : "2000-01-23T04:56:07.000+00:00"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
OK
FileInfo
List Files (filesGet)
Returns a list of all your available files. Required Access Level: ViewFiles
Query parameters
limit (optional)
Query Parameter — Maximum number of returned items. format: int32
offset (optional)
Query Parameter — How many items should be returned ahead. format: int32
Return type
Example data
Content-Type: application/json
[ {
"ExpirationDate" : "2000-01-23T04:56:07.000+00:00",
"ContentType" : "image/jpeg",
"Size" : 100,
"FileName" : "filename.txt",
"DateAdded" : "2000-01-23T04:56:07.000+00:00"
}, {
"ExpirationDate" : "2000-01-23T04:56:07.000+00:00",
"ContentType" : "image/jpeg",
"Size" : 100,
"FileName" : "filename.txt",
"DateAdded" : "2000-01-23T04:56:07.000+00:00"
} ]
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
OK
Upload File (filesPost)
Uploads selected file to the server. Required Access Level: ModifyFiles
Consumes
This API call consumes the following media types via the request header:
Request body
Query parameters
expiresAfterDays (optional)
Query Parameter — After how many days should the file be deleted. format: int32
Return type
Example data
Content-Type: application/json
{
"ExpirationDate" : "2000-01-23T04:56:07.000+00:00",
"ContentType" : "image/jpeg",
"Size" : 100,
"FileName" : "filename.txt",
"DateAdded" : "2000-01-23T04:56:07.000+00:00"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
201
Created
FileInfo
Updelete /inboundroute/{id}
Delete Route (inboundrouteByIdDelete)
Deletes the Inbound Route. Required Access Level: ModifySettings
Path parameters
id (required)
Path Parameter — format: guid
Responses
200
OK
Get Route (inboundrouteByIdGet)
Load an Inbound Route. Required Access Level: ViewSettings
Path parameters
id (required)
Path Parameter — ID number of your attachment format: guid
Return type
Example data
Content-Type: application/json
{
"PublicId" : "PublicId",
"FilterType" : "EmailAddress",
"ActionType" : "ForwardToEmail",
"Filter" : "Filter",
"SortOrder" : 0,
"ActionParameter" : "ActionParameter",
"Name" : "Name"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
OK
InboundRoute
Update Route (inboundrouteByIdPut)
Update the Inbound Route. Required Access Level: ModifySettings
Path parameters
id (required)
Path Parameter — format: guid
Consumes
This API call consumes the following media types via the request header:
Request body
Return type
Example data
Content-Type: application/json
{
"PublicId" : "PublicId",
"FilterType" : "EmailAddress",
"ActionType" : "ForwardToEmail",
"Filter" : "Filter",
"SortOrder" : 0,
"ActionParameter" : "ActionParameter",
"Name" : "Name"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
OK
InboundRoute
Get Routes (inboundrouteGet)
Get all your Inbound Routes. Required Access Level: ViewSettings
Return type
Example data
Content-Type: application/json
[ {
"PublicId" : "PublicId",
"FilterType" : "EmailAddress",
"ActionType" : "ForwardToEmail",
"Filter" : "Filter",
"SortOrder" : 0,
"ActionParameter" : "ActionParameter",
"Name" : "Name"
}, {
"PublicId" : "PublicId",
"FilterType" : "EmailAddress",
"ActionType" : "ForwardToEmail",
"Filter" : "Filter",
"SortOrder" : 0,
"ActionParameter" : "ActionParameter",
"Name" : "Name"
} ]
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
OK
Upput /inboundroute/order
Update Sorting (inboundrouteOrderPut)
Required Access Level: ViewSettings
Consumes
This API call consumes the following media types via the request header:
Request body
Body Parameter — Change the ordering of inbound routes for when matching the inbound
Return type
Example data
Content-Type: application/json
[ {
"PublicId" : "PublicId",
"FilterType" : "EmailAddress",
"ActionType" : "ForwardToEmail",
"Filter" : "Filter",
"SortOrder" : 0,
"ActionParameter" : "ActionParameter",
"Name" : "Name"
}, {
"PublicId" : "PublicId",
"FilterType" : "EmailAddress",
"ActionType" : "ForwardToEmail",
"Filter" : "Filter",
"SortOrder" : 0,
"ActionParameter" : "ActionParameter",
"Name" : "Name"
} ]
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
OK
Create Route (inboundroutePost)
Create new Inbound Route. Required Access Level: ModifySettings
Consumes
This API call consumes the following media types via the request header:
Request body
Return type
Example data
Content-Type: application/json
{
"PublicId" : "PublicId",
"FilterType" : "EmailAddress",
"ActionType" : "ForwardToEmail",
"Filter" : "Filter",
"SortOrder" : 0,
"ActionParameter" : "ActionParameter",
"Name" : "Name"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
OK
InboundRoute
Uppost /lists/{name}/contacts
Add Contacts to List (listsByNameContactsPost)
Add existing Contacts to specified list. Required Access Level: ModifyContacts
Path parameters
name (required)
Path Parameter — Name of your list. format: string
Consumes
This API call consumes the following media types via the request header:
Request body
Body Parameter — Provide either rule or a list of emails, not both.
Return type
Example data
Content-Type: application/json
{
"AllowUnsubscribe" : false,
"ListName" : "My List 1",
"PublicListID" : "E33EBA7A-C20D-4D3D-8F2F-5EEF42F58E6F",
"DateAdded" : "2000-01-23T04:56:07.000+00:00"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
OK
ContactsList
Uppost /lists/{name}/contacts/remove
Remove Contacts from List (listsByNameContactsRemovePost)
Remove specified Contacts from your list. Required Access Level: ModifyContacts
Path parameters
name (required)
Path Parameter — Name of your list. format: string
Consumes
This API call consumes the following media types via the request header:
Request body
Body Parameter — Provide either rule or a list of emails, not both.
Responses
200
OK
Delete List (listsByNameDelete)
Deletes List and removes all the Contacts from it (does not delete Contacts). Required Access Level: ModifyContacts
Path parameters
name (required)
Path Parameter — Name of your list. format: string
Responses
200
OK
Load List (listsByNameGet)
Returns detailed information about specified list. Required Access Level: ViewContacts
Path parameters
name (required)
Path Parameter — Name of your list. format: string
Return type
Example data
Content-Type: application/json
{
"AllowUnsubscribe" : false,
"ListName" : "My List 1",
"PublicListID" : "E33EBA7A-C20D-4D3D-8F2F-5EEF42F58E6F",
"DateAdded" : "2000-01-23T04:56:07.000+00:00"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
OK
ContactsList
Update List (listsByNamePut)
Update existing list. Required Access Level: ModifyContacts
Path parameters
name (required)
Path Parameter — Name of your list. format: string
Consumes
This API call consumes the following media types via the request header:
Request body
Return type
Example data
Content-Type: application/json
{
"AllowUnsubscribe" : false,
"ListName" : "My List 1",
"PublicListID" : "E33EBA7A-C20D-4D3D-8F2F-5EEF42F58E6F",
"DateAdded" : "2000-01-23T04:56:07.000+00:00"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
OK
ContactsList
Load Lists (listsGet)
Returns all your existing lists. Required Access Level: ViewContacts
Query parameters
limit (optional)
Query Parameter — Maximum number of returned items. format: int32
offset (optional)
Query Parameter — How many items should be returned ahead. format: int32
Return type
Example data
Content-Type: application/json
[ {
"AllowUnsubscribe" : false,
"ListName" : "My List 1",
"PublicListID" : "E33EBA7A-C20D-4D3D-8F2F-5EEF42F58E6F",
"DateAdded" : "2000-01-23T04:56:07.000+00:00"
}, {
"AllowUnsubscribe" : false,
"ListName" : "My List 1",
"PublicListID" : "E33EBA7A-C20D-4D3D-8F2F-5EEF42F58E6F",
"DateAdded" : "2000-01-23T04:56:07.000+00:00"
} ]
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
OK
Add List (listsPost)
Add a new list. Required Access Level: ModifyContacts
Consumes
This API call consumes the following media types via the request header:
Request body
Return type
Example data
Content-Type: application/json
{
"AllowUnsubscribe" : false,
"ListName" : "My List 1",
"PublicListID" : "E33EBA7A-C20D-4D3D-8F2F-5EEF42F58E6F",
"DateAdded" : "2000-01-23T04:56:07.000+00:00"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
201
Created
ContactsList
Updelete /security/apikeys/{name}
Delete ApiKey (securityApikeysByNameDelete)
Delete your existing ApiKey. Required Access Level: Security
Path parameters
name (required)
Path Parameter — Name of the ApiKey format: string
Responses
200
OK
Upget /security/apikeys/{name}
Load ApiKey (securityApikeysByNameGet)
Load your existing ApiKey info. Required Access Level: Security
Path parameters
name (required)
Path Parameter — Name of the ApiKey format: string
Return type
Example data
Content-Type: application/json
{
"RestrictAccessToIPRange" : [ "RestrictAccessToIPRange", "RestrictAccessToIPRange" ],
"DateCreated" : "2000-01-23T04:56:07.000+00:00",
"LastUse" : "2000-01-23T04:56:07.000+00:00",
"Expires" : "2000-01-23T04:56:07.000+00:00",
"AccessLevel" : [ "None", "None" ],
"Name" : "Name"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
OK
ApiKey
Upput /security/apikeys/{name}
Update ApiKey (securityApikeysByNamePut)
Update your existing ApiKey. Required Access Level: Security
Path parameters
name (required)
Path Parameter — Name of the ApiKey format: string
Consumes
This API call consumes the following media types via the request header:
Request body
Return type
Example data
Content-Type: application/json
{
"RestrictAccessToIPRange" : [ "RestrictAccessToIPRange", "RestrictAccessToIPRange" ],
"DateCreated" : "2000-01-23T04:56:07.000+00:00",
"LastUse" : "2000-01-23T04:56:07.000+00:00",
"Expires" : "2000-01-23T04:56:07.000+00:00",
"AccessLevel" : [ "None", "None" ],
"Name" : "Name"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
OK
ApiKey
List ApiKeys (securityApikeysGet)
List all your existing ApiKeys. Required Access Level: Security
Return type
Example data
Content-Type: application/json
[ {
"RestrictAccessToIPRange" : [ "RestrictAccessToIPRange", "RestrictAccessToIPRange" ],
"DateCreated" : "2000-01-23T04:56:07.000+00:00",
"LastUse" : "2000-01-23T04:56:07.000+00:00",
"Expires" : "2000-01-23T04:56:07.000+00:00",
"AccessLevel" : [ "None", "None" ],
"Name" : "Name"
}, {
"RestrictAccessToIPRange" : [ "RestrictAccessToIPRange", "RestrictAccessToIPRange" ],
"DateCreated" : "2000-01-23T04:56:07.000+00:00",
"LastUse" : "2000-01-23T04:56:07.000+00:00",
"Expires" : "2000-01-23T04:56:07.000+00:00",
"AccessLevel" : [ "None", "None" ],
"Name" : "Name"
} ]
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
OK
Add ApiKey (securityApikeysPost)
Add a new ApiKey. Required Access Level: Security
Consumes
This API call consumes the following media types via the request header:
Request body
Return type
Example data
Content-Type: application/json
{
"RestrictAccessToIPRange" : [ "RestrictAccessToIPRange", "RestrictAccessToIPRange" ],
"DateCreated" : "2000-01-23T04:56:07.000+00:00",
"Token" : "Token",
"LastUse" : "2000-01-23T04:56:07.000+00:00",
"Expires" : "2000-01-23T04:56:07.000+00:00",
"AccessLevel" : [ "None", "None" ],
"Name" : "Name"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
201
Created
NewApiKey
Updelete /security/smtp/{name}
Delete SMTP Credential (securitySmtpByNameDelete)
Delete your existing SMTP Credentials. Required Access Level: Security
Path parameters
name (required)
Path Parameter — Name of the SMTP Credential format: string
Responses
200
OK
Upget /security/smtp/{name}
Load SMTP Credential (securitySmtpByNameGet)
Load your existing SMTP Credential info. Required Access Level: Security
Path parameters
name (required)
Path Parameter — Name of the SMTP Credential format: string
Return type
Example data
Content-Type: application/json
{
"RestrictAccessToIPRange" : [ "RestrictAccessToIPRange", "RestrictAccessToIPRange" ],
"DateCreated" : "2000-01-23T04:56:07.000+00:00",
"LastUse" : "2000-01-23T04:56:07.000+00:00",
"Expires" : "2000-01-23T04:56:07.000+00:00",
"AccessLevel" : "None",
"Name" : "Name"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
OK
SmtpCredentials
Upput /security/smtp/{name}
Update SMTP Credential (securitySmtpByNamePut)
Update your existing SMTP Credentials. Required Access Level: Security
Path parameters
name (required)
Path Parameter — Name of the SMTP Credential format: string
Consumes
This API call consumes the following media types via the request header:
Request body
Return type
Example data
Content-Type: application/json
{
"RestrictAccessToIPRange" : [ "RestrictAccessToIPRange", "RestrictAccessToIPRange" ],
"DateCreated" : "2000-01-23T04:56:07.000+00:00",
"LastUse" : "2000-01-23T04:56:07.000+00:00",
"Expires" : "2000-01-23T04:56:07.000+00:00",
"AccessLevel" : "None",
"Name" : "Name"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
OK
SmtpCredentials
List SMTP Credentials (securitySmtpGet)
List all your existing SMTP Credentials. Required Access Level: Security
Return type
Example data
Content-Type: application/json
[ {
"RestrictAccessToIPRange" : [ "RestrictAccessToIPRange", "RestrictAccessToIPRange" ],
"DateCreated" : "2000-01-23T04:56:07.000+00:00",
"LastUse" : "2000-01-23T04:56:07.000+00:00",
"Expires" : "2000-01-23T04:56:07.000+00:00",
"AccessLevel" : "None",
"Name" : "Name"
}, {
"RestrictAccessToIPRange" : [ "RestrictAccessToIPRange", "RestrictAccessToIPRange" ],
"DateCreated" : "2000-01-23T04:56:07.000+00:00",
"LastUse" : "2000-01-23T04:56:07.000+00:00",
"Expires" : "2000-01-23T04:56:07.000+00:00",
"AccessLevel" : "None",
"Name" : "Name"
} ]
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
OK
Add SMTP Credential (securitySmtpPost)
Add new SMTP Credential. Required Access Level: Security
Consumes
This API call consumes the following media types via the request header:
Request body
Return type
Example data
Content-Type: application/json
{
"RestrictAccessToIPRange" : [ "RestrictAccessToIPRange", "RestrictAccessToIPRange" ],
"DateCreated" : "2000-01-23T04:56:07.000+00:00",
"Token" : "Token",
"LastUse" : "2000-01-23T04:56:07.000+00:00",
"Expires" : "2000-01-23T04:56:07.000+00:00",
"AccessLevel" : "None",
"Name" : "Name"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
201
Created
NewSmtpCredentials
Updelete /segments/{name}
Delete Segment (segmentsByNameDelete)
Delete an existing segment. Required Access Level: ModifyContacts
Path parameters
name (required)
Path Parameter — Name of your segment. format: string
Responses
200
OK
Load Segment (segmentsByNameGet)
Returns details for the specified segment. Required Access Level: ViewContacts
Path parameters
name (required)
Path Parameter — Name of the segment you want to load. Will load all contacts if the 'All Contacts' name has been provided format: string
Return type
Example data
Content-Type: application/json
{
"Rule" : "Rule",
"Name" : "Name"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
OK
Segment
Update Segment (segmentsByNamePut)
Rename or change RULE for your segment. Required Access Level: ModifyContacts
Path parameters
name (required)
Path Parameter — Name of your segment. format: string
Consumes
This API call consumes the following media types via the request header:
Request body
Return type
Example data
Content-Type: application/json
{
"Rule" : "Rule",
"Name" : "Name"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
OK
Segment
Load Segments (segmentsGet)
Returns a list of all your available Segments. Required Access Level: ViewContacts
Query parameters
limit (optional)
Query Parameter — Maximum number of returned items. format: int32
offset (optional)
Query Parameter — How many items should be returned ahead. format: int32
Return type
Example data
Content-Type: application/json
[ {
"Rule" : "Rule",
"Name" : "Name"
}, {
"Rule" : "Rule",
"Name" : "Name"
} ]
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
OK
Add Segment (segmentsPost)
Add a new segment, based on specified RULE. Required Access Level: ModifyContacts
Consumes
This API call consumes the following media types via the request header:
Request body
Return type
Example data
Content-Type: application/json
{
"Rule" : "Rule",
"Name" : "Name"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
201
Created
Segment
Upget /statistics/campaigns/{name}
Load Campaign Stats (statisticsCampaignsByNameGet)
Retrieve stats of an existing campaign. Required Access Level: ViewChannels
Path parameters
name (required)
Path Parameter — The name of the campaign to get. format: string
Return type
Example data
Content-Type: application/json
{
"NotDelivered" : 0,
"Opened" : 1000,
"Recipients" : 1234,
"Delivered" : 1000,
"Clicked" : 1000,
"EmailTotal" : 1234,
"Inbound" : 1000,
"SmsTotal" : 12,
"ChannelName" : "ChannelName",
"Bounced" : 1000,
"InProgress" : 1234,
"Complaints" : 1000,
"ManualCancel" : 1000,
"Unsubscribed" : 1000
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
OK
ChannelLogStatusSummary
Upget /statistics/campaigns
Load Campaigns Stats (statisticsCampaignsGet)
Returns a list of your Campaigns' stats. Required Access Level: ViewChannels
Query parameters
limit (optional)
Query Parameter — Maximum number of returned items. format: int32
offset (optional)
Query Parameter — How many items should be returned ahead. format: int32
Return type
Example data
Content-Type: application/json
[ {
"NotDelivered" : 0,
"Opened" : 1000,
"Recipients" : 1234,
"Delivered" : 1000,
"Clicked" : 1000,
"EmailTotal" : 1234,
"Inbound" : 1000,
"SmsTotal" : 12,
"ChannelName" : "ChannelName",
"Bounced" : 1000,
"InProgress" : 1234,
"Complaints" : 1000,
"ManualCancel" : 1000,
"Unsubscribed" : 1000
}, {
"NotDelivered" : 0,
"Opened" : 1000,
"Recipients" : 1234,
"Delivered" : 1000,
"Clicked" : 1000,
"EmailTotal" : 1234,
"Inbound" : 1000,
"SmsTotal" : 12,
"ChannelName" : "ChannelName",
"Bounced" : 1000,
"InProgress" : 1234,
"Complaints" : 1000,
"ManualCancel" : 1000,
"Unsubscribed" : 1000
} ]
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
OK
Upget /statistics/channels/{name}
Load Channel Stats (statisticsChannelsByNameGet)
Retrieve an existing channel stats. Required Access Level: ViewChannels
Path parameters
name (required)
Path Parameter — The name of the channel to get. format: string
Return type
Example data
Content-Type: application/json
{
"NotDelivered" : 0,
"Opened" : 1000,
"Recipients" : 1234,
"Delivered" : 1000,
"Clicked" : 1000,
"EmailTotal" : 1234,
"Inbound" : 1000,
"SmsTotal" : 12,
"ChannelName" : "ChannelName",
"Bounced" : 1000,
"InProgress" : 1234,
"Complaints" : 1000,
"ManualCancel" : 1000,
"Unsubscribed" : 1000
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
OK
ChannelLogStatusSummary
Upget /statistics/channels
Load Channels Stats (statisticsChannelsGet)
Returns a list of your Channels' stats. Required Access Level: ViewChannels
Query parameters
limit (optional)
Query Parameter — Maximum number of returned items. format: int32
offset (optional)
Query Parameter — How many items should be returned ahead. format: int32
Return type
Example data
Content-Type: application/json
[ {
"NotDelivered" : 0,
"Opened" : 1000,
"Recipients" : 1234,
"Delivered" : 1000,
"Clicked" : 1000,
"EmailTotal" : 1234,
"Inbound" : 1000,
"SmsTotal" : 12,
"ChannelName" : "ChannelName",
"Bounced" : 1000,
"InProgress" : 1234,
"Complaints" : 1000,
"ManualCancel" : 1000,
"Unsubscribed" : 1000
}, {
"NotDelivered" : 0,
"Opened" : 1000,
"Recipients" : 1234,
"Delivered" : 1000,
"Clicked" : 1000,
"EmailTotal" : 1234,
"Inbound" : 1000,
"SmsTotal" : 12,
"ChannelName" : "ChannelName",
"Bounced" : 1000,
"InProgress" : 1234,
"Complaints" : 1000,
"ManualCancel" : 1000,
"Unsubscribed" : 1000
} ]
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
OK
Load Statistics (statisticsGet)
Returns basic statistics. Required Access Level: ViewReports
Query parameters
from (required)
Query Parameter — Starting date for search in YYYY-MM-DDThh:mm:ss format. format: date-time
to (optional)
Query Parameter — Ending date for search in YYYY-MM-DDThh:mm:ss format. format: date-time
Return type
Example data
Content-Type: application/json
{
"NotDelivered" : 0,
"Opened" : 1000,
"Recipients" : 1234,
"Delivered" : 1000,
"Clicked" : 1000,
"EmailTotal" : 1234,
"Inbound" : 1000,
"SmsTotal" : 12,
"Bounced" : 1000,
"InProgress" : 1234,
"Complaints" : 1000,
"ManualCancel" : 1000,
"Unsubscribed" : 1000
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
OK
LogStatusSummary
Upget /suppressions/bounces
Get Bounce List (suppressionsBouncesGet)
Retrieve your list of bounced emails. Required Access Level: ViewContacts, ViewSuppressions
Query parameters
search (optional)
Query Parameter — Text fragment used for searching. format: string
limit (optional)
Query Parameter — Maximum number of returned items. format: int32
offset (optional)
Query Parameter — How many items should be returned ahead. format: int32
Return type
Example data
Content-Type: application/json
[ {
"Email" : "[email protected]",
"FriendlyErrorMessage" : "Mailbox not found",
"DateUpdated" : "2000-01-23T04:56:07.000+00:00",
"ErrorCode" : 0
}, {
"Email" : "[email protected]",
"FriendlyErrorMessage" : "Mailbox not found",
"DateUpdated" : "2000-01-23T04:56:07.000+00:00",
"ErrorCode" : 0
} ]
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
OK
Uppost /suppressions/bounces/import
Add Bounces Async (suppressionsBouncesImportPost)
Add Bounced. Required Access Level: ModifyContacts, ModifySuppressions
Consumes
This API call consumes the following media types via the request header:
Form parameters
file (required)
Form Parameter — format: binary
Responses
202
Accepted
Uppost /suppressions/bounces
Add Bounces (suppressionsBouncesPost)
Add Bounced. Required Access Level: ModifyContacts, ModifySuppressions
Consumes
This API call consumes the following media types via the request header:
Request body
Body Parameter — Emails to add as bounces. Limited to 1000 per request
Return type
Example data
Content-Type: application/json
[ {
"Email" : "[email protected]",
"FriendlyErrorMessage" : "Mailbox not found",
"DateUpdated" : "2000-01-23T04:56:07.000+00:00",
"ErrorCode" : 0
}, {
"Email" : "[email protected]",
"FriendlyErrorMessage" : "Mailbox not found",
"DateUpdated" : "2000-01-23T04:56:07.000+00:00",
"ErrorCode" : 0
} ]
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
201
Created
Updelete /suppressions/{email}
Delete Suppression (suppressionsByEmailDelete)
Delete Suppression. Required Access Level: ViewContacts, ViewSuppressions
Path parameters
email (required)
Path Parameter — Proper email address. format: string
Responses
200
OK
Upget /suppressions/{email}
Get Suppression (suppressionsByEmailGet)
Retrieve your suppression. Required Access Level: ViewContacts, ViewSuppressions
Path parameters
email (required)
Path Parameter — Proper email address. format: string
Return type
Example data
Content-Type: application/json
{
"Email" : "[email protected]",
"FriendlyErrorMessage" : "Mailbox not found",
"DateUpdated" : "2000-01-23T04:56:07.000+00:00",
"ErrorCode" : 0
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
OK
Suppression
Upget /suppressions/complaints
Get Complaints List (suppressionsComplaintsGet)
Retrieve your list of complaints. Required Access Level: ViewContacts, ViewSuppressions
Query parameters
search (optional)
Query Parameter — Text fragment used for searching. format: string
limit (optional)
Query Parameter — Maximum number of returned items. format: int32
offset (optional)
Query Parameter — How many items should be returned ahead. format: int32
Return type
Example data
Content-Type: application/json
[ {
"Email" : "[email protected]",
"FriendlyErrorMessage" : "Mailbox not found",
"DateUpdated" : "2000-01-23T04:56:07.000+00:00",
"ErrorCode" : 0
}, {
"Email" : "[email protected]",
"FriendlyErrorMessage" : "Mailbox not found",
"DateUpdated" : "2000-01-23T04:56:07.000+00:00",
"ErrorCode" : 0
} ]
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
OK
Uppost /suppressions/complaints/import
Add Complaints Async (suppressionsComplaintsImportPost)
Add Complaints. Required Access Level: ModifyContacts, ModifySuppressions
Consumes
This API call consumes the following media types via the request header:
Form parameters
file (required)
Form Parameter — format: binary
Responses
202
Accepted
Uppost /suppressions/complaints
Add Complaints (suppressionsComplaintsPost)
Add Complaints. Required Access Level: ModifyContacts, ModifySuppressions
Consumes
This API call consumes the following media types via the request header:
Request body
Body Parameter — Emails to add as complaints. Limited to 1000 per request
Return type
Example data
Content-Type: application/json
[ {
"Email" : "[email protected]",
"FriendlyErrorMessage" : "Mailbox not found",
"DateUpdated" : "2000-01-23T04:56:07.000+00:00",
"ErrorCode" : 0
}, {
"Email" : "[email protected]",
"FriendlyErrorMessage" : "Mailbox not found",
"DateUpdated" : "2000-01-23T04:56:07.000+00:00",
"ErrorCode" : 0
} ]
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
201
Created
Get Suppressions (suppressionsGet)
Retrieve your suppressions. Required Access Level: ViewContacts, ViewSuppressions
Query parameters
limit (optional)
Query Parameter — Maximum number of returned items. format: int32
offset (optional)
Query Parameter — How many items should be returned ahead. format: int32
Return type
Example data
Content-Type: application/json
[ {
"Email" : "[email protected]",
"FriendlyErrorMessage" : "Mailbox not found",
"DateUpdated" : "2000-01-23T04:56:07.000+00:00",
"ErrorCode" : 0
}, {
"Email" : "[email protected]",
"FriendlyErrorMessage" : "Mailbox not found",
"DateUpdated" : "2000-01-23T04:56:07.000+00:00",
"ErrorCode" : 0
} ]
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
OK
Upget /suppressions/unsubscribes
Get Unsubscribes List (suppressionsUnsubscribesGet)
Retrieve your list of unsubscribes. Required Access Level: ViewContacts, ViewSuppressions
Query parameters
search (optional)
Query Parameter — Text fragment used for searching. format: string
limit (optional)
Query Parameter — Maximum number of returned items. format: int32
offset (optional)
Query Parameter — How many items should be returned ahead. format: int32
Return type
Example data
Content-Type: application/json
[ {
"Email" : "[email protected]",
"FriendlyErrorMessage" : "Mailbox not found",
"DateUpdated" : "2000-01-23T04:56:07.000+00:00",
"ErrorCode" : 0
}, {
"Email" : "[email protected]",
"FriendlyErrorMessage" : "Mailbox not found",
"DateUpdated" : "2000-01-23T04:56:07.000+00:00",
"ErrorCode" : 0
} ]
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
OK
Uppost /suppressions/unsubscribes/import
Add Unsubscribes Async (suppressionsUnsubscribesImportPost)
Add Unsubscribes. Required Access Level: ModifyContacts, ModifySuppressions
Consumes
This API call consumes the following media types via the request header:
Form parameters
file (required)
Form Parameter — format: binary
Responses
202
Accepted
Uppost /suppressions/unsubscribes
Add Unsubscribes (suppressionsUnsubscribesPost)
Add Unsubscribes. Required Access Level: ModifyContacts, ModifySuppressions
Consumes
This API call consumes the following media types via the request header:
Request body
Body Parameter — Emails to add as unsubscribes. Limited to 1000 per request
Return type
Example data
Content-Type: application/json
[ {
"Email" : "[email protected]",
"FriendlyErrorMessage" : "Mailbox not found",
"DateUpdated" : "2000-01-23T04:56:07.000+00:00",
"ErrorCode" : 0
}, {
"Email" : "[email protected]",
"FriendlyErrorMessage" : "Mailbox not found",
"DateUpdated" : "2000-01-23T04:56:07.000+00:00",
"ErrorCode" : 0
} ]
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
201
Created
Updelete /templates/{name}
Delete Template (templatesByNameDelete)
Delete template with the specified name. Required Access Level: ModifyTemplates
Path parameters
name (required)
Path Parameter — Name of template. format: string
Responses
200
OK
Load Template (templatesByNameGet)
Load detailed information of the specified template. Required Access Level: ViewTemplates
Path parameters
name (required)
Path Parameter — Name of template. format: string
Return type
Example data
Content-Type: application/json
{
"TemplateScope" : "Personal",
"TemplateType" : "RawHTML",
"DateAdded" : "2000-01-23T04:56:07.000+00:00",
"Body" : [ {
"ContentType" : "HTML",
"Content" : "Content",
"Charset" : "Charset"
}, {
"ContentType" : "HTML",
"Content" : "Content",
"Charset" : "Charset"
} ],
"Subject" : "Hello!",
"Name" : "Name"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Serialized template
Template
Update Template (templatesByNamePut)
Update existing template, overwriting existing data. Required Access Level: ModifyTemplates
Path parameters
name (required)
Path Parameter — Name of template. format: string
Consumes
This API call consumes the following media types via the request header:
Request body
Return type
Example data
Content-Type: application/json
{
"TemplateScope" : "Personal",
"TemplateType" : "RawHTML",
"DateAdded" : "2000-01-23T04:56:07.000+00:00",
"Body" : [ {
"ContentType" : "HTML",
"Content" : "Content",
"Charset" : "Charset"
}, {
"ContentType" : "HTML",
"Content" : "Content",
"Charset" : "Charset"
} ],
"Subject" : "Hello!",
"Name" : "Name"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
OK
Template
Load Templates (templatesGet)
Returns a list of templates for the specified type. Required Access Level: ViewTemplates
Query parameters
scopeType (required)
Query Parameter — Return templates with specified scope only
templateTypes (optional)
Query Parameter — Return templates with specified type only
limit (optional)
Query Parameter — Maximum number of returned items. format: int32
offset (optional)
Query Parameter — How many items should be returned ahead. format: int32
Return type
Example data
Content-Type: application/json
[ {
"TemplateScope" : "Personal",
"TemplateType" : "RawHTML",
"DateAdded" : "2000-01-23T04:56:07.000+00:00",
"Body" : [ {
"ContentType" : "HTML",
"Content" : "Content",
"Charset" : "Charset"
}, {
"ContentType" : "HTML",
"Content" : "Content",
"Charset" : "Charset"
} ],
"Subject" : "Hello!",
"Name" : "Name"
}, {
"TemplateScope" : "Personal",
"TemplateType" : "RawHTML",
"DateAdded" : "2000-01-23T04:56:07.000+00:00",
"Body" : [ {
"ContentType" : "HTML",
"Content" : "Content",
"Charset" : "Charset"
}, {
"ContentType" : "HTML",
"Content" : "Content",
"Charset" : "Charset"
} ],
"Subject" : "Hello!",
"Name" : "Name"
} ]
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
OK
Add Template (templatesPost)
Add a new Template. Required Access Level: ModifyTemplates
Consumes
This API call consumes the following media types via the request header:
Request body
Return type
Example data
Content-Type: application/json
{
"TemplateScope" : "Personal",
"TemplateType" : "RawHTML",
"DateAdded" : "2000-01-23T04:56:07.000+00:00",
"Body" : [ {
"ContentType" : "HTML",
"Content" : "Content",
"Charset" : "Charset"
}, {
"ContentType" : "HTML",
"Content" : "Content",
"Charset" : "Charset"
} ],
"Subject" : "Hello!",
"Name" : "Name"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
201
Template
Template
[ Jump to
Methods ]
Table of Contents
AccessLevelAccountStatusEnumApiKeyApiKeyPayloadBodyContentTypeBodyPartCampaignCampaignOptionsCampaignRecipientCampaignStatusCampaignTemplateChannelLogStatusSummaryCompressionFormatConsentDataConsentTrackingContactContactActivityContactPayloadContactSourceContactStatusContactUpdatePayloadContactsListDeliveryOptimizationTypeEmailContentEmailDataEmailMessageDataEmailPredictedValidationStatusEmailRecipientEmailSendEmailStatusEmailTransactionalMessageDataEmailValidationResultEmailValidationStatusEmailViewEmailsPayloadEncodingTypeEventTypeEventsOrderByExportFileFormatsExportLinkExportStatusFileInfoFilePayloadFileUploadResultInboundPayloadInboundRouteInboundRouteActionTypeInboundRouteFilterTypeListPayloadListUpdatePayloadLogJobStatusLogStatusSummaryMergeEmailPayloadMessageAttachmentMessageCategoryNewApiKeyNewSmtpCredentialsOptionsRecipientEventSegmentSegmentPayloadSmtpCredentialsSmtpCredentialsPayloadSortOrderItemSplitOptimizationTypeSplitOptionsSuppressionTemplateTemplatePayloadTemplateScopeTemplateTypeTransactionalRecipientUtmbounces_import_bodycomplaints_import_bodycontacts_import_bodyunsubscribes_import_body
ApiKey info
AccessLevel (optional)
Name (optional)
String Name of the ApiKey. format: string
DateCreated (optional)
Date Date this ApiKey was created. format: date-time
LastUse (optional)
Date Date this ApiKey was last used. format: date-time
Expires (optional)
Date Date this ApiKey expires. format: date-time
RestrictAccessToIPRange (optional)
Create a new ApiKey
Name
String Name of the ApiKey for ease of reference. format: string
AccessLevel
Expires (optional)
Date Date this ApiKey expires. format: date-time
RestrictAccessToIPRange (optional)
Email body part with user-provided MIME type (text/html, text/plain, etc)
ContentType
Content (optional)
String Actual content of the body part format: string
Charset (optional)
String Text value of charset encoding for example: iso-8859-1, windows-1251, utf-8, us-ascii, windows-1250 and more... format: string
Content (optional)
Name
String Campaign name format: string
Status (optional)
Recipients
Options (optional)
Different send options for a Campaign
DeliveryOptimization (optional)
TrackOpens (optional)
Boolean Should the opens be tracked? If no value has been provided, Account's default setting will be used. format: boolean
example: true
TrackClicks (optional)
Boolean Should the clicks be tracked? If no value has been provided, Account's default setting will be used. format: boolean
example: true
ScheduleFor (optional)
Date Date when this Campaign is scheduled to be sent on format: date-time
SplitOptions (optional)
A set of lists and segments names to read recipients from
ListNames (optional)
array[String] Names of lists from your Account to read recipients from format: string
SegmentNames (optional)
array[String] Names of segments from your Account to read recipients from format: string
Content of a Campaign
Poolname (optional)
String Name of your custom IP Pool to be used in the sending process format: string
example: My Custom Pool
From (optional)
ReplyTo (optional)
Subject (optional)
String Default subject of email. format: string
example: Hello!
TemplateName (optional)
String Name of template. format: string
example: Template01
AttachFiles (optional)
array[String] Names of previously uploaded files that should be sent as downloadable attachments format: string
example: [ "preuploaded.jpg" ]
Utm (optional)
Summary of channel log status
ChannelName (optional)
String Channel name format: string
Recipients (optional)
Long Number of recipients format: int64
example: 1234
EmailTotal (optional)
Long Number of emails format: int64
example: 1234
SmsTotal (optional)
Long Number of SMS format: int64
example: 12
Delivered (optional)
Long Number of delivered messages format: int64
example: 1000
Bounced (optional)
Long Number of bounced messages format: int64
example: 1000
InProgress (optional)
Long Number of messages in progress format: int64
example: 1234
Opened (optional)
Long Number of opened messages format: int64
example: 1000
Clicked (optional)
Long Number of clicked messages format: int64
example: 1000
Unsubscribed (optional)
Long Number of unsubscribed messages format: int64
example: 1000
Complaints (optional)
Long Number of complaint messages format: int64
example: 1000
Inbound (optional)
Long Number of inbound messages format: int64
example: 1000
ManualCancel (optional)
Long Number of manually cancelled messages format: int64
example: 1000
NotDelivered (optional)
Long Number of messages flagged with 'Not Delivered' format: int64
example: 0
FileResponse compression format
ConsentIP (optional)
String IP address of consent to send this contact(s) your email. If not provided your current public IP address is used for consent. format: string
example: 192.168.0.1
ConsentDate (optional)
Date Date of consent to send this contact(s) your email. If not provided current date is used for consent. format: date-time
ConsentTracking (optional)
Contact
Email (optional)
String Proper email address. format: string
Status (optional)
FirstName (optional)
String First name. format: string
example: Fred
LastName (optional)
String Last name. format: string
example: Flintstone
CustomFields (optional)
map[String, String] A key-value collection of custom contact fields which can be used in the system.
example: {"city":"New York","age":"34"}
Consent (optional)
Source (optional)
DateAdded (optional)
Date Date of creation in YYYY-MM-DDThh:ii:ss format format: date-time
DateUpdated (optional)
Date Last change date format: date-time
StatusChangeDate (optional)
Date Date of last status change. format: date-time
Activity (optional)
TotalSent (optional)
Integer Total emails sent. format: int32
example: 1000
TotalOpened (optional)
Integer Total emails opened. format: int32
example: 1000
TotalClicked (optional)
Integer Total emails clicked format: int32
example: 1000
TotalFailed (optional)
Integer Total emails failed. format: int32
example: 1000
LastSent (optional)
Date Last date when an email was sent to this contact format: date-time
LastOpened (optional)
Date Date this contact last opened an email format: date-time
LastClicked (optional)
Date Date this contact last clicked an email format: date-time
LastFailed (optional)
Date Last date when an email sent to this contact bounced format: date-time
LastIP (optional)
String IP from which this contact opened or clicked their email last time format: string
ErrorCode (optional)
Integer Last RFC Error code if any occurred format: int32
FriendlyErrorMessage (optional)
String Last RFC error message if any occurred format: string
Email
String Proper email address. format: string
Status (optional)
FirstName (optional)
String First name. format: string
example: Fred
LastName (optional)
String Last name. format: string
example: Flintstone
CustomFields (optional)
map[String, String] A key-value collection of custom contact fields which can be used in the system. Only already existing custom fields will be saved.
example: {"city":"New York","age":"34"}
Consent (optional)
FirstName (optional)
String First name. format: string
example: Fred
LastName (optional)
String Last name. format: string
example: Flintstone
CustomFields (optional)
map[String, String] A key-value collection of custom contact fields which can be used in the system.
example: {"city":"New York","age":"34"}
List of Lists, with detailed data about its contents.
ListName (optional)
String Name of your list. format: string
example: My List 1
PublicListID (optional)
String ID code of list. Please note that this is different from the listid field. format: guid
example: E33EBA7A-C20D-4D3D-8F2F-5EEF42F58E6F
DateAdded (optional)
Date Date of creation in YYYY-MM-DDThh:ii:ss format format: date-time
AllowUnsubscribe (optional)
Boolean True: Allow unsubscribing from this list. Otherwise, false format: boolean
example: false
Proper e-mail content
Body (optional)
array[BodyPart] List of e-mail body parts, with user-provided MIME types (text/html, text/plain etc)
Merge (optional)
map[String, String] A key-value collection of custom merge fields, shared between recipients. Should be used in e-mail body like so: {firstname}, {lastname} etc.
example: {"city":"New York","age":"34"}
Attachments (optional)
Headers (optional)
example: {"city":"New York","age":"34"}
Postback (optional)
String Postback header. format: string
EnvelopeFrom (optional)
From (optional)
ReplyTo (optional)
Subject (optional)
String Default subject of email. format: string
example: Hello!
TemplateName (optional)
String Name of template. format: string
example: Template01
AttachFiles (optional)
array[String] Names of previously uploaded files that should be sent as downloadable attachments format: string
example: [ "preuploaded.jpg" ]
Utm (optional)
Preview (optional)
Attachments (optional)
Status (optional)
Email data
Recipients
Content (optional)
Options (optional)
List of recipients
Email
String Proper email address. format: string
Fields (optional)
example: {"city":"New York","age":"34"}
TransactionID (optional)
String ID number of transaction format: string
example: TransactionID
MessageID (optional)
String Unique identifier for this email. format: string
example: -HHGPM_9RPhSMiaJq_ab4g3
Status information of the specified email
From (optional)
String Email address this email was sent from. format: string
To (optional)
String Email address this email was sent to. format: string
Date (optional)
Date Date the email was submitted. format: date-time
Status (optional)
StatusName (optional)
String Name of email's status format: string
StatusChangeDate (optional)
Date Date of last status change. format: date-time
DateSent (optional)
Date Date when the email was sent format: date-time
DateOpened (optional)
Date Date when the email changed the status to 'opened' format: date-time
DateClicked (optional)
Date Date when the email changed the status to 'clicked' format: date-time
ErrorMessage (optional)
String Detailed error or bounced message. format: string
TransactionID (optional)
String ID number of transaction format: guid
example: TransactionID
EnvelopeFrom (optional)
String Envelope from address format: string
Email data
Recipients
Content (optional)
Options (optional)
Account (optional)
String Local part of an email format: string
Domain (optional)
String Name of selected domain. format: string
example: example.com
Email (optional)
String Full email address that was verified format: string
SuggestedSpelling (optional)
String Suggested spelling if a possible mistake was found format: string
Disposable (optional)
Boolean Does the email have a temporary domain format: boolean
Role (optional)
Boolean Is an email a role email (e.g. info@, noreply@ etc.) format: boolean
Reason (optional)
String All detected issues format: string
DateAdded (optional)
Date Date of creation in YYYY-MM-DDThh:ii:ss format format: date-time
Result (optional)
PredictedScore (optional)
PredictedStatus (optional)
Email details formatted in json
Body (optional)
String Body (HTML, otherwise plain text) of email format: string
Subject (optional)
String Default subject of email. format: string
example: Hello!
From (optional)
String From email address format: string
Provide either rule or a list of emails, not both.
Rule (optional)
String SQL-like rule. Sending 'All' as a value loads all resources of the given type.
Emails (optional)
array[String] Comma delimited list of contact emails format: string
Encoding type for the email headers
Format of the exported file.
Link (optional)
String Direct URL to the exported file format: string
PublicExportID (optional)
String ID of the exported file format: guid
example: E33EBA7A-C20D-4D3D-8F2F-5EEF42F58E6F
Current status of the export.
File information
FileName (optional)
String Name of your file including extension. format: string
example: filename.txt
Size (optional)
Integer Size of your attachment (in bytes). format: int32
example: 100
DateAdded (optional)
Date Date of creation in YYYY-MM-DDThh:ii:ss format format: date-time
ExpirationDate (optional)
Date Date when the file will be deleted from your Account. format: date-time
ContentType (optional)
String Content type of the file. format: string
example: image/jpeg
BinaryContent
byte[] Content of the file sent as binary data format: byte
Name (optional)
String Filename format: string
example: attachment.txt
ContentType (optional)
String Type of file's content (e.g. image/jpeg) format: string
EmailsCount (optional)
Integer How many unique emails were detected the file format: int32
DuplicatedEmailsCount (optional)
Integer How many email duplicates were detected format: int32
Filter
String Filter of the inbound data format: string
Name
String Name of this route format: string
FilterType
ActionType
EmailAddress (optional)
String Email to forward the inbound to format: string
HttpAddress (optional)
String Address to notify about the inbound format: string
PublicId (optional)
Name (optional)
String Name of this route format: string
FilterType (optional)
Filter (optional)
String Filter of the inbound data format: string
ActionType (optional)
ActionParameter (optional)
String URL address or Email to notify about the inbound format: string
SortOrder (optional)
Integer Place of this route in your routes queue's order format: int32
ListName
String Name of your list. format: string
example: My List 1
AllowUnsubscribe (optional)
Boolean True: Allow unsubscribing from this list. Otherwise, false format: boolean
example: false
Emails (optional)
array[String] Comma delimited list of existing contact emails that should be added to this list. Leave empty for all contacts format: string
NewListName (optional)
String Name of your list if you want to change it. format: string
example: My List 2
AllowUnsubscribe (optional)
Boolean True: Allow unsubscribing from this list. Otherwise, false format: boolean
example: false
Summary of log status
Recipients (optional)
Long Number of recipients format: int64
example: 1234
EmailTotal (optional)
Long Number of emails format: int64
example: 1234
SmsTotal (optional)
Long Number of SMS format: int64
example: 12
Delivered (optional)
Long Number of delivered messages format: int64
example: 1000
Bounced (optional)
Long Number of bounced messages format: int64
example: 1000
InProgress (optional)
Long Number of messages in progress format: int64
example: 1234
Opened (optional)
Long Number of opened messages format: int64
example: 1000
Clicked (optional)
Long Number of clicked messages format: int64
example: 1000
Unsubscribed (optional)
Long Number of unsubscribed messages format: int64
example: 1000
Complaints (optional)
Long Number of complaint messages format: int64
example: 1000
Inbound (optional)
Long Number of inbound messages format: int64
example: 1000
ManualCancel (optional)
Long Number of manually cancelled messages format: int64
example: 1000
NotDelivered (optional)
Long Number of messages flagged with 'Not Delivered' format: int64
example: 0
MergeFile
Content (optional)
Options (optional)
BinaryContent
byte[] File's content as byte array (or a Base64 string) format: byte
Name
String Display name of the file format: string
ContentType (optional)
String MIME content type format: string
Size (optional)
Integer Size of your attachment (in bytes). format: int32
example: 100
Newly generated ApiKey with Token
Token (optional)
String Unique token to be used in the system format: string
AccessLevel (optional)
Name (optional)
String Name of the ApiKey. format: string
DateCreated (optional)
Date Date this ApiKey was created. format: date-time
LastUse (optional)
Date Date this ApiKey was last used. format: date-time
Expires (optional)
Date Date this ApiKey expires. format: date-time
RestrictAccessToIPRange (optional)
Newly generated SMTP Credentials with Token
Token (optional)
String Unique token to be used in the system format: string
AccessLevel (optional)
Name (optional)
String Name of the key. format: string
DateCreated (optional)
Date Date this SmtpCredential was created. format: date-time
LastUse (optional)
Date Date this SmtpCredential was last used. format: date-time
Expires (optional)
Date Date this SmtpCredential expires. format: date-time
RestrictAccessToIPRange (optional)
array[String] Which IPs can use this SmtpCredential format: string
E-mail configuration
TimeOffset (optional)
Integer By how long should an e-mail be delayed (in minutes). Maximum is 35 days. format: int32
PoolName (optional)
String Name of your custom IP Pool to be used in the sending process format: string
example: My Custom Pool
ChannelName (optional)
String Name of selected channel. format: string
example: Channel01
Encoding (optional)
TrackOpens (optional)
Boolean Should the opens be tracked? If no value has been provided, Account's default setting will be used. format: boolean
example: true
TrackClicks (optional)
Boolean Should the clicks be tracked? If no value has been provided, Account's default setting will be used. format: boolean
example: true
Detailed information about message recipient
TransactionID (optional)
String ID number of transaction format: string
example: TransactionID
MsgID (optional)
String ID number of selected message. format: string
example: ABCDE_9RPhSWiaJq_ab1g1
FromEmail (optional)
String Default From: email address. format: string
To (optional)
String Ending date for search in YYYY-MM-DDThh:mm:ss format. format: string
example: 2001-01-01T01:01:01
Subject (optional)
String Default subject of email. format: string
example: Hello!
EventType (optional)
EventDate (optional)
Date Creation date format: date-time
ChannelName (optional)
String Name of selected channel. format: string
example: Channel01
MessageCategory (optional)
NextTryOn (optional)
Date Date of next try format: date-time
Message (optional)
String Content of message, HTML encoded format: string
example: Lorem ipsum
IPAddress (optional)
String IP which this email was sent through format: string
PoolName (optional)
String Name of an IP pool this email was sent through format: string
Dynamic collection of Contacts, managed by SQL-like rule.
Name (optional)
String Segment name format: string
Rule (optional)
String SQL-like rule to determine which Contacts belong to this Segment. format: string
Name
String Segment name format: string
Rule
String SQL-like rule to determine which Contacts belong to this Segment. format: string
SMTP Credentials info
AccessLevel (optional)
Name (optional)
String Name of the key. format: string
DateCreated (optional)
Date Date this SmtpCredential was created. format: date-time
LastUse (optional)
Date Date this SmtpCredential was last used. format: date-time
Expires (optional)
Date Date this SmtpCredential expires. format: date-time
RestrictAccessToIPRange (optional)
array[String] Which IPs can use this SmtpCredential format: string
Create new SMTP Credentials
Name
String Name of the Credential for ease of reference. It must be a valid email address. format: string
Expires (optional)
Date Date this SmtpCredential expires. format: date-time
RestrictAccessToIPRange (optional)
array[String] Which IPs can use this SmtpCredential format: string
Change the ordering of this inbound route for when matching the inbound
PublicInboundId
String ID of the route to change the order of format: guid
SortOrder
Integer 1 - route will be used first format: int32
Optional A/X split campaign options
OptimizeFor (optional)
OptimizePeriodMinutes (optional)
Integer For how long should the results be measured until determining the winner template (content) format: int32
example: 30
Suppression - Email returning Hard Bounces
Email (optional)
String Proper email address. format: string
FriendlyErrorMessage (optional)
String RFC error message format: string
example: Mailbox not found
ErrorCode (optional)
Integer SMTP Error code format: int32
DateUpdated (optional)
Date Last change date format: date-time
Template info
TemplateType (optional)
Name (optional)
String Template name format: string
DateAdded (optional)
Date Date of creation in YYYY-MM-DDThh:ii:ss format format: date-time
Subject (optional)
String Default subject of email. format: string
example: Hello!
Body (optional)
TemplateScope (optional)
New template object
Name
String Template name format: string
Subject (optional)
String Default subject of email. format: string
example: Hello!
Body (optional)
TemplateScope (optional)
List of transactional recipients
To
array[String] List of recipients (visible to others) format: string
CC (optional)
array[String] List of Carbon Copy recipients (visible to others) format: string
BCC (optional)
array[String] List of Blind Carbon Copy recipients (hidden from other recipients) format: string
Utm marketing data to be attached to every link in this e-mail.
Source (optional)
String utmsource value format: string
Medium (optional)
String utmmedium value format: string
Campaign (optional)
String utmcampaign value format: string
Content (optional)
String utmcontent value format: string
