work.post

Use this API to submit new or updated publishing data. This API is designed for publishers to post copyright information associated to a musical work (intellectual property). The API supports the transmission of detailed information, including their ownership shares along with collection shares on a per-territory basis, and other essential metadata such as ISRC codes, performer names, and alternate titles, which are crucial for accurate work matching across various sources that partecipate in the royalties collection and our music catalog. If you are a label and you’d like to send us lyrics in bulk, please refer to our commercial department. Please note that you are responsible for transmitting only trustworthy and verified data.

Authorizations

apikey

string

query

required

Body

application/json

The data schema for submitting data of a musical work.

data

object

Show child attributes

data.identifier

string

required

Your Musical Work’s unique identifier. Submitting updated data with the same 'identifier' creates a new version of the same Work.

Required string length: 1 - 40

data.title

string

required

The Work's title.

Minimum string length: 1

data.alternate_titles

string[]

A list of known alternate titles

data.iswc

string | null

The ISWC of the Work being submitted (example: T3452468001 or T-123456789-1).

data.isrc

string[]

A list of ISRCs that are known to be linked to the Work (example: AA6Q72000047 or AA-6Q7-20-00047).

data.performers

object[]

A list of known Performers.

Show child attributes

data.performers.name

string

required

The name of a performer.

data.performers.identifier

string | null

The performers's unique identifier on your side.

data.owners

object

The right holders, split into Songwriters and Publishers.

Show child attributes

data.owners.publisher

object[]

required

The publisher schema

Show child attributes

data.owners.publisher.name

string

required

The Publisher's name.

Minimum string length: 1

data.owners.publisher.controlled

enum<string>

required

The Publisher's controlled status, either 'Y' or 'N'

Available options:

Y,

N,

y,

n

data.owners.publisher.identifier

string | null

The Publisher's unique identifier on your side

data.owners.publisher.ipi

string | null

The Publisher's IPI. IPI consists of max 11 digits.

data.owners.publisher.role

enum<string> | null

The Publisher's role (either "E", "SE" or "AM" for Original Publisher, Sub-Publisher or Administrator, respectively).

Available options:

AQ,

AM,

PA,

E,

ES,

SE,

aq,

am,

pa,

e,

es,

se,

The share of Mechanical rights owned by this Publisher. Shares are defined as 5 digits (i.e. 00000 no share, 10000 full share, 05000 half share).

Required range: 0 <= x <= 10006

The share of Performing rights owned by this Publisher. Shares are defined as 5 digits (i.e. 00000 no share, 10000 full share, 05000 half share).

Required range: 0 <= x <= 10006

The share of Synchronization rights owned by this Publisher. Shares are defined as 5 digits (i.e. 00000 no share, 10000 full share, 05000 half share).

Required range: 0 <= x <= 10006

data.owners.writer

object[]

required

The writer schema

Show child attributes

data.owners.writer.name

string

required

The Writer's name.

Minimum string length: 1

data.owners.writer.controlled

enum<string>

required

The Writer's controlled status, either 'Y' or 'N'

Available options:

Y,

N,

y,

n

data.owners.writer.identifier

string | null

The Writer's unique identifier on your side.

data.owners.writer.ipi

string | null

The Writer's IPI. IPI consists of max 11 digits.

data.owners.writer.role

enum<string> | null

The Writer's role (e.g. 'CA' for Composer-Author, 'C' for Composer, 'A' for Author, etc.)

Available options:

AD,

AR,

A,

C,

CA,

SR,

SA,

TR,

PA,

EL,

ad,

ar,

a,

c,

ca,

sr,

sa,

tr,

pa,

el,

The share of Mechanical rights owned by this Writer. Shares are defined as 5 digits (i.e. 00000 no share, 10000 full share, 05000 half share).

Required range: 0 <= x <= 10006

The share of Performing rights owned by this Writer. Shares are defined as 5 digits (i.e. 00000 no share, 10000 full share, 05000 half share).

Required range: 0 <= x <= 10006

The share of Synchronization rights owned by this Writer. Shares are defined as 5 digits (i.e. 00000 no share, 10000 full share, 05000 half share).

Required range: 0 <= x <= 10006

data.collection

object

Details on collected royalties, on a per-territory basis

Show child attributes

data.collection.territories

