Rights

Endpointhttps://api.idol.io/api/v2

Distribution rights management. Configure which territories and DSPs can distribute your content. Actions include "add", "remove", or "clear" rights.

List distribution rights

GET

https://api.idol.io/api/v2

/rights

Retrieve distribution rights configurations

List distribution rights › query Parameters

page[number]

integer · min: 1

Page number for pagination

Default: 1

page[size]

integer · min: 1 · max: 200

Number of items per page (max 200)

Default: 20

List distribution rights › Responses

Successful response

object[]

Array of resource objects (override with specific resource schema)

object[]

Related resources included in the response

object

Create distribution rights

POST

https://api.idol.io/api/v2

/rights

Configure distribution rights for territories and DSPs.

Actions: add, remove, clear

Create distribution rights › Request Body

object · required

Create distribution rights › Responses

Rights created successfully

object

object[]

Related resources included in the response

object

POST/rights

curl --request POST \
  --url https://api.idol.io/api/v2/rights \
  --header 'Content-Type: application/vnd.api+json' \
  --data '
{
  "data": {
    "type": "rights",
    "id": "id",
    "attributes": {
      "action": "add",
      "comments": "comments",
      "created-by": "test@example.com",
      "created-at": "2024-08-25T15:00:00Z",
      "updated-at": "2024-08-25T15:00:00Z"
    },
    "relationships": {
      "distributor": {
        "data": {
          "type": "type",
          "id": "id"
        },
        "links": {
          "self": "https://www.example.com/path/to/resource",
          "related": "https://www.example.com/path/to/resource"
        }
      },
      "distributed": {
        "data": {
          "type": "type",
          "id": "id"
        },
        "links": {
          "self": "https://www.example.com/path/to/resource",
          "related": "https://www.example.com/path/to/resource"
        }
      },
      "dsps": {
        "data": [
          {
            "type": "type",
            "id": "id"
          }
        ],
        "links": {
          "self": "https://www.example.com/path/to/resource",
          "related": "https://www.example.com/path/to/resource"
        },
        "meta": {}
      },
      "territories": {
        "data": [
          {
            "type": "type",
            "id": "id"
          }
        ],
        "links": {
          "self": "https://www.example.com/path/to/resource",
          "related": "https://www.example.com/path/to/resource"
        },
        "meta": {}
      }
    },
    "links": {
      "self": "https://www.example.com/path/to/resource"
    }
  }
}
'

shell

Example Request Body

{
  "data": {
    "type": "rights",
    "id": "id",
    "attributes": {
      "action": "add",
      "comments": "comments",
      "created-by": "test@example.com",
      "created-at": "2024-08-25T15:00:00Z",
      "updated-at": "2024-08-25T15:00:00Z"
    },
    "relationships": {
      "distributor": {
        "data": {
          "type": "type",
          "id": "id"
        },
        "links": {
          "self": "https://www.example.com/path/to/resource",
          "related": "https://www.example.com/path/to/resource"
        }
      },
      "distributed": {
        "data": {
          "type": "type",
          "id": "id"
        },
        "links": {
          "self": "https://www.example.com/path/to/resource",
          "related": "https://www.example.com/path/to/resource"
        }
      },
      "dsps": {
        "data": [
          {
            "type": "type",
            "id": "id"
          }
        ],
        "links": {
          "self": "https://www.example.com/path/to/resource",
          "related": "https://www.example.com/path/to/resource"
        },
        "meta": {}
      },
      "territories": {
        "data": [
          {
            "type": "type",
            "id": "id"
          }
        ],
        "links": {
          "self": "https://www.example.com/path/to/resource",
          "related": "https://www.example.com/path/to/resource"
        },
        "meta": {}
      }
    },
    "links": {
      "self": "https://www.example.com/path/to/resource"
    }
  }
}

json

Example Responses

No example specified for this content type

application/vnd.api+json

Track Offers Availabilities

