GuidesAPI ReferenceChangelog
GuidesAPI ReferenceChangelog
GuidesAPI ReferenceChangelogLog In
Back to All

Version 2023.10 release notes

6 months ago by [email protected]

We are delighted to roll out Version 2023.10 of the Criteo API. This latest version comes into effect on October 28, 2023 and will be a stable API version, fully supported until October 31, 2024. Post this date, all undeprecated Endpoints will be "out of support" but still accessible. For comprehensive information, please refer to our versioning policy.

What's New:

New Endpoints Added:

There are three new endpoints for managing contact lists. After creating an audience segment of the type contact list, you can use the following endpoints to update its content.

Adding and Removing Users

PATCH /2023-10/marketing-solutions/audience-segments/{audience-segment-id}/contact-list/

  • Users can be added or removed from an audience segment with a PATCH request to the audience contact list endpoint with the specific audience segment id in the URL path. The request body requires the type of operation, the schema of the identifiers, and the list of the user identifiers to be added. In addition, if the identifier type is 'gum', an additional parameter, the gumCallerId, must also be included. Please note that the supported identifier types for Criteo audiences include: 'email' (Email Address), 'madid' (Mobile Ad Identifier), 'identityLink' (a user's LiveRamp Identity Link), 'gum' (Criteo GUM cookie identifier) and 'customerid' (only for Retail Media Customer Lists).

Deleting All Users

DELETE /marketing-solutions/audience-segments/{audience-segment-id}/contact-list/

  • To delete all users from an audience segment, a DELETE request can be made to the audience segment contact list endpoint with the specified audience segment id in the URL path.

Get Segment Statistics

GET /2023-10/marketing-solutions/audience-segments/{audience-segment-id}/contact-list/statistics

  • Get the statistics of the contact list audience segment associated with the given ID. It returns the size and other statistics available for an audience segment of the type contact list. If the given ID is not of the type contact list, an error is returned.

You can find more about the Audience Segment endpoints in this guide.

What's Changed:

Removed Endpoints:

  • GET /audiences
  • POST /audiences
  • DELETE /audiences/{audience-id}
  • PATCH /audiences/{audience-id}
  • DELETE /audiences/{audience-id}/contactlist
  • DELETE /audiences/{audience-id}/contactlist PATCH
  • GET /marketing-solutions/audience-segments/{audience-segment-id}/contact-list

Reason for Removal:

The Legacy Audiences APIs have been deprecated and removed in this version (2023.10) as they were replaced by updated versions in a prior API release. These endpoints are no longer supported and have been phased out to streamline and optimize the API structure.