Migration notes

Overview

This topic provides information about the differences between REST API versions and how to best migrated your client application code to use the latest version.

  • Version 1.1 to 1.3
  • Version 1.1 to 1.2: Not applicable for the standard REST API. Version 1.2 applies only for accounts with Automatic Failover for Transactional Messaging (AFTM).
  • Version 1 to 1.1

Version 1.1 to 1.3

This section contains information about the differences between the v1.1 and v1.3 API. The table that follows shows the API task affected, describes the old version functionality, and shows the new version's functionality.

API Task

Version 1.1 API

Version 1.3 API

Merge Trigger Email and Merge Trigger SMS

records array and triggerData array grouped the field values and optional data values separately, making it more difficult to ensure that the optional data was matched to the correct records, as shown in the image below (click image to enlarge).

 

New array, mergeTriggerRecords, now groups the field values and optional data in a pair-wise fashion, as shown in the image below (click image to enlarge).

 

 

NOTE: Using the new format with the v1.1 endpoint results in a 500 error code (Internal Server Error). Using the old format with the v1.3 endpoint results in a 400 error code (Bad Request).

Screenshot illustrating the differences in the v1.1 and v1.3 MergeTrigger request body

Manage Email Campaign Schedule

Only supported using the campaign schedule calls for Email campaigns.

Now supports using the campaign schedule calls for Push campaigns. The account must have Integrated Push enabled. See the “Managing Campaign Schedules (Email or Push)” section for details.

Version 1 to 1.1

This section contains information about the differences between the v1 and v1.1 API.

API Task

Version 1 API

Version 1.1 API

Merge or update members in a profile extension table

matchColumn is deprecated

NOTE: You may still see this in the response body of some v1.1 and greater APIs.

Use matchColumnName1 and, optionally, matchColumnName2

Error Handling - For requests to trigger a message, when the response returns an error for a recipient then the success attribute is false.

The previous version of the API used to return the error description as part of the attribute errorMessage, with a description similar to the following: “Recipient deliverability status is undeliverable”.

The error description is now pre-pended with the error code, so that you can look up the error code from the errorMessage attribute: “ERROR_CODE: error description

For example: “RECIPIENT_STATUS_UNDELIVERABLE: Recipient deliverability status is undeliverable”.

 

[migration, matchColumn, matchColumnName1, matchColumnName2, errorMessage, Campaign Schedule, Merge Trigger Email, Merge Trigger SMS, v1.3, 1.3, version 1.3]

Learn more

What's new with the Oracle Responsys REST API

Migration tips