object[]

required

A list of territories where royalties are collected.

Option 1
Option 2
Option 3

Show child attributes

data.collection.territories.code

string

required

One of the territory codes where you collect. For Worldwide use "XW", otherwise use 2-digit ISO 3166-1 alpha-2 codes (https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2), a two-letter country codes standard published by the International Organization for Standardization (ISO).

The share of Mechanical royalties collected in this territory. For example, 100% becomes 10000, 50% becomes 5000, 12.50% becomes 1250, 33.3333% becomes 3333 and so on. At least one of the shares properties (sync_share or perf_share or mech_share) is required.

Required range: 0 <= x <= 10006

The share of Performing royalties collected in this territory. For example, 100% becomes 10000, 50% becomes 5000, 12.50% becomes 1250, 33.3333% becomes 3333 and so on.

Required range: 0 <= x <= 10006

The share of Synchronization royalties collected in this territory. For example, 100% becomes 10000, 50% becomes 5000, 12.50% becomes 1250, 33.3333% becomes 3333 and so on.

Required range: 0 <= x <= 10006

data.collection.validity_begin

string | null

Beginning of deal, in the YYYY-MM-DD format. If omitted, the date of submission will be used instead.

data.collection.validity_end

string | null

End of deal, in the YYYY-MM-DD format.

data.lyrics

object

[Optional] Provide the lyrics for this Work along with its ownership details.

Show child attributes

data.lyrics.lyrics

string

required

The lyrics for this Work, verses separated by line feed. Remember to encode strings properly as the JSON format is used.

Minimum string length: 1

data.lyrics.duration

integer

The duration in seconds of the original recording.

data.lyrics.lrc

string

