Changelog

We will document changes to the API in this chapter. We try to not introduce backwards incompatible changes unless they cannot be avoided and it would cause errors to leave them out.

Only releases with API changes will be noted, which is why the list below appears to skip releases.

2.34.0 - Sep 20, 2018

• New method to check for active subscription on list: mailer.has_active_subscription().

2.33.0 - May 3, 2018

• New method to support the Right To Be Forgotten: mailer.forget_subscriber().

2.31.0 - July 17, 2017

• New methods for controlling sender details on newsletters: mailer.set_delivery_sender(), mailer.set_delivery_sender_rewrite_data_field().
• The above method also required new error code 5022 for invalid sender configurations.
• New methods for accessing consent details for subscriptions: mailer.get_subscription_consent_details(), mailer.set_subscription_consent_details().

2.30.1 - May 23, 2017

• New Ecommerce Tracking order parameter et_added for order time. See Ecommerce Tracking.
• New method for looking up error code 1001 causes for subscription methods: mailer.create_subscription_error()

2.30.0 - April 6, 2017

• Support for Ecommerce Tracking.
• New error codes for mailer.send_email() and mailer.send_email_with_names(): 5021.

2.29.0 - February 2, 2017

• Multiple choice support in POST Handler

2.28.0 - January 19, 2017

• Changed the XML-RPC namespace from ubivox to mailer. The old ubivox namespace will continue to work.
• Moved feeds documentation here: Feeds

2.27.1 - October 6, 2016

• Moved web form documentation here: POST Handler

2.23.0 - December 27, 2015

• Support for XML-RPC multicalls. See system.multicall()

2.22.1 - November 24, 2015

• New API functions for working with delivery templates: mailer.create_delivery_from_template(), mailer.update_delivery_template_content(), mailer.get_delivery_template_content()

2.22.0 - October 27, 2015

• New error code for handling encoding errors in RFC2822 formatted e-mails: 5019 in mailer.send_email_rfc2822().

2.21.4 - October 22, 2015

• New API methods for invoice access: mailer.account_invoice_list(), mailer.account_invoice_pdf(), mailer.account_invoice_details()

2.21.3 - October 8, 2015

• Correct handling of archived lists in API. Affected methods has had the 2005 fault introduced for invalid operations on an archived list.
• New error code for dealing with blocked accounts receiving new subscription 1011.

2.20.0 - September 3, 2015

• New API methods: mailer.delete_webhook_by_url(),

2.19.0 - July 30, 2015

• New error code for mailer.set_subscriber_data(), mailer.stop_subscriber() when sending invalid e-mail addresses: 1001

2.17.0 - May 12, 2015

• New splittest methods
• New API methods for administrative unsubscriptions: mailer.remove_subscription(), mailer.remove_all_subscriptions(),

2.16.0 - March 12, 2015

• New webhooks: delivery_read, link_clicked.

2.15.1 - January 20, 2015

• New exports methods

2.14.2 - September 9, 2014

• New API method mailer.set_delivery_in_archive().

2.13.10 - August 12, 2014

• New API method mailer.list_subscriptions().
• Added activated, renamed deleted to suspended in return struct of mailer.get_subscriber().

2.13.7 - May 6, 2014

• New API method: mailer.update_subscriber_email().

2.13.0 - January 27, 2014

• New API method: mailer.copy_delivery().
• New API method: mailer.update_data_field_options().
• Webhooks documentation added: Webhooks.

2.11.6 - November 19, 2013

• New API method: mailer.test_delivery(),
• Introduced extra statistics in mailer.get_delivery_stats(),
• Fixed a bug in mailer.synchronize() that would result in some unsubscriptions missing.

2.11.3 - October 22, 2013

• New API methods: mailer.get_stopped_subscribers_since(), mailer.get_maillist(),

2.11.1 - October 1, 2013

• New API methods: mailer.stop_subscriber(), mailer.get_stopped_subscribers(), mailer.maillist_archive_meta(),

2.11.0 - September 11, 2013

• New API methods: mailer.account_flag(), mailer.get_subscriber_delivery_stats(), mailer.synchronize(), mailer.time_zone(), partner.sudo()

2.10.6 - August 20, 2013

• Updated PHP examples with new API client: PHP Examples.

2.10.5 - August 13, 2013

• New method: mailer.copy_maillist().

2.10.3 - July 18, 2013

• New error code for Partner API Methods: 7009.
• Ubivox logos added.

2.10.1 - June 25, 2013

• Documented our new XML-RPC debugging facility. See Debugging.

2.10.0 - June 19, 2013

• New error codes for email methods: 9995.

2.9.6 - May 27, 2013

• Added recipients and delivered to mailer.account_status() (on published newsletters).

2.9.3 - April 22, 2013

• New webhook API, see webhook methods.

2.9.2 - March 26, 2013

• Added new method for accessing the list archive from the API: mailer.maillist_archive(). Also added the archive HTML version of the newsletter to mailer.get_delivery().
• Added choices and sort order to mailer.list_data_fields_details().
• Added new call: mailer.account_status().

2.9.1 - March 11, 2013

• Added support for targets: mailer.create_target(), mailer.list_targets(), mailer.update_target() and mailer.target_statistics().

2.9.0 - March 6, 2013

• Added send_time to results for calls to mailer.get_delivery(), mailer.list_deliveries(), and mailer.list_all_deliveries().
• Corrected bug in mailer.create_data_field() and mailer.update_data_field()
• Added mailer.time_zones() to expose the supported time zones.
• Added partner.available_account_types() and partner.client_details() to Partner API Methods.

2.8.1 - December 18, 2012

• Added clarification regarding Data fields with predefined options.

2.7.2 - October 24, 2012

• Added new chapter about our new Partner API that enables Ubivox Partner to mechanically create and update client accounts in Mailer. See Partner API Methods.

2.7.0 - October 11, 2012

• Added clarification of the data type of the data parameter in mailer.import_new().
• Added new chapter about our new Sales Tracking API that enables you to track the revenue generated by your newsletters. See Sales tracking.
• Added new error condition to mailer.create_delivery() and mailer.update_delivery(): 3004 used to indicate a problem with the delivery content.
• Added support for the time zone configured for your Ubivox account. See Date/time formats and time zone.
• Added clarification of the subscriber data structure. See Subscriber data.

2.5.0 - June 14, 2012

• New authentication feature: Multiple API logins, see Authentication.
• Corrected error in import API. mailer.import_new() does not take an overwrite argument.

2.4.2 - April 19, 2012

• New import API, see imports methods.

2.4.0 - March 15, 2012

• mailer.list_data_fields() and mailer.get_data_keys() now actually returns the key and not the title of the data field.
• mailer.create_data_field(): Has a new argument: key.
• mailer.update_data_field(): Changed old_title argument to key.
• Changed the error InvalidDataTitle to InvalidDataKey. Still has the error code 1005.