Changelog

The documentation for the /finance/salereport/all endpoint has been updated to include new query parameters for more granular filtering.

You can now filter sale reports by releaseId, releaseIds, trackId, and trackIds.

Please see the updated Sale Reports documentation for details.

Actions Required

• No actions required

Deadlines

• No deadlines

The documentation for endpoints used to retrieve release information has been significantly updated. This includes adding comprehensive details for previously undocumented query parameters for filtering, sorting, and pagination on the /content/release/all and /content/release/all/summary endpoints.

We’ve also added explanations for system-derived fields like releaseTypeId and additionalCounters.

Please review the updated Retrieving Releases section for full details.

Actions Required

• No actions required

Deadlines

• No deadlines

We are introducing a new, more robust method for selecting specific contributor roles, particularly for composerContentsDTO and contributors, by using the contributorRoleGroupId system.

While the old method of filtering roles by priority will continue to work for now, we strongly recommend that you update your integrations to use the new contributorRoleGroupId system. This new method is more reliable and will be the standard going forward.

The documentation has been updated to reflect this new recommendation. For more details, please see Adding/Editing Releases.

Actions Required

• No actions required

Deadlines

• No deadlines

We’ve enhanced our data models to allow associating multiple contacts with Artists, Composers, and Publishers. This improvement enables more comprehensive contact management and better role-specific communications.

The additionalContacts field has been added to:

• Artist objects
• Composer objects
• Publisher objects

This array field allows you to associate multiple contacts with each entity, each with their own role designation.

Actions Required

• No actions required

Deadlines

• No deadlines

We’re improving how active periods are tracked for Artist object by adding new fields.

• ActiveFromDate (datetime, optional): The specific date when the artist began their activity
• ActiveToDate (datetime, optional): The specific date when the artist ended their activity (or null if still active)

Actions Required

• No actions required

Deadlines

• No deadlines

The Artist object has been significantly enhanced with new fields for more comprehensive data management, including identity details, label associations, and contribution categorizations.

Please refer to the updated Artist documentation for full details:

• Adding/Editing Artists
• Retrieving Artists

Actions Required

• No actions required

Deadlines

• No deadlines

The documentation for the composerContentsDTO.roleId (used when adding composer information to tracks) has been updated to clarify selection criteria. Relevant roles for composers are those with either Priority = 5 OR belonging to contributorRoleGroupId = 4.

See the updated guidance in Adding/Editing Releases.

Actions Required

• No actions required

Deadlines

• No deadlines

The ComposerContentsDTO object returned in API responses now includes a new composerImageId field. This ID is derived from the image associated with the linked composer (composerId) and provides a direct way to access the composer’s image.

Actions Required

• No actions required

Deadlines

• No deadlines

We’ve introduced new dedicated endpoints for creating, retrieving, and managing Composer information directly. This allows for more comprehensive and standalone composer data management.

The Composer object, accessible via these new endpoints, now includes a richer set of fields:

• Identity and affiliation details like isni, ipiCae, countryOfResidenceId, and proAffiliations.
• Derived information such as worksCount (number of associated tracks/releases), publishersCount, contributorRoleIds (based on their contributions), and creationDate.

Full details on the Composer model and these endpoints can be found in the new documentation:

• Adding/Editing Composers
• Retrieving Composers

Actions Required

• No actions required

Deadlines

• No deadlines

This change affects any endpoint that returns or accepts a Contact object in its request or response body.

• contactRoleId (integer, optional): An identifier linking to the specific role of the contact (e.g., Billing Contact, Technical Contact).

Actions Required

• No actions required

Deadlines

• No deadlines

This change affects any endpoint that returns or accepts a Contributor object in its request or response. The Contributor model has been extended with a new field:

• contributorRoleGroupId (integer, optional): An identifier linking to the specific group role of the contributor.

Actions Required

• No actions required

Deadlines

• No deadlines

When a new Composer or Publisher is created implicitly during the process of saving a Release or Track (i.e., by providing new composer/publisher details within the release/track save payload), its enterpriseId will now automatically be set to match the enterpriseId of that Release or Track.

Previously, such implicitly created Composers/Publishers would inherit the enterpriseId of the currently authenticated user’s session. This update ensures more accurate and contextually correct enterprise association for these entities from their point of creation within an asset.

For more details, see the updated notes in the Composer and Publisher documentation sections.

Actions Required

• No actions required

Deadlines

• No deadlines

Endpoint was replaced with /whitelabel/check-email-domain.

