Asset API
The Asset API provides the ability to upload content into a campaign. Content can be loaded into a campaign one asset at a time, or multiple assets can be loaded via a compressed (zip) file. The asset type is determined by the file extension so the assetName that is specified in the payload must correspond to one of entries in the table below. Since only one html asset and one text asset are allowed per content block, they can be referred to in the URI by html and text, as in /assets/html and /assets/text.
Content Block API
The content block API provides the ability to create, update, and retrieve a content block. Content can be loaded into a content block one asset at a time, or multiple assets can be loaded via a compressed (zip) file. The asset type is determined by the file extension so the assetName that is specified in the payload must correspond to one of entries in the table below. Since only one html asset and one text asset are allowed per content block, they can be referred to in the URI by html and text, as in /contentblocks/{id}/html and /contentblocks/{id}/text.
Listload API
Listload is a resource to access the list loading process. This is an asynchronous service by which you may load targeting lists of users.
You can post a URL to the data file to import the file from an FTP site. You can use a new or existing or list load name – and upload new or update existing subscribers. Please note, a company must be setup for imports before using this API. The listload API only supports importing email addresses. A successful list load will result in a 202 response code and will redirect to status uri.
List Management API
Lists represent an arbitrary collection of subscribers that are used in conjunction with the Message API. There are two general types of lists:
- Listload lists - These lists are used as part of targeting for a message. They can be accessed and updated through this API or updated in bulk using the Listload API. The subtype aspects of this API are not relevant to listloads. Additionally, listload lists are never removed from the system. If a request is made to "delete" one of these lists via this API it is instead archived, all users are removed from the list, but the list name remains in the system for referential integrity. As a result of the archive difference the list name that was used remains unavailable for future use.
- Distribution lists have several subtypes:
- SEEDLIST - A small list that can be used within a message to inject a small number of test emails into a larger mailing. Subscribers in the seedlist are emailed irrespective of whether or not the fit the specific targeting profile.
- TESTGROUP - A list used primarily for testing a message to a relatively small number of users. For larger volumes a listload list should be used instead.
Campaign Management API
A campaign represents a email campaign, in the simplest sense. A campaign is the confluence of content that makes up the email, targeting data that identifies specific user groups, email specific values, such as from domain names, from users and the email subject line as well as the schedule for when the emails will be compiled and delivered.
This API is focused on providing a way to mail against one listload and deliver that campaign one time.
Message Status API
This resource provides the capability to enable or disable a message as well as obtain the current message state.
Message Preview API
This API provides a way to preview a message by sending it to a group of email addresses, following the same semantics as the preview functionality within the Enterprise Application. There are two different ways to target who receives your preview: either a space delimited list of emails or a named distribution list. When using the space delimited list of emails, these users do not have to be entered into the system, a user Id is required when using this mode and the email templating is done according to the data for that user. Conceptually this is like saying "send me the email as it would have appeared for that user." When using the distribution list method all of the users must have data entered into the system and they will each receive an email templated according to their individual settings.
Triggered Messaging API
This API provides a way to send a 1:1 message to a subscribed user. As part of the delivery process, a "message sent" event will be captured in the database, just as it would for a subscribed user in a batch mailing. The messages can be personalized by including attribute name/value pairs as part of the request.
A 202 response code means that the request was accepted.
Subscribe and Send Composite API
This API documentation is being developed. This API is an example of a composite service, it combines the functionality of the Subscriber API and the Triggered Messaging API into a single call. The semantics of this call are very similar to if a user posted a subscriber request, polled for the status to be marked as completed, and then submitted a triggered message request (using the subscriber id from the previous call). This API differs from that work flow in the following ways:
- This API checks to see if the email used in the subscriber element, if a user with that email already exists then that record is updated to match the attributes specified, otherwise the request is treated as a POST to the Subscriber API would be and new a user is created.
- This API is comprised of multiple steps so it is possible for the final status code to be ERROR and yet have some persistent changes made to the system. For example the subscriber request could succeed and yet the triggered message part might fail due to a problem with the targeted message. In these cases a finalResourceURI will be present in the status response indicating that the subscriber request succeeded. Once the issue causing the failure has been addressed the request can be resubmitted and the subscriber portion will be treated as an update to the existing user that was called in the previous attempt.
Subscriber API
The subscriber API lets you manage all aspects of a company's subscribers. Actions that can be performed include the following:
- Create a new subscriber
- Lookup a subscriber by attribute(s) (typically the email address)
- Update the attributes of an existing subscriber
- Retrieve all information about a subscriber, including attributes, division subscription status, etc.
- Subscribe to a division
- Unsubscribe from a division
Note that these operations take place on an individual subscriber level. If you want to bulk upload subscribers please use the Listload API.