Lyrics in LRC format (https://en.wikipedia.org/wiki/LRC_(file_format)). Make sure the last row has the time indication and an empty lyrics line. This time will correspond to the timing of the end of the last lyrics line, example: '[04:10.010] \n'

Response

200 - application/json

200 OK / 400 Bad Request / 401 Unauthorized

message

object

Show child attributes

message.body

Show child attributes

message.body.alternate_titles

object[]

Show child attributes

message.body.alternate_titles.title

string

Example:

"Yellow Submarine"

Example:

[{ "title": "Yellow Submarine" }]

message.body.collections

object

Show child attributes

message.body.collections.2023-07-17

object

Show child attributes

message.body.collections.2023-07-17.territories

object[]

Show child attributes

message.body.collections.2023-07-17.territories.code

string

Example:

"IT"

message.body.collections.2023-07-17.territories.countries

string[]

Example:

["IT"]

Example:

10000

Example:

0

message.body.collections.2023-07-17.territories.publisher

unknown

Example:

10000

Example:

[
  {
    "code": "IT",
    "countries": ["IT"],
    "mech_share": 10000,
    "perf_share": 0,
    "publisher": null,
    "sync_share": 10000
  }
]

message.body.collections.2023-07-17.validity_begin

string

Example:

"2023-07-17"

message.body.collections.2023-07-17.validity_end

unknown

message.body.identifier

string

Example:

"00001100196005"

message.body.is_disabled

number

Example:

0

message.body.isrc

any[]

Example:

[]

message.body.iswc

string

Example:

""

message.body.last_trasmission

string

Example:

"2023-07-17"

message.body.owners

object

Show child attributes

message.body.owners.publisher

object[]

Show child attributes

message.body.owners.publisher.controlled

string

Example:

"Y"

message.body.owners.publisher.id

number

Example:

211

message.body.owners.publisher.identifier

string

Example:

""

message.body.owners.publisher.ipi

string

Example:

"00000000000"

Example:

0

message.body.owners.publisher.mech_society

unknown

message.body.owners.publisher.name

string

Example:

"Sony/Atv Tunes Llc"

Example:

0

message.body.owners.publisher.perf_society

unknown

message.body.owners.publisher.role

unknown

Example:

0

message.body.owners.publisher.sync_society

unknown

message.body.owners.publisher.type

string

Example:

"publisher"

message.body.owners.publisher.validity_begin

string

Example:

"2023-07-17"

Example:

[
  {
    "controlled": "Y",
    "id": 211,
    "identifier": "",
    "ipi": "00000000000",
    "mech_ownership_share": 0,
    "mech_society": null,
    "name": "Sony/Atv Tunes Llc",
    "perf_ownership_share": 0,
    "perf_society": null,
    "role": null,
    "sync_ownership_share": 0,
    "sync_society": null,
    "type": "publisher",
    "validity_begin": "2023-07-17"
  }
]

message.body.owners.writer

object[]

Show child attributes

message.body.owners.writer.controlled

string

Example:

"Y"

message.body.owners.writer.id

number

Example:

11353

message.body.owners.writer.identifier

string

Example:

""

message.body.owners.writer.ipi

string

Example:

"00000000000"

Example:

5000

message.body.owners.writer.mech_society

unknown

message.body.owners.writer.name

string

Example:

"John Lennon"

Example:

0

message.body.owners.writer.perf_society

unknown

message.body.owners.writer.role

string

Example:

"CA"

Example:

5000

message.body.owners.writer.sync_society

unknown

message.body.owners.writer.type

string

Example:

"writer"

message.body.owners.writer.validity_begin

unknown

Example:

[
  {
    "controlled": "Y",
    "id": 11353,
    "identifier": "",
    "ipi": "00000000000",
    "mech_ownership_share": 5000,
    "mech_society": null,
    "name": "John Lennon",
    "perf_ownership_share": 0,
    "perf_society": null,
    "role": "CA",
    "sync_ownership_share": 5000,
    "sync_society": null,
    "type": "writer",
    "validity_begin": null
  },
  {
    "controlled": "Y",
    "id": 11354,
    "identifier": "",
    "ipi": "00000000000",
    "mech_ownership_share": 5000,
    "mech_society": null,
    "name": "Paul McCartney",
    "perf_ownership_share": 0,
    "perf_society": null,
    "role": "CA",
    "sync_ownership_share": 5000,
    "sync_society": null,
    "type": "writer",
    "validity_begin": null
  }
]

message.body.ownership

any[]

Example:

[]

message.body.performers

any[]

Example:

[]

message.body.publisher_short_name

string

Example:

"Sony"

message.body.source

object

Show child attributes

message.body.source.affiliation

unknown

message.body.source.control

boolean

Example:

false

message.body.source.created

string

Example:

"2011-12-09"

message.body.source.credits_priority

string

Example:

"15"

message.body.source.description

string

Example:

"SonyATV / EMI"

message.body.source.id

number

Example:

1

message.body.source.last_updated

string

Example:

"2024-10-22 16:47:38"

message.body.source.report

string

Example:

"create"

message.body.source.sender_id

string

Example:

"00269021863"

message.body.source.sender_name

string

Example:

"SONY/ATV MUSIC PUBLISHING LLC"

message.body.source.short_name

string

Example:

"Sony"

message.body.source.type_of_right

string

Example:

"SYN"

message.body.source.validity_begin

string

Example:

"2010-11-04"

message.body.source.validity_end

unknown

message.body.submissions

object[]

Show child attributes

message.body.submissions.creation_date

string

Example:

"2023-07-17"

message.body.submissions.disabled

string

Example:

"N"

message.body.submissions.filename

string

Example:

"api-works-2023-07-17.json"

message.body.submissions.id

number

Example:

3401968

message.body.submissions.source

number

Example:

1

message.body.submissions.transmission_date

string

Example:

"2023-07-17"

Example:

[
  {
    "creation_date": "2023-07-17",
    "disabled": "N",
    "filename": "api-works-2023-07-17.json",
    "id": 3401968,
    "source": 1,
    "transmission_date": "2023-07-17"
  }
]

message.body.tablespace

string

Example:

"works"

message.body.title

string

Example:

"Yellow Submarine"

message.body.type_of_right

string

Example:

"SYN"

message.body.validity_begin

unknown

message.body.validity_end

string

Example:

"2024-10-20"

message.body.wgid

string

Example:

"works:191813604"

message.body.work_id

number

Example:

191813604

message.header

object

Show child attributes

message.header.execute_time

number

Example:

0.63219499588013

message.header.hint

string

Example:

"JSON in input doesn't respect the API JSON schema - errorType: required - errorDetails: {\"missing\":\"title\"} - errorPath: [\"data\"]"

message.header.status_code

number

Example:

200

Introduction

API Reference

Authorizations

Body

Response