Actions Required

• Ensure all usage of this endpoint is removed before the deadline.

Deadlines

• No deadlines

Description now can be changed after release is distributed. Before changes to that field were ignored.

Actions Required

• No actions required

Deadlines

• No deadlines

The /content/artist/all endpoint response now includes additional fields for richer artist information, such as releasesCount, musicStyles, and creationDate. This endpoint and its complete response structure are detailed in the updated documentation.

See Retrieving artists for full information.

Actions Required

• No actions required

Deadlines

• No deadlines

We are introducing two new lookup endpoints to provide easier access to lists of Contributor Role Groups and Contact Roles.

Actions Required

• No actions required

Deadlines

• No deadlines

We’ve added new query parameters to artist endpoints:

• options.isni (string, optional): Filter results by a specific ISNI
• options.contributorGroupId (integer, optional): Filter results by a specific Contributor Group ID

Actions Required

• No actions required

Deadlines

• No deadlines

We’ve improved the permissions object with new properties that provide better control over enterprise access and account type specification. These enhancements will improve the user experience for accounts with access to multiple enterprises.

• isDefault (boolean): This property determines the default enterprise when a user has access to multiple enterprises under the same account type. When true, this enterprise will be selected by default upon login
• accountType (integer): This property specifies the type of account these permissions apply to.

Actions Required

• No actions required

Deadlines

• No deadlines

Endpoints for managing Publishers are now officially documented. The Publisher model has also been enhanced with new fields for richer data.

Please refer to the new documentation sections:

• Adding/Editing Publishers
• Retrieving Publishers

Actions Required

• No actions required

Deadlines

• No deadlines

The ContractTypeId field is being removed from both the request body and the response body of the POST /accounting/contract/save endpoint. This field was identified as unused and is being removed to simplify the contract management process.

Actions Required

• Remove the `ContractTypeId` field from the request body of any integrations using the POST /accounting/contract/save endpoint.
• Update any code that expects the `ContractTypeId` field in the response from this endpoint, as it will no longer be present.

Deadlines

• 2025-07-22

Parent enterprise users can now retrieve analytics data specifically for their child enterprises using the new optional targetEnterpriseId query parameter.

Please refer to the updated Analytics documentation for more details on usage. Comprehensivee Analytics and Keymetrics

Actions Required

• No actions required

Deadlines

• No deadlines

We’ve updated the royaltyToken object structure to better represent digital asset information and streamline the data model.

Added Fields

• assetName (string): The name of the digital asset represented by the token
• assetVersion (string): The version identifier for the digital asset

Removed Fields

• track (object): This nested object has been removed and its relevant data has been moved to the new fields

Actions Required

• If you use data models or schemas for API responses, update them to reflect the removal of 'track' and the addition of 'assetName' and 'assetVersion'.

Deadlines

• No deadlines

Added an optional payoutRate parameter (integer, 1-100, defaults to 100) to the Royalty Token creation process. This field defines the percentage of royalties that will be transferred to the token.

Actions Required

• No actions required

Deadlines

• No deadlines

The documentation section for “Running Requests in Child Accounts” has been updated for clarity. It now includes a list of currently supported endpoints for this feature and notes that we plan to expand this capability in the future.

Please review the updated guidance here: Running Requests in Child Accounts

Actions Required

• No actions required

Deadlines

• No deadlines

New fields include:

• isCrypto (boolean | null): Indicates if the report/statement is to be paid in cryptocurrency to an enterprise Royalty Pool balance (a balance reserved exclusively for payments related to Royalty Tokens).
• isSmartWalletPayee (boolean): Indicates the payee is to be paid directly to their enterprise Smart Wallet 0x address.

Actions Required

• No actions required

Deadlines

• No deadlines

Documentation has been updated for contacts management. Details can be found in the Adding/Editing Contacts section.

Actions Required

• No actions required

Deadlines

• No deadlines

Documentation has been updated for client information retrieval. Details can be found in the Retrieving Client Information section.

Actions Required

• No actions required

Deadlines

• No deadlines

Documentation has been added for audio upload endpoints. Details can be found in the Uploading Files section.

Actions Required

• No actions required

Deadlines

• No deadlines

To enhance data quality and ensure proper crediting, we are introducing a new requirement: at least one contributor from the “Production & Engineering Credits” contributor group (contributorRoleGroupId = 3) is now mandatory for all releases submitted or updated via the affected endpoints.

The contributorRoleGroupId for different contributors types can be checked on /common/lookup/contributorRoles.

