Whitelist Channel

/api/contentid/whitelistChannel

The whitelistChannel resource allows you to add channels to your whitelist.

Example channel request object

{ "channel": [
	{
        "channel_id": "UC_B7kPmEgq9QbgkwNKjG1Cg",
        "release_claims": "0",
        "note": "via purchase, pending."
    },{
        "channel_id": "UC_B7kPmEgq9QbgkwNKjG1Ce",
        "release_claims": "1",
        "note": "marketing"
    },{
        "channel_id": "UC_B7kPmEgq9QbgkwNKjG1Cf",
        "release_claims": "1",
        "note": "commercial purchase"
    }
]}

The channel request object.

Attributes	Type	Required	Description
channel_id	string	yes	The YouTube channel ID that uniquely identifies the whitelisted channel.
release_claims	int	no	[0 ∣ 1 default 1] Existing claims against the channel will be automatically released. To disable the automatic release of existing channel claims against pass this property with a value of 0.
note	string	no	Additional details to include with this action.

Example channel response object

{"channel": [
    {
      "added": 1,
      "white_id": 436,
      "date": 1572370930,
      "channel_id": "UC_B7kPmEgq9QbgkwNKjG1Cg",
      "channel_name": "Brent",
      "data": {
        "manual": 1,
        "note": "via purchase."
      }
    },{
      "added": 1,
      "white_id": 436,
      "date": 1572370930,
      "channel_id": "UC_B7kPmEgq9QbgkwNKjG1Ce",
      "channel_name": "Vloggy McVlogger",
      "data": {
        "manual": 1,
        "note": "marketing."
      },
      "claims": [{
          "claim_id": "IId2ivhLbSc",
          "released": 1,
          "updated": 1
        }]
    },{
      "added": 1,
      "white_id": 436,
      "date": 1572370930,
      "channel_id": "UC_B7kPmEgq9QbgkwNKjG1Cf",
      "channel_name": "Bluth/'s Frozen Bananas",
      "data": {
        "manual": 1,
        "note": "commercial purchase."
      }
    }
]}

The channel response object.

Attributes	Type	Included	Description
added	int	yes	[0 ∣ 1 fail, success ] Indicates if the channel was added to the whitelist.
white_id	string	OnSuccess	Your sourceAudio Site ID.
date	string	OnSuccess	The date the channel was added to the whitelist.
channel_id	string	yes	The YouTube channel ID that uniquely identifies the whitelisted channel.
channel_name	string	onSuccess	The name of the whitelisted YouTube channel.
data	object	onSuccess	Information about the whitelisted channel.
data.manual	int	onSuccess	[0 ∣ 1 false, true ] Indicates if the channel was manually added to the whitelist. note: channels added via the api are considered a manual addition to the whitelist.
data.note	string	onSuccess	optional note included when the channel was whitelisted.
error	object	onError	An error object including details about the error if the request to whitelist the channel was unsucessful.
claims	array	OnSuccess	(excluded if release_claims = 0) an array to hold the result of the request to release the channel’s existing claims.
claims[i].claim_id	string	OnSuccess	(included if the channel has existing claims) A unique ID identifying the YouTube claim
claims[i].released	int	OnSuccess	[0 ∣ 1 fail, success ] (included if the channel has existing claims) Indicates if the claim was released.
claims[i].updated	int	OnSuccess	[0 ∣ 1 fail, success ] (included if the channel has existing claims) Indicates if the claim was updated.
claims.[i].error	object	onError	(if the claim could not be released) An error object including details about claim release error.