Admin API changelog

This changelog outlines the latest API updates and resolved issues to the Zephr Admin API, and documentation updates to the Zephr Admin API Reference. We would love to hear your feedback on how we can improve it. If you have any comments on the Changelog for the Zephr Admin API, please use the "Feedback" button on the right of this page or send an e-mail to docs@zuora.com.

July 31, 2023

API updates

This section lists operations and fields that were added, changed, or removed.

• Dynamic Offer Promo-codes Redemptions - Added the "Process promo code redemptions" operation. This operation is used to redeem promo codes configured from the Zephr console.

February 26, 2024

Doc updates

This section lists the documentation updates that were made in this version of the Zephr Admin API Reference.

• Updated the sample request code for the "Update users in bulk" operation.

February 15, 2024

Doc updates

This section lists the documentation updates that were made in this version of the Zephr Admin API Reference.

February 9, 2024

Doc updates

This section lists the documentation updates that were made in this version of the Zephr Admin API Reference.

• Promo Code Redemption -

December 14, 2023

Doc updates

This section lists the documentation updates that were made in this version of the Zephr Admin API Reference.

• Made the following corrections to the “Start a password reset” operation:
  • Corrected the path of the operation.
  • Added the missing siteSlug field in the request body.
• Added the "Evicts cached origin requests (V4)" operation.

December 6, 2023

Doc updates

This section lists the documentation updates that were made in this version of the Zephr Admin API Reference.

• Revised the operation names and descriptions to improve consistency and avoid confusion.
• For the "List account users" operation, added the missing account_id path parameter.

November 13, 2023

Doc updates

This section lists the documentation updates that were made in this version of the Zephr Admin API Reference.

• Made the following corrections to the “User and User Events Export” operation:
  • Updated the description of this operation to clarify how to specify the parameters.
  • Added the following missing query parameters:
    • appIdsRestrictive
    • registeredSince
    • registeredBefore
  • Updated the description of the since query parameter.
  • Removed the “required” label from the following parameters:
    • attributes
    • appIds
    • eventsExport

November 9, 2023

Doc updates

This section lists the documentation updates that were made in this version of the Zephr Admin API Reference.

• Moved the "Upsert foreign key" operation from the Admin User section to the Users section to correct the grouping error.

November 2, 2023

Doc updates

This section lists the documentation updates that were made in this version of the Zephr Admin API Reference.

• For the "Create new session under a given site" operation, corrected the 200 response code to 201 .

September 21, 2023

API updates

This section lists operations and fields that were added, changed, or removed.

• Users - Added the following operations to support bulk updating users:
  • Update users in bulk
  • Retrieve a bulk user update job
  • List all bulk user update jobs

August 28, 2023

API updates

This section lists operations and fields that were added, changed, or removed.

• User Export - Updated the "User and User Events Export" operation to support downloading user event data.
• Users - Added the following operations to support user segmentation:
  • Create a user segment
  • List all user segments
  • Retrieve a user segment
  • Delete a user segment
  • List all user segments for a user

August 24, 2023

API updates

This section lists operations and fields that were added, changed, or removed.

• User Export - Updated the "User and User Events Export" operation to support downloading user event data.
• Users - Added the following operations to support user segmentation:
  • Create a user segment
  • List all user segments
  • Retrieve a user Segment
  • Delete a user segment
  • List all user segments for a user

Doc updates

This section lists the documentation updates that were made in this version of the Zephr Admin API Reference.