Actions Required

• Ensure all new and updated releases include at least one contributor from the 'Production & Engineering Credits' contributor group
• Update your integration to provide this contributor information for relevant releases.
• If you encounter issues fulfilling this requirement, please contact Support.

Deadlines

• 2025-06-25

The WarningCount field is being removed from the responses of the specified content release endpoints. Please update your integrations to no longer expect or utilize this field to avoid any disruptions.

Actions Required

• Identify and remove any dependencies on this field in your integration.

Deadlines

• 2025-06-25

To enhance data integrity and streamline operations, we will implement validation to prevent UPC re-use, ensuring unique identification across releases.

Actions Required

• Make sure that each new UPC wasn't used before
• Handle previously re-used UPCs
• If you cannot handle previously re-used UPCs because the content is locked, please contact Support

Deadlines

• 2025-05-08

As part of an internal revamp of our validation architecture, we will remove these fields since they are no longer relevant. This change enables the creation of newer and more accurate validations while also allowing us to introduce new validations into production more quickly.

• validationErrors.field
• validationErrors.value
• validationErrors.errorCode

Actions Required

• Update your implementation to not rely on these deprecated fields

Deadlines

• 2025-05-04 Removal of deprecated fields

Last June, we introduced support for TikTok’s new Scanning service (TTS)— and it’s officially going live. This feature lets users set Monetize or BlockAccess policies on tracks used in UGC videos.

To comply with TikTok’s scanning policies, the following fields must be included per track:

• Track Origin – Composition Rights
• Track Properties – Recording Rights
• Monetization Policy:
  • Monetize – Allow monetized UGC usage
  • BlockAccess – Prevent UGC use entirely

Tracks without updates after the deadline will be excluded from scanning and monetization

Actions Required

• Update metadata and apply the appropriate policy
• Redeliver affected tracks only to TikTok (No additional distribution fees apply)

Deadlines

• 2025-03-31 Tiktok Deadline for the new Scanning service (TTS)

API documentation Release Notes have been updated and renamed to Changelog.

Actions Required

• No actions required

Deadlines

• No deadlines

Deezer is enforcing new contributor metadata requirements starting Q2 2025. Tracks missing required roles will be removed, along with associated albums.

• Instrumental Tracks must include:
  • Composer (RoleId: 2)
• Non-Instrumental Tracks must include either:
  • Composer (RoleId: 2) + Lyricist (RoleId: 4)
  • or Composer Lyricist (RoleId: 65)

Actions Required

• Update your metadata to match the new requirements.

Deadlines

• 2025-04-14 Global compliance deadline
• 2025-05-31 Brazil (BR country code) compliance deadline

A profileId of 0, null, or an absent entry in the artistExternalIds array will now be treated the same. The specific behavior of this empty state will differ depending on the store.

Any endpoints responding with an Artist Object will have its artistExternalIds array contain only existing external IDs. Values that were previously had "profileId": 0 will no longer appear in the array.

Actions Required

• Update your implementation relying on the returned Artist Object

Deadlines

• 2025-03-11

Added support for additional DSPs when it comes to providing Artist External IDs.

• Soundcloud (68)
• Meta (309)

Actions Required

• No actions required

Deadlines

• No deadlines

We no longer support testing on the staging environment. All of the examples and documentation were updated to reflect this change.

Please contact us to create a dedicated Sandbox account.

Actions Required

• Adjust your testing to use the sandbox account on the production environment

Deadlines

• 2025-02-05

We are removing support for redirecting to, and generally using, the outdated V1 Web Interface.

Actions Required

• Remove any references to the V1 Web Interface

Deadlines

• 2025-02-05

From this point forward the only supported url will be api.revelator.com

This is currently not a breaking change, but we recommend updating your code to use the primary url, as others might become deprecated in the future.

Actions Required

• Change the main URL across your implementation to api.revelator.com

Deadlines

• 2025-02-05

Added support for Engagement Analytics to the V3 Analytics. 📊

• Access by using the new engagement metric
• Track listener behavior with skip rates, completion rates, saves, and short-stream metrics
• Compatible with all existing filters and aggregation dimensions in the
• Part of our continuing effort to provide deeper streaming insights

Actions Required

• No actions required

Deadlines

• No deadlines

Dolby atmos is officially supported and ready to be distributed.

To supported this change, the Track Object has been updated. Explore the new changes directly on the Track Object and refer to the New track recording model section for more information.