Labelcamp API v2

Rights

Endpointhttps://api.idol.io/api/v2

Distribution rights management. Configure which territories and DSPs can distribute your content. Actions include "add", "remove", or "clear" rights.

List distribution rights

GET

https://api.idol.io/api/v2

/rights

Retrieve distribution rights configurations

List distribution rights › query Parameters

page[number]

integer · min: 1

Page number for pagination

Default: 1

page[size]

integer · min: 1 · max: 200

Number of items per page (max 200)

Default: 20

List distribution rights › Responses

Successful response

object[]

Array of resource objects (override with specific resource schema)

object[]

Related resources included in the response

object

Create distribution rights

POST

https://api.idol.io/api/v2

/rights

Configure distribution rights for territories and DSPs.

Actions: add, remove, clear

Create distribution rights › Request Body

object · required

Create distribution rights › Responses

Rights created successfully

object

object[]

Related resources included in the response

object

POST/rights

curl --request POST \
  --url https://api.idol.io/api/v2/rights \
  --header 'Content-Type: application/vnd.api+json' \
  --data '
{
  "data": {
    "type": "rights",
    "id": "id",
    "attributes": {
      "action": "add",
      "comments": "comments",
      "created-by": "test@example.com",
      "created-at": "2024-08-25T15:00:00Z",
      "updated-at": "2024-08-25T15:00:00Z"
    },
    "relationships": {
      "distributor": {
        "data": {
          "type": "type",
          "id": "id"
        },
        "links": {
          "self": "https://www.example.com/path/to/resource",
          "related": "https://www.example.com/path/to/resource"
        }
      },
      "distributed": {
        "data": {
          "type": "type",
          "id": "id"
        },
        "links": {
          "self": "https://www.example.com/path/to/resource",
          "related": "https://www.example.com/path/to/resource"
        }
      },
      "dsps": {
        "data": [
          {
            "type": "type",
            "id": "id"
          }
        ],
        "links": {
          "self": "https://www.example.com/path/to/resource",
          "related": "https://www.example.com/path/to/resource"
        },
        "meta": {}
      },
      "territories": {
        "data": [
          {
            "type": "type",
            "id": "id"
          }
        ],
        "links": {
          "self": "https://www.example.com/path/to/resource",
          "related": "https://www.example.com/path/to/resource"
        },
        "meta": {}
      }
    },
    "links": {
      "self": "https://www.example.com/path/to/resource"
    }
  }
}
'

shell

Example Request Body

{
  "data": {
    "type": "rights",
    "id": "id",
    "attributes": {
      "action": "add",
      "comments": "comments",
      "created-by": "test@example.com",
      "created-at": "2024-08-25T15:00:00Z",
      "updated-at": "2024-08-25T15:00:00Z"
    },
    "relationships": {
      "distributor": {
        "data": {
          "type": "type",
          "id": "id"
        },
        "links": {
          "self": "https://www.example.com/path/to/resource",
          "related": "https://www.example.com/path/to/resource"
        }
      },
      "distributed": {
        "data": {
          "type": "type",
          "id": "id"
        },
        "links": {
          "self": "https://www.example.com/path/to/resource",
          "related": "https://www.example.com/path/to/resource"
        }
      },
      "dsps": {
        "data": [
          {
            "type": "type",
            "id": "id"
          }
        ],
        "links": {
          "self": "https://www.example.com/path/to/resource",
          "related": "https://www.example.com/path/to/resource"
        },
        "meta": {}
      },
      "territories": {
        "data": [
          {
            "type": "type",
            "id": "id"
          }
        ],
        "links": {
          "self": "https://www.example.com/path/to/resource",
          "related": "https://www.example.com/path/to/resource"
        },
        "meta": {}
      }
    },
    "links": {
      "self": "https://www.example.com/path/to/resource"
    }
  }
}

json

Example Responses

No example specified for this content type

application/vnd.api+json

Track Offers Availabilities