The following changelog lists all changes to our web service interface (API) since 2025.
Find changes from previous years in the archive of our update newsletter (automatic translation).
The web service documentation as PDF describes all API functions with their parameters and example data.
Both functions return a chronologically sorted list of subscriber events for a wide range of event types. A bug was fixed for the event type 'optout' when multiple list IDs were passed in the 'listFilter' parameter. These IDs are now interpreted using an OR condition, as with all other event types. This means that every unsubscribe in any one of the requested lists will be returned.
The 'Export History' function starts a job that exports a chronologically sorted list of subscriber events as a CSV file.
Included are events for all subscribes and unsubscribes, profile changes, sends, deliveries, bounces, opens, clicks, tell-a-friend actions, as well as non-sends due to blacklist, complaint list, exclusion list, retained list, or logically invalid email address. 'ExportHistory' is the improved successor to 'GetHistory'. Advantage: The new function processes any amount of data with a single call. 'ExportHistory' returns a jobId and starts a job in the background. You then query the job status via 'GetExportHistoryJobById'. As soon as the status changes to 'done' the resultparameter 'url' contains the download link to the generated CSV file.
Please use filter parameters as precisely as possible with every call. This gives you the smallest possible data set at maximum processing speed, making any further handling easier.
All supported filter parameters can be combined: time range, event types, subscriber lists, subscriber field values, subscriber IDs.
The CSV file uses the user settings from the menu "Custom settings -> Export defaults": character set, field separator, column separator.
The download link is valid for 48 hours. The URL cannot be retrieved using login data from a different account. However, the URL itself is publicly accessible if it is known.
The number of ExportHistory jobs that can run at the same time is limited to one job per account and two jobs system-wide.
The function "SendEmailByIdAndRecipient" sends a transactional email to a single recipient. Such an email is typically triggered by a user action, for example an online purchase. Delivery now usually happens within just a few seconds, similar to our previously fastest function "SendEmailByIdAndRecipientAsynchronous".
Compared to the asynchronous variant, "SendEmailByIdAndRecipient" offers the following advantages:
The email is included in the Email Statistics, so you can easily analyze deliveries, opens, and clicks.
The function supports attachments using the advanced parameter "attachments".
When you call the function, the result "successfully executed" is more meaningful. It not only confirms that the call was processed, but also that the send job for the subscriber was successfully created.
The "CreateWebspaceFile" function uploads a file to your webspace. With the new "path" parameter, you can optionally define the desired folder path in the format "directory/subdirectory".
The "ClearWebspaceFolder" function empties the contents of the folder that you define in the "path" parameter in the format "directory/subdirectory".
The functions "GetRecipientIdByEmail" and "GetRecipientIdsByEmail" return the subscriber ID(s) for an email address. We have significantly accelerated both functions. They now return matches even in subscriber lists with several million subscribers usually within one second.
The function "GetRecipients" returns subscriber data, which you can currently limit to a specific subscriber list and target group. We have extended the function with a filter for the subscribers' creation date. In the new "startCreateDate" and "endCreateDate" parameters, you define the desired time range in the format "yyyy-mm-dd hh:mm:ss".