Developer Help Center

Setting Distribution Options

Use the /content/release/retail/save resource to set distribution options for a release, such as specifying a date the release should go live.

POST /content/release/retail/save

Table 1. Query String Parameters

Parameter

Description

token

Optional*

Access token returned upon authentication.

*Providing a token is mandatory, but alternatively, it can be provided as a header. See Authentication and Headers.



Table 2. Request Body Parameters

Parameter

Type

Description

releaseId

Mandatory

integer

The ID of the release to set distribution options for. This ID was returned in the /content/release/save request which created the release.

saleStartDate

Optional

string

The date the release should go live, in the format "mm/dd/yyyy".

  • When omitted, the release will be live as soon as possible.

  • When provided without saleStartTime and saleStartTimezone, the release will be live on the saleStartDate at midnight in every time zone.

saleStartTime

Optional

string

The time the release should go live, in the format "hh:mm".

  • When provided, saleStartDate is mandatory.

  • When provided without saleStartTimezone, the release will go live on the saleStartDate at the saleStartTime in every time zone.

  • When provided with saleStartTimzone, specifies the absolute time that the release should go live. For example, specifying the release should go live at 2pm in Los Angeles will cause it to go live at 5pm in New York.

saleStartTimezone

Optional

integer

The time zone offset for the saleStartTime. The release will go live at the same instant everywhere.

  • When provided, saleStartTime is mandatory.

  • Along with saleStartTime , specifies the absolute time that the release should go live.

To lookup time zone offsets, use the GET /common/lookup/timezones resource.

monetizationPolicyIds

Mandatory

array of integers

Revelator monetization policy ID(s) for YouTube Content ID and/or Facebook Rights Manager. The array should include no more than one monetization ID for YouTube Content ID and one for Facebook Rights Manager.

  • Parameter is mandatory even if the array is empty.

  • In addition to setting the monetization policy for a store, you must include the store (YouTube Content ID and/or Facebook Rights Manager) in the addtoqueue request. See Adding Releases to the Distribution Queue.

  • Monetization Policy IDs are unique to each account. Your Revelator account manager will provide your monetization IDs when monetization is enabled for your account.

    • It is possible that you may need to apply a different monetization policy for a single track, for example, in a case where a track is a public domain song. In this case, please open a support ticket with the track ISRC.

    • The table below displays some policy possibilities, but other options, such as the ability to apply a different policy to different territories differently, are possible. Please discuss your needs with your account manager.

    Table 3. Example Monetization Policy Descriptions

    Policy Name

    Relevant Store

    Description

    Monetize in all countries

    YT CID

    Receive royalties when tracks are used/played.

    Track in all countries

    YT CID

    Receive analytics for when tracks are used/played.

    Claim Ad earnings

    FRM

    Receive royalties when tracks are used/played.

    Block

    FRM

    Prevent tracks from being used/played.

    Monitor

    FRM

    Receive analytics for when tracks are used/played.





curl -X POST 'http://staging-api.revelator.com/content/release/retail/save'\ 
--header 'Content-Type: application/json'\  
--header 'Accept: application/json'\  
-d '{ "releaseId": 123456, 
      "saleStartDate": "12/11/2020",  
      "saleStartTime": "05:00",
      "saleStartTimezone": 2,  
      "monetizationPolicyIds": [ 333,332] 
 }'