Release notes

All changes to the Revelator API are tracked and documented here.

September 12th 2024

What’s new:

Added support for Dolby Atmos 🎉
- Make sure you understand the limitations and cost associated with Dolby Atmos recordings before creating tracks. Read our Dolby Atmos Guide for more information.
Added the Consumption data endpoint as part of our new V3 Analytics initiative 📈
- More precise aggregation and filtering
- Better performance
- Data going back 12 months
- Standardized endpoints

What changed:

With the Dolby Atmos launch, 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.
- There are no breaking changes, the affected endpoints will remain backwards compatible.

August 5th 2024

What’s new:

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.

July 30th 2024

What’s new:

Newly documented Takedowns section.
Newly documented image field for Adding/Editing Artists.

July 10th 2024

What’s new:

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

June 24th 2024

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

What’s new:

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

What changed:

Monetization policies are now explained in depth in their own section

June 20th 2024

Implementation deadline - July 15th

Failure to implement these changes by the deadline specified will cause your pretrack creation and distribution workflow to fail

Both new and existing tracks must contain the new fields (with a non-0 value) before they can be distributed
/distribution/release/{releaseId}/validate and /distribution/release/addtoqueue will error if trackType or trackProperties are 0 (previously null)

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

Update the implementation of Adding/Editing Releases endpoints.

What’s new:

trackProperties is a new and required field on the Track Object.

What changed:

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

May 22nd 2024

What changed:

POST /distribution/release/addtoqueue will now fail if it contains stores with isActive == false

May 15th 2024

What’s new:

Added the (Beta) API support for user invites.

What changed:

Tracks that are less than 2 seconds long are no longer allowed for distribution.
- For new files all media/audio/... endpoints are updated to reflect this change.
- For old files /distribution/release/{releaseid}/validate was updated to reflect this change.
Composer/Writer details on tracks missing either a valid first and last artist name are no longer allowed for distribution.
- Endpoint /distribution/release/{releaseid}/validate was updated to reflect this change.

April 12th 2024

What’s new:

Added a Glossary page containing most used terms.

April 1st 2024

What’s new:

Royalty Tokens section added.
- Minting a royalty token
- Retrieving royalty token(s)

March 20th 2024

What changed:

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

March 13th 2024

What’s new:

Added the examples back.

January 29th 2024

What’s new:

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

January 24th 2024

What’s new:

New API Documentation published 🥳

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

November 11th 2023

What’s new:

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

Deprecated:

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.

September 26th 2023

What’s new:

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

Deprecated:

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