Make sure you understand the limitations and cost associated with Dolby Atmos recordings before creating tracks. Read our Dolby Atmos Guide for more information.

Actions Required

• Review the new track recording model
• Read our Dolby Atmos Guide

Deadlines

• No deadlines

As part of our security hygiene and access protocol work, we’ve moved to a more secure token protocol and updated the related documentation accordingly.

The access token can only be provided in the Authorization header, and must be prefixed with the word “Bearer”. (Bearer token)

Actions Required

• Update your implementation to only authenticate using the Bearer token

Deadlines

• 2024-08-05

Added this previously undocumented field to the Artist Object.

Actions Required

• No actions required

Deadlines

• No deadlines

Newly documented Takedowns section.

Actions Required

• No actions required

Deadlines

• No deadlines

Added the Common Resources section in order to provide easy-access and overview of this type of data.

Actions Required

• No actions required

Deadlines

• No deadlines

New Monetization Policy changes introduced to reflect TikTok’s Monetization Changes

• Added monetization policies for TikTok. (NoTikTokScanning, Monetize, BlockAccess)
• A new field trackMonetizationPolicyIds available during Setting Distribution Options for track-level policies.

Actions Required

• Review the monetization policy section

Deadlines

• No deadlines

New fields/changes introduced to reflect TikTok’s Monetization Changes

• trackProperties is a new and required field on the Track Object.
• trackType is now a required field on the Track Object. This field also accepts a new value: 2 - Cover song

Actions Required

• Update your implementation of the affected endpoints

Deadlines

• 2024-07-15 Implementation deadline

Attemnts to distribute to stores containing the isActive == false will now fail.

Actions Required

• Make sure you are not trying to deliver to any inactive stores

Deadlines

• 2024-05-22

Added the (Beta) API support for user invites.

Actions Required

• No actions required

Deadlines

• No deadlines

Composer/Writer details on tracks missing either a valid first and last artist name are no longer allowed for distribution.

Actions Required

• Make sure you are providing the first and last name for all Composers/Writers

Deadlines

• 2024-05-15

Tracks that are less than 2 seconds long are no longer allowed for distribution. Any attempt at distributing or uploading these tracks will fail.

Actions Required

• Make sure you arenot trying to distribute short tracks

Deadlines

• 2024-05-15

Added a Glossary page containing most used terms.

Actions Required

• No actions required

Deadlines

• No deadlines

Royalty tokens are now supported and documented.

Actions Required

• No actions required

Deadlines

• No deadlines

Distribution statuses updated.

• New statuses for takedowns (72, 75, 76, 79)
• Old statuses updated (8, 10, 11)

Actions Required

• If you implementation is rellying on any of the changed statuses, make sure you update it accordingly.

Deadlines

• 2024-03-20

The endpoint examples are now back after the documentation migration.

Actions Required

• No actions required

Deadlines

• No deadlines

Tipalti integration added to Revelator. By completing the following flows you will be able to pay your payees using this feature:

• Payor Flow - Connect your Tipalti Account with your Revelator Parent Account
• Payee Flow - Set up a payee to receive money via Tipalty

Actions Required

• No actions required

Deadlines

• No deadlines

• New look and feel
• New URL api-docs.revelator.com
• Ability to search through the documentation (CTRL + K)

Actions Required

• Start using the new API documentation on a new URL

Deadlines

• No deadlines

Using an externalUrl to associate files with a track/release is no longer recommended! Files referenced like this are not being downloaded by our system until distribution, leading to unexpected behavior. Use the endpoints mentioned above for all file uploading needs.

Actions Required

• Update your implementation to no longer utilize externalUrl for track/release audio files
• Use the new endpoints for uploading files instead

Deadlines

• 2023-11-11

Newly documented endpoints for uploading files

• POST /media/audio/upload/wav - Upload a file in wav format to the Revelator servers
• POST /media/image/upload - Upload an image file to the Revelator servers
• POST /media/audio/pullexternal/wav - Pull a file in wav format from an external url to the Revalator servers

Actions Required

• No actions required

Deadlines

• No deadlines

POST /account/createnewaccount' - endpoint is now deprecated. This is done to mitigate confusion for creating new accounts.

Actions Required

• Use the documented ways of creating accounts instead

Deadlines

• 2023-09-26

Enterprise information endpoints:

• GET /enterprise/clients/{id} - Retrieves basic information about a single enterprise
• GET /enterprise/clients/all - Retrieves basic information about all enterprises associated with the account

Actions Required

• No actions required

Deadlines

• No deadlines