PUT /asset//ddex-metadataDescription:
Update DDEX-specific metadata for an asset. This endpoint allows you to add or modify metadata fields
required for DDEX delivery, including resource references, technical details, sound recording information,
and musical work references.Authorization:
{"docsConfig":{"theme":"palm","$schema":"https://mintlify.com/docs.json","name":"Royalti.io API","colors":{"primary":"#006666","light":"#008080","dark":"#004444"},"logo":{"light":"https://mintcdn.com/royaltiio/BIFmOIRYj66RGu3q/logo/light.svg?fit=max\u0026auto=format\u0026n=BIFmOIRYj66RGu3q\u0026q=85\u0026s=a60f4ed09872b24c683102d5f7718f3e","dark":"https://mintcdn.com/royaltiio/BIFmOIRYj66RGu3q/logo/dark.svg?fit=max\u0026auto=format\u0026n=BIFmOIRYj66RGu3q\u0026q=85\u0026s=2fd3097d50e9e7d954f62810ef7d588d"},"favicon":"https://mintcdn.com/royaltiio/BIFmOIRYj66RGu3q/favicon.svg?fit=max\u0026auto=format\u0026n=BIFmOIRYj66RGu3q\u0026q=85\u0026s=b456ed10ba8cc54b22ce4c9d3c71ca74","api":{"openapi":"openapi.json","playground":{"display":"interactive"},"mdx":{"auth":{"method":"bearer","name":"Authorization"},"server":"https://api.royalti.io"}},"integrations":{},"styling":{"latex":false},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"royaltiio","hasAudioNarration":false,"actualSubdomain":"royaltiio","customDomains":["apidocs.royalti.io"],"gitSource":{"type":"github","owner":"royalti-io","repo":"royalti-server-v2.6","deployBranch":"prod","contentDirectory":"mintlify","isPrivate":true,"mountPath":"","label":""},"entitlements":{},"buildId":"6ae8c73faa0de63df87d2fcd","clientVersion":"0.0.4094","searchFilterCounts":[{"language":"default","tag":"Publishers","count":56},{"language":"default","tag":"Ddex","count":33},{"language":"default","tag":"Billing","count":30},{"language":"default","tag":"Works","count":29},{"language":"default","tag":"Checklists","count":25},{"language":"default","tag":"Release","count":24},{"language":"default","tag":"Product","count":23},{"language":"default","tag":"Auth","count":22},{"language":"default","tag":"File","count":22},{"language":"default","tag":"Merlin","count":22}]},"assistantConfig":{},"basePath":"","hasChatPermissions":false,"hasWebMcpPermissions":false,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"rbac-expansion","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"full-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-dual-write","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-metadata","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-serve","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"live-agents","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"comment-mode","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[],"page":{"pagePath":"api-reference/asset/put-asset-id-ddex-metadata","slug":"/api-reference/asset/put-asset-id-ddex-metadata","pageMetadata":{"title":"Update Asset DDEX Metadata","description":"**PUT /asset/{id}/ddex-metadata**","openapi":"put /asset/{id}/ddex-metadata","href":"/api-reference/asset/put-asset-id-ddex-metadata"},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx, jsxs: _jsxs} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n p: \"p\",\n strong: \"strong\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsx(_components.p, {\n children: _jsxs(_components.strong, {\n children: [\"PUT /asset/\", \"/ddex-metadata\"]\n })\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx,jsxs:_jsxs}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){const _components={code:`code`,li:`li`,p:`p`,pre:`pre`,span:`span`,strong:`strong`,tbody:`tbody`,td:`td`,th:`th`,thead:`thead`,tr:`tr`,ul:`ul`,..._provideComponents(),...props.components},{CodeBlock,CodeGroup,Heading,Note,Table}=_components;if(!CodeBlock)_missingMdxReference(`CodeBlock`,true);if(!CodeGroup)_missingMdxReference(`CodeGroup`,true);if(!Heading)_missingMdxReference(`Heading`,true);if(!Note)_missingMdxReference(`Note`,true);if(!Table)_missingMdxReference(`Table`,true);return _jsxs(_Fragment,{children:[_jsx(Note,{children:_jsx(_components.p,{children:`This endpoint requires authentication. Include your Bearer token in the Authorization header.`})}),`\n`,_jsx(Heading,{level:`2`,id:`description`,children:`Description`}),`\n`,_jsx(_components.p,{children:_jsxs(_components.strong,{children:[`PUT /asset/`,`/ddex-metadata`]})}),`\n`,_jsxs(_components.p,{children:[_jsx(_components.strong,{children:`Description:`}),`\nUpdate DDEX-specific metadata for an asset. This endpoint allows you to add or modify metadata fields\nrequired for DDEX delivery, including resource references, technical details, sound recording information,\nand musical work references.`]}),`\n`,_jsx(_components.p,{children:_jsx(_components.strong,{children:`Authorization:`})}),`\n`,_jsxs(_components.ul,{children:[`\n`,_jsxs(_components.li,{children:[`Required role: `,_jsx(_components.code,{children:`admin`}),` or higher`]}),`\n`]}),`\n`,_jsxs(_components.p,{children:[_jsx(_components.strong,{children:`Method:`}),`\n`,_jsx(_components.code,{children:`PUT`})]}),`\n`,_jsx(_components.p,{children:_jsx(_components.strong,{children:`Path Parameter:`})}),`\n`,_jsxs(Table,{children:[_jsx(_components.thead,{children:_jsxs(_components.tr,{children:[_jsx(_components.th,{children:`Parameter`}),_jsx(_components.th,{children:`Type`}),_jsx(_components.th,{children:`Description`})]})}),_jsx(_components.tbody,{children:_jsxs(_components.tr,{children:[_jsx(_components.td,{children:`id`}),_jsx(_components.td,{children:`string`}),_jsx(_components.td,{children:`The unique identifier of the asset`})]})})]}),`\n`,_jsx(_components.p,{children:_jsx(_components.strong,{children:`Request Payload:`})}),`\n`,_jsxs(Table,{children:[_jsx(_components.thead,{children:_jsxs(_components.tr,{children:[_jsx(_components.th,{children:`Parameter`}),_jsx(_components.th,{children:`Type`}),_jsx(_components.th,{children:`Description`})]})}),_jsxs(_components.tbody,{children:[_jsxs(_components.tr,{children:[_jsx(_components.td,{children:`ddexMetadata`}),_jsx(_components.td,{children:`object`}),_jsx(_components.td,{children:`DDEX metadata object`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:`resourceReference`}),_jsx(_components.td,{children:`string`}),_jsx(_components.td,{children:`Resource reference identifier`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:`technicalResourceDetails`}),_jsx(_components.td,{children:`object`}),_jsx(_components.td,{children:`Technical details of the resource`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:`soundRecordingDetails`}),_jsx(_components.td,{children:`object`}),_jsx(_components.td,{children:`Sound recording specific details`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:`musicalWorkReference`}),_jsx(_components.td,{children:`object`}),_jsx(_components.td,{children:`Musical work reference information`})]})]})]}),`\n`,_jsx(_components.p,{children:_jsx(_components.strong,{children:`Use Cases:`})}),`\n`,_jsxs(_components.ul,{children:[`\n`,_jsx(_components.li,{children:`Prepare asset for DDEX delivery`}),`\n`,_jsx(_components.li,{children:`Update technical specifications`}),`\n`,_jsx(_components.li,{children:`Add sound recording details`}),`\n`,_jsx(_components.li,{children:`Link to musical work references`}),`\n`]}),`\n`,_jsx(Heading,{level:`2`,id:`code-examples`,children:`Code Examples`}),`\n`,_jsxs(CodeGroup,{children:[_jsx(CodeBlock,{filename:`Node.js`,numberOfLines:`30`,language:`javascript`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`javascript`,children:_jsxs(_components.code,{language:`javascript`,numberOfLines:`30`,children:[_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#569CD6`},children:`const`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#4FC1FF`},children:` response`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D4D4D4`},children:` =`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#C586C0`},children:` await`}),_jsx(_components.span,{style:{color:`#8250DF`,\"--shiki-dark\":`#DCDCAA`},children:` fetch`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`(`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`'https://api.royalti.io/asset/example-id/ddex-metadata'`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`, {`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:` method:`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` 'PUT'`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:` headers:`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` {`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` 'Authorization'`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:`:`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:\" `Bearer \"}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#569CD6`},children:\"${\"}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:`token`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#569CD6`},children:`}`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:\"`\"}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` 'Content-Type'`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:`:`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` 'application/json'`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` },`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:` body:`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#4FC1FF`},children:` JSON`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`.`}),_jsx(_components.span,{style:{color:`#8250DF`,\"--shiki-dark\":`#DCDCAA`},children:`stringify`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`({`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"ddexMetadata\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:`:`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` {},`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"resourceReference\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:`:`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"A123456789\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"technicalResourceDetails\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:`:`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` {`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"fileFormat\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:`:`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"WAV\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"audioCodec\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:`:`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"PCM\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"bitrate\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:`:`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#B5CEA8`},children:` 1411`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"sampleRate\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:`:`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#B5CEA8`},children:` 44100`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"duration\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:`:`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"PT3M45S\"`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` },`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"soundRecordingDetails\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:`:`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` {`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"recordingDate\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:`:`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"2024-01-15\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"recordingLocation\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:`:`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"Abbey Road Studios\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"language\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:`:`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"en\"`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` },`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"musicalWorkReference\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:`:`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` {`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"workId\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:`:`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"work-123\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"iswc\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:`:`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"T-123456789-0\"`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` }`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` })`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`});`})}),`\n`,_jsx(_components.span,{className:`line`}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#569CD6`},children:`const`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#4FC1FF`},children:` data`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D4D4D4`},children:` =`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#C586C0`},children:` await`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:` response`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`.`}),_jsx(_components.span,{style:{color:`#8250DF`,\"--shiki-dark\":`#DCDCAA`},children:`json`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`();`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:`console`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`.`}),_jsx(_components.span,{style:{color:`#8250DF`,\"--shiki-dark\":`#DCDCAA`},children:`log`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`(`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:`data`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`);`})]}),`\n`]})})}),_jsx(CodeBlock,{filename:`Python`,numberOfLines:`12`,language:`python`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`python`,children:_jsxs(_components.code,{language:`python`,numberOfLines:`12`,children:[_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#C586C0`},children:`import`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` requests`})]}),`\n`,_jsx(_components.span,{className:`line`}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`response `}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D4D4D4`},children:`=`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` requests.put(`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` 'https://api.royalti.io/asset/example-id/ddex-metadata'`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#953800`,\"--shiki-dark\":`#9CDCFE`},children:` headers`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D4D4D4`},children:`=`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`{`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` 'Authorization'`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#569CD6`},children:`f`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`'Bearer `}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#569CD6`},children:`{`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`token`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#569CD6`},children:`}`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`'`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` },`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#953800`,\"--shiki-dark\":`#9CDCFE`},children:` json`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D4D4D4`},children:`=`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`{`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"ddexMetadata\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`:{},`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"resourceReference\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`:`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"A123456789\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"technicalResourceDetails\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`:{`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"fileFormat\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`:`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"WAV\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"audioCodec\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`:`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"PCM\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"bitrate\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`:`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#B5CEA8`},children:`1411`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"sampleRate\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`:`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#B5CEA8`},children:`44100`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"duration\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`:`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"PT3M45S\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`},`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"soundRecordingDetails\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`:{`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"recordingDate\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`:`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"2024-01-15\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"recordingLocation\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`:`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"Abbey Road Studios\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"language\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`:`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"en\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`},`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"musicalWorkReference\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`:{`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"workId\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`:`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"work-123\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"iswc\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`:`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"T-123456789-0\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`}}`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`)`})}),`\n`,_jsx(_components.span,{className:`line`}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`data `}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D4D4D4`},children:`=`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` response.json()`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#DCDCAA`},children:`print`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`(data)`})]}),`\n`]})})}),_jsx(CodeBlock,{filename:`cURL`,numberOfLines:`5`,language:`shellscript`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`shellscript`,children:_jsxs(_components.code,{language:`shellscript`,numberOfLines:`5`,children:[_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#953800`,\"--shiki-dark\":`#DCDCAA`},children:`curl`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` -X`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` PUT`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` https://api.royalti.io/asset/example-id/ddex-metadata`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D7BA7D`},children:` \\\\`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` -H`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"Authorization: Bearer YOUR_TOKEN\"`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D7BA7D`},children:` \\\\`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` -H`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"Content-Type: application/json\"`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D7BA7D`},children:` \\\\`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` -d`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` '{\"ddexMetadata\":{},\"resourceReference\":\"A123456789\",\"technicalResourceDetails\":{\"fileFormat\":\"WAV\",\"audioCodec\":\"PCM\",\"bitrate\":1411,\"sampleRate\":44100,\"duration\":\"PT3M45S\"},\"soundRecordingDetails\":{\"recordingDate\":\"2024-01-15\",\"recordingLocation\":\"Abbey Road Studios\",\"language\":\"en\"},\"musicalWorkReference\":{\"workId\":\"work-123\",\"iswc\":\"T-123456789-0\"}}'`})]}),`\n`,_jsx(_components.span,{className:`line`}),`\n`]})})})]})]})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent};function _missingMdxReference(id,component){throw new Error(`Expected `+(component?`component`:`object`)+\" `\"+id+\"` to be defined: you likely forgot to import, pass, or provide it.\")}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"Update Asset DDEX Metadata","description":"**PUT /asset/{id}/ddex-metadata**","openapi":"put /asset/{id}/ddex-metadata","href":"/api-reference/asset/put-asset-id-ddex-metadata"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[{"title":"Description","slug":"description","depth":2,"children":[]},{"title":"Code Examples","slug":"code-examples","depth":2,"children":[]}],"codeExamples":{}},"jsLinks":["/_mintlify/custom/royaltiio/c9872aeb88af9247/scripts/generate-from-swagger.js","/_mintlify/custom/royaltiio/92a450f742b65809/scripts/sync-openapi.js","/_mintlify/custom/royaltiio/1b1c5d646ab4e73c/scripts/validate-docs.js","/_mintlify/custom/royaltiio/4eff2efcf64378d4/scripts/merge-navigation.js"],"openApiReferenceData":{"operation":{"tags":["Asset"],"summary":"Update Asset DDEX Metadata","description":"**PUT /asset/{id}/ddex-metadata**","parameters":["17199885-8f06-4a60-982d-4c9dfeb0f53d"],"requestBody":"4d277aac-45dc-4308-acd8-21bb8d317529","responses":{"200":"9fc4832e-b3c9-4acd-9a46-7bda2789ccd0","400":"73e09706-4e55-4ada-8be3-2b5d9c27049d","401":"3daf7941-98c5-4a5f-a2ec-dc66136141ba","404":"31a1c5b6-09d4-48c8-9a8d-ee02b9fe06af","500":"1b4ec0ee-da8b-4cda-abbe-4c5148474c88"},"security":["f88b0883-454f-4c89-b744-490d4a1d0fdb"],"method":"put","type":"path","servers":["3c4e47e6-eb88-4913-a4e7-55c75897c264","69a2dcb9-06ef-4c15-94e3-df9bf992d8e9","8e6b4602-e529-46ea-aff4-4c59d0f6b391"],"path":"/asset/{id}/ddex-metadata","baseUrlOptions":["https://api.royalti.io","https://api-dev.royalti.io","http://localhost:8084"],"title":"Update Asset DDEX Metadata","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"17199885-8f06-4a60-982d-4c9dfeb0f53d":{"name":"id","in":"path","required":true,"description":"Asset ID","schema":{"type":"string","isRequired":true,"description":"Asset ID","uniqueKey":"","typeLabel":"string"}}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"ddexMetadata":{"type":"object","description":"DDEX metadata object","additionalProperties":true,"uniqueKey":"ddexMetadata","typeLabel":"object"},"resourceReference":{"type":"string","description":"Resource reference identifier","example":"A123456789","uniqueKey":"resourceReference","typeLabel":"string"},"technicalResourceDetails":{"type":"object","description":"Technical details of the resource","properties":{"fileFormat":{"type":"string","example":"WAV","uniqueKey":"technicalResourceDetails.fileFormat","typeLabel":"string"},"audioCodec":{"type":"string","example":"PCM","uniqueKey":"technicalResourceDetails.audioCodec","typeLabel":"string"},"bitrate":{"type":"integer","example":1411,"uniqueKey":"technicalResourceDetails.bitrate","typeLabel":"integer"},"sampleRate":{"type":"integer","example":44100,"uniqueKey":"technicalResourceDetails.sampleRate","typeLabel":"integer"},"duration":{"type":"string","example":"PT3M45S","uniqueKey":"technicalResourceDetails.duration","typeLabel":"string"}},"uniqueKey":"technicalResourceDetails","typeLabel":"object"},"soundRecordingDetails":{"type":"object","description":"Sound recording specific details","properties":{"recordingDate":{"type":"string","format":"date","example":"2024-01-15","uniqueKey":"soundRecordingDetails.recordingDate","typeLabel":"string\u003cdate>"},"recordingLocation":{"type":"string","example":"Abbey Road Studios","uniqueKey":"soundRecordingDetails.recordingLocation","typeLabel":"string"},"language":{"type":"string","example":"en","uniqueKey":"soundRecordingDetails.language","typeLabel":"string"}},"uniqueKey":"soundRecordingDetails","typeLabel":"object"},"musicalWorkReference":{"type":"object","description":"Musical work reference information","properties":{"workId":{"type":"string","example":"work-123","uniqueKey":"musicalWorkReference.workId","typeLabel":"string"},"iswc":{"type":"string","example":"T-123456789-0","uniqueKey":"musicalWorkReference.iswc","typeLabel":"string"}},"uniqueKey":"musicalWorkReference","typeLabel":"object"}},"example":{"ddexMetadata":{"releaseType":"Single","recordLabel":"Example Records"},"resourceReference":"A123456789","technicalResourceDetails":{"fileFormat":"WAV","audioCodec":"PCM","bitrate":1411,"sampleRate":44100,"duration":"PT3M45S"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"ddexMetadata":{"releaseType":"Single","recordLabel":"Example Records"},"resourceReference":"A123456789","technicalResourceDetails":{"fileFormat":"WAV","audioCodec":"PCM","bitrate":1411,"sampleRate":44100,"duration":"PT3M45S"}}}},"exampleType":"generated"}},"exampleType":"generated"},"responses":{"9fc4832e-b3c9-4acd-9a46-7bda2789ccd0":{"description":"DDEX metadata updated successfully","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"string","example":"success","uniqueKey":"status","typeLabel":"string"},"message":{"type":"string","example":"DDEX metadata updated successfully","uniqueKey":"message","typeLabel":"string"},"data":{"type":"object","properties":{"id":{"type":"string","uniqueKey":"data.id","typeLabel":"string"},"ddexMetadata":{"type":"object","uniqueKey":"data.ddexMetadata","typeLabel":"object"},"resourceReference":{"type":"string","uniqueKey":"data.resourceReference","typeLabel":"string"},"updatedAt":{"type":"string","format":"date-time","uniqueKey":"data.updatedAt","typeLabel":"string\u003cdate-time>"}},"uniqueKey":"data","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"status":"success","message":"DDEX metadata updated successfully","data":{"id":"\u003cstring>","ddexMetadata":{},"resourceReference":"\u003cstring>","updatedAt":"2023-11-07T05:31:56Z"}}}},"exampleType":"generated"}},"exampleType":"generated"},"73e09706-4e55-4ada-8be3-2b5d9c27049d":{"description":"Bad request","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"string","example":"error","uniqueKey":"status","typeLabel":"string"},"message":{"type":"string","example":"Invalid request parameters","uniqueKey":"message","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"status":"error","message":"Invalid request parameters"}}},"exampleType":"generated"}},"exampleType":"generated"},"3daf7941-98c5-4a5f-a2ec-dc66136141ba":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"string","example":"error","uniqueKey":"status","typeLabel":"string"},"message":{"type":"string","example":"Unauthorized","uniqueKey":"message","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"status":"error","message":"Unauthorized"}}},"exampleType":"generated"}},"exampleType":"generated"},"31a1c5b6-09d4-48c8-9a8d-ee02b9fe06af":{"description":"Asset not found","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Asset not found","uniqueKey":"message","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"message":"Asset not found"}}},"exampleType":"generated"}},"exampleType":"generated"},"1b4ec0ee-da8b-4cda-abbe-4c5148474c88":{"description":"Internal Server Error","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","example":false,"uniqueKey":"success","typeLabel":"boolean"},"error":{"type":"object","properties":{"code":{"type":"string","uniqueKey":"error.code","typeLabel":"string"},"message":{"type":"string","uniqueKey":"error.message","typeLabel":"string"},"details":{"type":"array","items":{"type":"string","uniqueKey":"error.details.items.[INDEX]","typeLabel":"string"},"uniqueKey":"error.details","typeLabel":"string[]"}},"uniqueKey":"error","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"success":false,"error":{"code":"\u003cstring>","message":"\u003cstring>","details":["\u003cstring>"]}}}},"exampleType":"generated"}},"exampleType":"generated"}},"security":{"f88b0883-454f-4c89-b744-490d4a1d0fdb":{"bearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"JWT Authorization header using the Bearer scheme. Format: \"Bearer {token}\"","scopes":[]}}},"servers":{"3c4e47e6-eb88-4913-a4e7-55c75897c264":{"url":"https://api.royalti.io","description":"Production server"},"69a2dcb9-06ef-4c15-94e3-df9bf992d8e9":{"url":"https://api-dev.royalti.io","description":"Development server"},"8e6b4602-e529-46ea-aff4-4c59d0f6b391":{"url":"http://localhost:8084","description":"Local development"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"JWT Authorization header using the Bearer scheme. Format: \"Bearer {token}\"","scopes":[]},"schema":{"title":"Bearer Auth","type":"string","isRequired":true,"description":"JWT Authorization header using the Bearer scheme. Format: \"Bearer {token}\"","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"bearerAuth","name":"Authorization"}],"title":"bearerAuth"}]},"originalFileLocation":"openapi.json"},"subdomain":"royaltiio","siteName":"Royalti.io API","title":"Update Asset DDEX Metadata - Royalti.io API","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-07-14T13:57:13.346Z","originalFileLocation":"api-reference/asset/put-asset-id-ddex-metadata.mdx"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=null;if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"system\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"description\" content=\"PUT /asset/{id}/ddex-metadata\">\u003cmeta data-mint-head name=\"application-name\" content=\"Royalti.io API\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/royaltiio/h75trzcf5yAikCNm/_generated/favicon/android-chrome-192x192.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"apple-touch-icon\" type=\"image/png\" sizes=\"180x180\" href=\"/mintlify-assets/_mintlify/favicons/royaltiio/h75trzcf5yAikCNm/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/royaltiio/h75trzcf5yAikCNm/_generated/favicon/favicon-16x16.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/royaltiio/h75trzcf5yAikCNm/_generated/favicon/favicon-32x32.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/royaltiio/h75trzcf5yAikCNm/_generated/favicon/favicon.ico\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/royaltiio/h75trzcf5yAikCNm/_generated/favicon-dark/android-chrome-192x192.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/royaltiio/h75trzcf5yAikCNm/_generated/favicon-dark/favicon-16x16.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/royaltiio/h75trzcf5yAikCNm/_generated/favicon-dark/favicon-32x32.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/royaltiio/h75trzcf5yAikCNm/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Update Asset DDEX Metadata - Royalti.io API\">\u003cmeta data-mint-head property=\"og:description\" content=\"PUT /asset/{id}/ddex-metadata\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Royalti.io API\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://apidocs.royalti.io/api-reference/asset/put-asset-id-ddex-metadata\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://royaltiio.mintlify.site/_mintlify/api/og/v2?division=Asset\u0026amp;title=Update+Asset+DDEX+Metadata\u0026amp;description=**PUT+%2Fasset%2F%7Bid%7D%2Fddex-metadata**\u0026amp;theme=5cbba4a76cd5355db3d508fb\u0026amp;signature=38aaf4b0f8eac0e41be57db5301d641f50f16e4032b4a6c413e8afc916586a42\">\u003cmeta data-mint-head property=\"og:image:width\" content=\"1200\">\u003cmeta data-mint-head property=\"og:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"twitter:card\" content=\"summary_large_image\">\u003cmeta data-mint-head name=\"twitter:title\" content=\"Update Asset DDEX Metadata - Royalti.io API\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"PUT /asset/{id}/ddex-metadata\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://royaltiio.mintlify.site/_mintlify/api/og/v2?division=Asset\u0026amp;title=Update+Asset+DDEX+Metadata\u0026amp;description=**PUT+%2Fasset%2F%7Bid%7D%2Fddex-metadata**\u0026amp;theme=5cbba4a76cd5355db3d508fb\u0026amp;signature=38aaf4b0f8eac0e41be57db5301d641f50f16e4032b4a6c413e8afc916586a42\">\u003cmeta data-mint-head name=\"twitter:image:width\" content=\"1200\">\u003cmeta data-mint-head name=\"twitter:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"msapplication-config\" content=\"/mintlify-assets/_mintlify/favicons/royaltiio/h75trzcf5yAikCNm/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Royalti.io API\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#006666\">\u003clink data-mint-head rel=\"canonical\" href=\"https://apidocs.royalti.io/api-reference/asset/put-asset-id-ddex-metadata\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/asset/put-asset-id-ddex-metadata.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://apidocs.royalti.io/#organization\",\"name\":\"Royalti.io API\",\"url\":\"https://apidocs.royalti.io\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/royaltiio/BIFmOIRYj66RGu3q/logo/light.svg?fit=max\u0026auto=format\u0026n=BIFmOIRYj66RGu3q\u0026q=85\u0026s=a60f4ed09872b24c683102d5f7718f3e\"}},{\"@type\":\"WebSite\",\"@id\":\"https://apidocs.royalti.io#website\",\"name\":\"Royalti.io API\",\"url\":\"https://apidocs.royalti.io\",\"publisher\":{\"@id\":\"https://apidocs.royalti.io/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://apidocs.royalti.io/api-reference/asset/put-asset-id-ddex-metadata#webpage\",\"url\":\"https://apidocs.royalti.io/api-reference/asset/put-asset-id-ddex-metadata\",\"name\":\"Update Asset DDEX Metadata\",\"description\":\"PUT /asset/{id}/ddex-metadata\",\"dateModified\":\"2026-07-14T13:57:13.346Z\",\"isPartOf\":{\"@id\":\"https://apidocs.royalti.io#website\"},\"breadcrumb\":{\"@id\":\"https://apidocs.royalti.io/api-reference/asset/put-asset-id-ddex-metadata#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://apidocs.royalti.io/api-reference/asset/put-asset-id-ddex-metadata#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Asset\",\"item\":\"https://apidocs.royalti.io/api-reference/asset/get-asset\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Update Asset DDEX Metadata\",\"item\":\"https://apidocs.royalti.io/api-reference/asset/put-asset-id-ddex-metadata\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://apidocs.royalti.io/api-reference/asset/put-asset-id-ddex-metadata#apireference\",\"headline\":\"Update Asset DDEX Metadata\",\"name\":\"Update Asset DDEX Metadata\",\"description\":\"PUT /asset/{id}/ddex-metadata\",\"url\":\"https://apidocs.royalti.io/api-reference/asset/put-asset-id-ddex-metadata\",\"mainEntityOfPage\":{\"@id\":\"https://apidocs.royalti.io/api-reference/asset/put-asset-id-ddex-metadata#webpage\"},\"dateModified\":\"2026-07-14T13:57:13.346Z\",\"publisher\":{\"@id\":\"https://apidocs.royalti.io/#organization\"},\"isPartOf\":{\"@id\":\"https://apidocs.royalti.io#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Royalti.io API\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"Royalti.io API","nav":{"global":null,"groups":[{"group":"Getting Started","pages":[{"title":"Welcome to Royalti.io API","href":"/introduction/index"},{"title":"Quick Start Guide","href":"/introduction/quickstart"},{"title":"Authentication Guide","href":"/introduction/authentication"},{"title":"AI \u0026 MCP Integration","icon":"robot","href":"/introduction/ai-integration"}]},{"group":"Guides","pages":[{"title":"Default Settings","icon":"sliders","href":"/guides/default-settings"},{"title":"Splits \u0026 Revenue Distribution Guide","icon":"money-bill-transfer","href":"/guides/splits-management"},{"title":"User Management \u0026 Collaboration","icon":"users","href":"/guides/user-management"},{"title":"Financial Data \u0026 Management","icon":"chart-line-up","href":"/guides/financial-data-management"},{"title":"Integrated Workflows","icon":"diagram-project","href":"/guides/integrated-workflows"},{"title":"Release Management Guide","icon":"music","href":"/guides/release-management"},{"title":"Royalty Management Guide","icon":"chart-line","href":"/guides/royalty-management"},{"title":"File Detection \u0026 Confirmation","icon":"magnifying-glass","href":"/guides/royalty-detection-confirmation"},{"title":"Payment Processing Guide","icon":"credit-card","href":"/guides/payment-processing"},{"title":"DDEX Integration Guide","icon":"file-export","href":"/guides/ddex-integration"},{"title":"FUGA Integration Guide","icon":"upload","href":"/guides/fuga-integration"},{"title":"Publishing \u0026 CWR Integration Guide","icon":"copyright","href":"/guides/publishing-cwr"},{"title":"Advanced Metadata (MEAD)","icon":"compact-disc","href":"/guides/advanced-product-metadata"},{"title":"Catalog Import \u0026 Export","icon":"arrows-rotate","href":"/guides/catalog-import-export"},{"title":"Notification System Guide","icon":"bell","href":"/guides/notifications"},{"title":"Real-Time Events Guide","icon":"bolt","href":"/guides/real-time-events"},{"title":"Webhook Integration Guide","icon":"webhook","href":"/guides/webhook-integration"}]},{"group":"Changelog","pages":[{"title":"API Changelog","href":"/changelog/changelog"}]},{"group":"Account Erasure","pages":[{"title":"Preview an account erasure plan","openapi":"post /godmin/account-erasure/preview","href":"/api-reference/account-erasure/preview-account-erasure"},{"title":"Execute an account erasure","openapi":"post /godmin/account-erasure/execute","href":"/api-reference/account-erasure/execute-account-erasure"}]},{"group":"Accounting","pages":[{"title":"Get Accounting Overview","openapi":"get /accounting/overview","href":"/api-reference/accounting/get-accounting-overview"},{"title":"Get attribution data-health findings","openapi":"get /accounting/data-health","href":"/api-reference/accounting/get-accounting-data-health"},{"title":"Get User Accounting Statistics","openapi":"get /accounting/{id}/stats","href":"/api-reference/accounting/get-accounting-id-stats"},{"title":"Get Transactions Summary","openapi":"get /accounting/transactions/summary","href":"/api-reference/accounting/get-accounting-transactions-summary"},{"title":"Get Monthly Transaction Breakdown","openapi":"get /accounting/transactions/monthly","href":"/api-reference/accounting/get-accounting-transactions-monthly"},{"title":"Get Tenant Transactions","openapi":"get /accounting/transactions","href":"/api-reference/accounting/get-accounting-transactions"},{"title":"Get Current Due Amount","openapi":"get /accounting/getcurrentdue","href":"/api-reference/accounting/get-accounting-getcurrentdue"},{"title":"Refresh Accounting Data (Synchronous)","openapi":"get /accounting/refresh","href":"/api-reference/accounting/get-accounting-refresh"},{"title":"Refresh Stats and Accounting Pipeline (Async)","openapi":"get /accounting/refreshstats","href":"/api-reference/accounting/get-accounting-refreshstats"},{"title":"Get Total Due Amount","openapi":"get /accounting/gettotaldue","href":"/api-reference/accounting/get-accounting-gettotaldue"},{"title":"Trigger User Accounting Recalculation","openapi":"post /accounting/users/{id}/recalculate","href":"/api-reference/accounting/post-accounting-users-id-recalculate"},{"title":"Trigger Tenant-Wide Accounting Recalculation","openapi":"post /accounting/tenant/recalculate","href":"/api-reference/accounting/post-accounting-tenant-recalculate"},{"title":"Get Accounting Queue Status","openapi":"get /accounting/queue/status","href":"/api-reference/accounting/get-accounting-queue-status"}]},{"group":"Admin Impersonation","pages":[{"title":"Start an impersonation session","openapi":"post /admin/impersonate/{userId}","href":"/api-reference/admin-impersonation/start-impersonation"},{"title":"End the current impersonation session","openapi":"delete /admin/impersonate","href":"/api-reference/admin-impersonation/end-impersonation"}]},{"group":"Advance","pages":[{"title":"Get a user's advance standing","openapi":"get /advance/user/{tenantUserId}/balance","href":"/api-reference/advance/get-advance-user-id-balance"},{"title":"List advances","openapi":"get /advance","href":"/api-reference/advance/get-advance"},{"title":"Create an advance draft","openapi":"post /advance","href":"/api-reference/advance/post-advance"},{"title":"Get an advance","openapi":"get /advance/{id}","href":"/api-reference/advance/get-advance-id"},{"title":"Update a draft advance","openapi":"put /advance/{id}","href":"/api-reference/advance/put-advance-id"},{"title":"Activate a draft advance","openapi":"post /advance/{id}/activate","href":"/api-reference/advance/post-advance-id-activate"},{"title":"Cancel a draft advance","openapi":"post /advance/{id}/cancel","href":"/api-reference/advance/post-advance-id-cancel"},{"title":"Write off an active advance's remainder","openapi":"post /advance/{id}/write-off","href":"/api-reference/advance/post-advance-id-write-off"}]},{"group":"Artist","pages":[{"title":"Get Artists","openapi":"get /artist/","href":"/api-reference/artist/get-artist"},{"title":"Create Artist","openapi":"post /artist/","href":"/api-reference/artist/post-artist"},{"title":"Create Bulk Artists","openapi":"post /artist/bulk","href":"/api-reference/artist/post-artist-bulk"},{"title":"Update Bulk Artist Splits","openapi":"post /artist/bulksplit","href":"/api-reference/artist/post-artist-bulksplit"},{"title":"Get Artist","openapi":"get /artist/{id}","href":"/api-reference/artist/get-artist-id"},{"title":"Update Artist","openapi":"put /artist/{id}","href":"/api-reference/artist/put-artist-id"},{"title":"Delete Artist","openapi":"delete /artist/{id}","href":"/api-reference/artist/delete-artist-id"},{"title":"Merge Artists","openapi":"put /artist/{id}/merge","href":"/api-reference/artist/put-artist-id-merge"},{"title":"Get Artist Stats","openapi":"get /artist/stats/{id}","href":"/api-reference/artist/get-artist-stats-id"},{"title":"Get Artist Stats (Alternative Path)","openapi":"get /artist/{id}/stats","href":"/api-reference/artist/get-artist-id-stats"},{"title":"Get Artist Assets","openapi":"get /artist/{id}/assets","href":"/api-reference/artist/get-artist-id-assets"},{"title":"Get Artist Products","openapi":"get /artist/{id}/products","href":"/api-reference/artist/get-artist-id-products"},{"title":"Download Artists CSV","openapi":"post /artist/download/csv","href":"/api-reference/artist/post-artist-download-csv"},{"title":"Delete Bulk Artists","openapi":"post /artist/bulk/delete","href":"/api-reference/artist/post-artist-bulk-delete"},{"title":"Get Artist Summary","openapi":"get /artist/summary","href":"/api-reference/artist/get-artist-summary"},{"title":"Get all default splits for an artist","openapi":"get /artist/{id}/splits","href":"/api-reference/artist/get-artist-id-splits"},{"title":"Create new default splits for an artist","openapi":"post /artist/{id}/splits","href":"/api-reference/artist/post-artist-id-splits"},{"title":"Get default splits by type for an artist","openapi":"get /artist/{id}/splits/{type}","href":"/api-reference/artist/get-artist-id-splits-id"},{"title":"Update default splits by type for an artist","openapi":"put /artist/{id}/splits/{type}","href":"/api-reference/artist/put-artist-id-splits-id"},{"title":"Delete default splits by type for an artist","openapi":"delete /artist/{id}/splits/{type}","href":"/api-reference/artist/delete-artist-id-splits-id"}]},{"group":"Asset","pages":[{"title":"Get all assets","openapi":"get /asset","href":"/api-reference/asset/get-asset"},{"title":"Create a new asset","openapi":"post /asset","href":"/api-reference/asset/post-asset"},{"title":"Create multiple assets in bulk","openapi":"post /asset/bulk","href":"/api-reference/asset/post-asset-bulk"},{"title":"Set bulk splits for multiple assets","openapi":"post /asset/bulksplits","href":"/api-reference/asset/post-asset-bulksplits"},{"title":"Delete multiple assets in bulk","openapi":"post /asset/bulk/delete","href":"/api-reference/asset/post-asset-bulk-delete"},{"title":"Set default split for multiple assets","openapi":"put /asset/bulk/defaultsplit","href":"/api-reference/asset/put-asset-bulk-defaultsplit"},{"title":"Bulk delete splits for multiple assets","openapi":"post /asset/bulk/deletesplit","href":"/api-reference/asset/post-asset-bulk-deletesplit"},{"title":"Download asset data as CSV","openapi":"post /asset/download/csv","href":"/api-reference/asset/post-asset-download-csv"},{"title":"Get Asset Summary","openapi":"get /asset/summary","href":"/api-reference/asset/get-asset-summary"},{"title":"Get asset by ID","openapi":"get /asset/{id}","href":"/api-reference/asset/get-asset-id"},{"title":"Update an asset","openapi":"put /asset/{id}","href":"/api-reference/asset/put-asset-id"},{"title":"Delete an asset","openapi":"delete /asset/{id}","href":"/api-reference/asset/delete-asset-id"},{"title":"Update asset artists","openapi":"put /asset/{id}/artists","href":"/api-reference/asset/put-asset-id-artists"},{"title":"Get asset statistics","openapi":"get /asset/{id}/stats","href":"/api-reference/asset/get-asset-id-stats"},{"title":"Set default split for an asset","openapi":"put /asset/{id}/setdefaultsplit","href":"/api-reference/asset/put-asset-id-setdefaultsplit"},{"title":"Upload media for an asset","openapi":"post /asset/{id}/media","href":"/api-reference/asset/post-asset-id-media"},{"title":"Get works for a recording","openapi":"get /asset/{assetId}/works","href":"/api-reference/asset/get-asset-id-works"},{"title":"Delete media for an asset","description":"Deletes a specific media file (e.g., audio, artwork) associated with an asset.","openapi":"delete /asset/{id}/media/{mediaName}","href":"/api-reference/asset/delete-asset-id-media-id"},{"title":"Update Asset DDEX Metadata","openapi":"put /asset/{id}/ddex-metadata","href":"/api-reference/asset/put-asset-id-ddex-metadata"},{"title":"Check Asset DDEX Readiness","description":"**GET /asset/{id}/ddex-readiness**","openapi":"get /asset/{id}/ddex-readiness","href":"/api-reference/asset/get-asset-id-ddex-readiness"}]},{"group":"Audit Work Activity","pages":[{"title":"Work activity trail (work changes + split changes)","openapi":"get /audit/work/{workId}/activity","href":"/api-reference/audit-work-activity/get-audit-work-id-activity"}]},{"group":"Auth","pages":[{"title":"Set Password (Invited Users)","openapi":"post /auth/setpassword","href":"/api-reference/auth/post-auth-setpassword"},{"title":"Check verification status","openapi":"get /auth/verification-status","href":"/api-reference/auth/get-verification-status"},{"title":"Forgot password","openapi":"post /auth/forgotpassword","href":"/api-reference/auth/post-auth-forgotpassword"},{"title":"Reset password","openapi":"patch /auth/resetpassword","href":"/api-reference/auth/patch-auth-resetpassword"},{"title":"import data","openapi":"post /auth/importdata","href":"/api-reference/auth/post-auth-importdata"},{"title":"Get logged in users data","openapi":"get /auth/","href":"/api-reference/auth/get-auth"},{"title":"Get new access token","openapi":"get /auth/authtoken","href":"/api-reference/auth/get-auth-authtoken"},{"title":"Logout","openapi":"post /auth/logout","href":"/api-reference/auth/post-auth-logout"},{"title":"Invite user","openapi":"post /auth/invite","href":"/api-reference/auth/post-auth-invite"},{"title":"Initiate Google OAuth login","openapi":"get /auth/google","href":"/api-reference/auth/get-auth-google"},{"title":"Google OAuth callback","openapi":"get /auth/google/callback","href":"/api-reference/auth/get-auth-google-callback"},{"title":"Initiate LinkedIn OAuth login","openapi":"get /auth/linkedin","href":"/api-reference/auth/get-auth-linkedin"},{"title":"LinkedIn OAuth callback","openapi":"get /auth/linkedin/callback","href":"/api-reference/auth/get-auth-linkedin-callback"},{"title":"Initiate Facebook OAuth login","openapi":"get /auth/facebook","href":"/api-reference/auth/get-auth-facebook"},{"title":"Facebook OAuth callback","openapi":"get /auth/facebook/callback","href":"/api-reference/auth/get-auth-facebook-callback"},{"title":"Get connected social providers","openapi":"get /auth/social/providers","href":"/api-reference/auth/get-auth-social-providers"},{"title":"Link a social provider","openapi":"post /auth/social/{provider}/link","href":"/api-reference/auth/post-auth-social-id-link"},{"title":"Unlink a social provider","openapi":"delete /auth/social/{provider}/unlink","href":"/api-reference/auth/delete-auth-social-id-unlink"},{"title":"Verify email","openapi":"post /auth/verify","href":"/api-reference/auth/post-auth-verify"},{"title":"Login with a magic link","openapi":"post /auth/loginlink","href":"/api-reference/auth/post-auth-loginlink"},{"title":"Login","openapi":"post /auth/login","href":"/api-reference/auth/post-auth-login"},{"title":"Update User Role","openapi":"patch /auth/role","href":"/api-reference/auth/patch-auth-role"}]},{"group":"Automations","pages":[{"title":"List all four automation templates with tenant state folded in","openapi":"get /ai/automations","href":"/api-reference/automations/get-ai-automations"},{"title":"Enable, disable, or reconfigure an automation template","openapi":"patch /ai/automations/{templateId}","href":"/api-reference/automations/patch-ai-automations-id"},{"title":"Start a manual run of an enabled automation","openapi":"post /ai/automations/{templateId}/run","href":"/api-reference/automations/post-ai-automations-id-run"},{"title":"List automation runs for the tenant","openapi":"get /ai/automations/runs","href":"/api-reference/automations/get-ai-automations-runs"},{"title":"Read one automation run, reconciled against the live snapshot","openapi":"get /ai/automations/runs/{runId}","href":"/api-reference/automations/get-ai-automations-runs-id"},{"title":"Resolve a run that is parked on a human approval/input step","openapi":"post /ai/automations/runs/{runId}/respond","href":"/api-reference/automations/post-ai-automations-runs-id-respond"}]},{"group":"Billing","pages":[{"title":"Get the tenant's active subscription (smart Stripe sync)","openapi":"get /billing/active","href":"/api-reference/billing/get-billing-active"},{"title":"Get last subscription sync status","openapi":"get /billing/sync-status","href":"/api-reference/billing/get-billing-sync-status"},{"title":"Get current-period usage summary","openapi":"get /billing/usage","href":"/api-reference/billing/get-billing-usage"},{"title":"List available subscription plans (local catalog)","openapi":"get /billing/plans","href":"/api-reference/billing/get-billing-plans"},{"title":"List available subscription plans (Stripe-facing shape)","openapi":"get /billing/plans/stripe","href":"/api-reference/billing/get-billing-plans-stripe"},{"title":"List local subscription records","openapi":"get /billing/subscriptions","href":"/api-reference/billing/get-billing-subscriptions"},{"title":"Create a local subscription record","openapi":"post /billing/subscriptions","href":"/api-reference/billing/post-billing-subscriptions"},{"title":"Get a local subscription record by id","openapi":"get /billing/subscriptions/{id}","href":"/api-reference/billing/get-billing-subscriptions-id"},{"title":"Cancel a local subscription","openapi":"post /billing/subscriptions/{id}/cancel","href":"/api-reference/billing/post-billing-subscriptions-id-cancel"},{"title":"Create an upgrade checkout session (redirects to direct API)","openapi":"post /billing/upgrade/checkout-session","href":"/api-reference/billing/post-billing-upgrade-checkout-session"},{"title":"Handle Stripe Checkout success callback","openapi":"get /billing/upgrade/checkout-success","href":"/api-reference/billing/get-billing-upgrade-checkout-success"},{"title":"Smart upgrade — chooses Checkout Session or direct API based on payment method","openapi":"post /billing/upgrade/{lookupKey}","href":"/api-reference/billing/post-billing-upgrade-id"},{"title":"Downgrade via Stripe Customer Portal","openapi":"post /billing/downgrade","href":"/api-reference/billing/post-billing-downgrade"},{"title":"Create a custom invoice","openapi":"post /billing/invoices/custom","href":"/api-reference/billing/post-billing-invoices-custom"},{"title":"Update a custom invoice","openapi":"put /billing/invoices/custom/{id}","href":"/api-reference/billing/put-billing-invoices-custom-id"},{"title":"Delete a custom invoice","openapi":"delete /billing/invoices/custom/{id}","href":"/api-reference/billing/delete-billing-invoices-custom-id"},{"title":"Mark a custom invoice as paid","openapi":"post /billing/invoices/custom/{id}/mark-paid","href":"/api-reference/billing/post-billing-invoices-custom-id-mark-paid"},{"title":"Create a Stripe Customer Portal session","openapi":"post /billing/portal","href":"/api-reference/billing/post-billing-portal"},{"title":"Create a Stripe Customer Session for embedded components","openapi":"post /billing/customer-session","href":"/api-reference/billing/post-billing-customer-session"},{"title":"Force-refresh subscription data from Stripe","openapi":"post /billing/refresh","href":"/api-reference/billing/post-billing-refresh"},{"title":"Get current Stripe subscription (live)","openapi":"get /billing/stripe/subscription","href":"/api-reference/billing/get-billing-stripe-subscription"},{"title":"Create a Stripe subscription directly","openapi":"post /billing/stripe/subscription","href":"/api-reference/billing/post-billing-stripe-subscription"},{"title":"Update a Stripe subscription directly (upgrade/downgrade)","openapi":"put /billing/stripe/subscription","href":"/api-reference/billing/put-billing-stripe-subscription"},{"title":"Cancel the Stripe subscription directly","openapi":"delete /billing/stripe/subscription","href":"/api-reference/billing/delete-billing-stripe-subscription"},{"title":"Create a Stripe payment link for a plan","openapi":"post /billing/stripe/payment-link","href":"/api-reference/billing/post-billing-stripe-payment-link"},{"title":"Change subscription plan (recommended entry point for all plan changes)","openapi":"put /billing/stripe/change-plan","href":"/api-reference/billing/put-billing-stripe-change-plan"},{"title":"List invoices (local custom invoices merged with Stripe invoices)","openapi":"get /billing/invoices","href":"/api-reference/billing/get-billing-invoices"},{"title":"Get billing-cache hit/miss metrics","openapi":"get /billing/metrics/cache","href":"/api-reference/billing/get-billing-metrics-cache"},{"title":"Reset billing-cache metrics counters","openapi":"post /billing/metrics/cache/reset","href":"/api-reference/billing/post-billing-metrics-cache-reset"},{"title":"Detect and fix duplicate active subscriptions (Stripe + local)","openapi":"post /billing/cleanup/duplicates","href":"/api-reference/billing/post-billing-cleanup-duplicates"}]},{"group":"Capabilities","pages":[{"title":"List every capability with this workspace's state","openapi":"get /capabilities","href":"/api-reference/capabilities/get-capabilities"},{"title":"Get one capability","openapi":"get /capabilities/{slug}","href":"/api-reference/capabilities/get-capabilities-id"},{"title":"Enable, disable, or configure a capability","openapi":"put /capabilities/{slug}","href":"/api-reference/capabilities/put-capabilities-id"},{"title":"Save (or rotate) a connection's credentials","openapi":"put /capabilities/{slug}/credentials","href":"/api-reference/capabilities/put-capabilities-id-credentials"},{"title":"Remove a connection's stored credentials","openapi":"delete /capabilities/{slug}/credentials","href":"/api-reference/capabilities/delete-capabilities-id-credentials"},{"title":"Test a connection's stored credentials","openapi":"post /capabilities/{slug}/test","href":"/api-reference/capabilities/post-capabilities-id-test"}]},{"group":"Catalog Export","pages":[{"title":"List registered catalog export templates","openapi":"get /catalog/export/templates","href":"/api-reference/catalog-export/get-catalog-export-templates"},{"title":"Run a catalog export template","openapi":"post /catalog/export","href":"/api-reference/catalog-export/post-catalog-export"}]},{"group":"Catalog Import","pages":[{"title":"List active metadata providers","openapi":"get /catalog-import/providers","href":"/api-reference/catalog-import/get-catalog-import-providers"},{"title":"Search for an artist on the primary catalog provider","openapi":"get /catalog-import/search","href":"/api-reference/catalog-import/get-catalog-import-search"},{"title":"Queue a metadata fetch + staging job","openapi":"post /catalog-import/fetch","href":"/api-reference/catalog-import/post-catalog-import-fetch"},{"title":"Poll a fetch job's status","openapi":"get /catalog-import/job/{jobId}","href":"/api-reference/catalog-import/get-catalog-import-job-id"},{"title":"List staged items in an import batch","openapi":"get /catalog-import/batch/{batchId}","href":"/api-reference/catalog-import/get-catalog-import-batch-id"},{"title":"Get a read-only diff of a staged batch against the current catalog","openapi":"get /catalog-import/batch/{batchId}/diff","href":"/api-reference/catalog-import/get-catalog-import-batch-id-diff"},{"title":"Set reviewer overrides on a pending staged item","openapi":"put /catalog-import/items/{id}","href":"/api-reference/catalog-import/put-catalog-import-items-id"},{"title":"Apply staged items to the catalog","openapi":"post /catalog-import/apply","href":"/api-reference/catalog-import/post-catalog-import-apply"},{"title":"Reject staged items","openapi":"post /catalog-import/reject","href":"/api-reference/catalog-import/post-catalog-import-reject"}]},{"group":"Checklists","pages":[{"title":"Check Royalty Assets","openapi":"get /checklist/royaltyassets","href":"/api-reference/checklists/get-checklist-royaltyassets"},{"title":"Check Royalty Products","openapi":"get /checklist/royaltyproducts","href":"/api-reference/checklists/get-checklist-royaltyproducts"},{"title":"Check Assets Splits","openapi":"get /checklist/assetsplits","href":"/api-reference/checklists/get-checklist-assetsplits"},{"title":"Check Products Splits","openapi":"get /checklist/productsplits","href":"/api-reference/checklists/get-checklist-productsplits"},{"title":"Check All Splits","openapi":"get /checklist/allsplits","href":"/api-reference/checklists/get-checklist-allsplits"},{"title":"Check Missing Royalty Splits","openapi":"get /checklist/missingroyaltysplits","href":"/api-reference/checklists/get-checklist-missingroyaltysplits"},{"title":"Check Artist Splits Users","openapi":"get /checklist/artistsplits","href":"/api-reference/checklists/get-checklist-artistsplits"},{"title":"Check Missing Primary Artists","openapi":"get /checklist/missingprimaryartists","href":"/api-reference/checklists/get-checklist-missingprimaryartists"},{"title":"Check Duplicate Artists","openapi":"get /checklist/duplicateartists","href":"/api-reference/checklists/get-checklist-duplicateartists"},{"title":"Check Products Without Assets","openapi":"get /checklist/productswithoutassets","href":"/api-reference/checklists/get-checklist-productswithoutassets"},{"title":"Check Assets Without Products","openapi":"get /checklist/assetswithoutproducts","href":"/api-reference/checklists/get-checklist-assetswithoutproducts"},{"title":"Import Missing Assets from Royalty Data","openapi":"post /checklist/royaltyassets/import","href":"/api-reference/checklists/post-checklist-royaltyassets-import"},{"title":"Import Missing Products from Royalty Data","openapi":"post /checklist/royaltyproducts/import","href":"/api-reference/checklists/post-checklist-royaltyproducts-import"},{"title":"Import Edited Ghost Asset Rows","openapi":"post /checklist/royaltyassets/import-rows","href":"/api-reference/checklists/post-checklist-royaltyassets-import-rows"},{"title":"Import Edited Ghost Product Rows","openapi":"post /checklist/royaltyproducts/import-rows","href":"/api-reference/checklists/post-checklist-royaltyproducts-import-rows"},{"title":"Enrich Existing Assets","openapi":"post /checklist/assets/enrich","href":"/api-reference/checklists/post-checklist-assets-enrich"},{"title":"Enrich Existing Products","openapi":"post /checklist/products/enrich","href":"/api-reference/checklists/post-checklist-products-enrich"},{"title":"List Enrichment Items","openapi":"get /checklist/enrichment","href":"/api-reference/checklists/get-checklist-enrichment"},{"title":"Get Enrichment Job Status","openapi":"get /checklist/enrichment/job/{jobId}","href":"/api-reference/checklists/get-checklist-enrichment-job-id"},{"title":"Get Enrichment Item","openapi":"get /checklist/enrichment/{id}","href":"/api-reference/checklists/get-checklist-enrichment-id"},{"title":"Update Enrichment Item","openapi":"put /checklist/enrichment/{id}","href":"/api-reference/checklists/put-checklist-enrichment-id"},{"title":"Approve Enrichment Items","openapi":"post /checklist/enrichment/approve","href":"/api-reference/checklists/post-checklist-enrichment-approve"},{"title":"Reject Enrichment Items","openapi":"post /checklist/enrichment/reject","href":"/api-reference/checklists/post-checklist-enrichment-reject"},{"title":"Re-Enrich Rejected Items","openapi":"post /checklist/enrichment/re-enrich","href":"/api-reference/checklists/post-checklist-enrichment-re-enrich"},{"title":"Clean Up Stale Enrichment Items","openapi":"post /checklist/enrichment/cleanup","href":"/api-reference/checklists/post-checklist-enrichment-cleanup"}]},{"group":"Currencies","pages":[{"title":"List all globally supported currencies","openapi":"get /currencies","href":"/api-reference/currencies/get-currencies"},{"title":"List exchange rates for the tenant","openapi":"get /currencies/exchange-rates","href":"/api-reference/currencies/get-currencies-exchange-rates"},{"title":"Create a single exchange rate","openapi":"post /currencies/exchange-rates","href":"/api-reference/currencies/post-currencies-exchange-rates"},{"title":"Bulk upsert exchange rates","openapi":"post /currencies/exchange-rates/bulk","href":"/api-reference/currencies/post-currencies-exchange-rates-bulk"},{"title":"Preview live or historical exchange rates from the external provider","openapi":"post /currencies/exchange-rates/fetch-live","href":"/api-reference/currencies/post-currencies-exchange-rates-fetch-live"},{"title":"Update a single exchange rate","openapi":"put /currencies/exchange-rates/{id}","href":"/api-reference/currencies/put-currencies-exchange-rates-id"},{"title":"Delete a single exchange rate","openapi":"delete /currencies/exchange-rates/{id}","href":"/api-reference/currencies/delete-currencies-exchange-rates-id"},{"title":"List the tenant's configured currencies","openapi":"get /currencies/tenant","href":"/api-reference/currencies/get-currencies-tenant"},{"title":"Get the tenant's default currency","openapi":"get /currencies/tenant/default","href":"/api-reference/currencies/get-currencies-tenant-default"},{"title":"Enable a currency for the tenant","openapi":"post /currencies/tenant/{code}/enable","href":"/api-reference/currencies/post-currencies-tenant-id-enable"},{"title":"Disable a currency for the tenant","openapi":"post /currencies/tenant/{code}/disable","href":"/api-reference/currencies/post-currencies-tenant-id-disable"},{"title":"Set a currency as the tenant's default","openapi":"post /currencies/tenant/{code}/default","href":"/api-reference/currencies/post-currencies-tenant-id-default"},{"title":"Get currency metadata by code","openapi":"get /currencies/{code}","href":"/api-reference/currencies/get-currencies-id"}]},{"group":"Cwr Export","pages":[{"title":"Generate a CWR export job for a publisher","openapi":"post /cwr/export","href":"/api-reference/cwr-export/post-cwr-export"},{"title":"List CWR export jobs for a publisher's tenant","openapi":"get /cwr/status/{publisherId}","href":"/api-reference/cwr-export/get-cwr-status-id"},{"title":"Cancel an in-progress export","openapi":"post /cwr/cancel","href":"/api-reference/cwr-export/post-cwr-cancel"},{"title":"Download the rendered CWR file for a completed job","openapi":"get /cwr/jobs/{jobId}/download","href":"/api-reference/cwr-export/get-cwr-jobs-id-download"},{"title":"Parse a raw CWR .txt file without persisting it","openapi":"post /cwr/import/raw","href":"/api-reference/cwr-export/post-cwr-import-raw"},{"title":"Upload and process a CWR acknowledgment file","openapi":"post /cwr/acknowledgment","href":"/api-reference/cwr-export/post-cwr-acknowledgment"},{"title":"List work registration statuses for the tenant","openapi":"get /cwr/works/registration-status","href":"/api-reference/cwr-export/get-cwr-works-registration-status"},{"title":"Get registration history for a specific work","openapi":"get /cwr/works/{workId}/registration","href":"/api-reference/cwr-export/get-cwr-works-id-registration"},{"title":"Manually update a registration's status","openapi":"patch /cwr/registrations/{registrationId}/status","href":"/api-reference/cwr-export/patch-cwr-registrations-id-status"}]},{"group":"Data Shares","pages":[{"title":"List data shares","openapi":"get /data-shares","href":"/api-reference/data-shares/get-data-shares"},{"title":"Create data share","openapi":"post /data-shares","href":"/api-reference/data-shares/create-data-share"},{"title":"Get data share","openapi":"get /data-shares/{id}","href":"/api-reference/data-shares/get-data-share"},{"title":"Update data share","openapi":"put /data-shares/{id}","href":"/api-reference/data-shares/update-data-share"},{"title":"Delete data share","openapi":"delete /data-shares/{id}","href":"/api-reference/data-shares/delete-data-share"}]},{"group":"Ddex","pages":[{"title":"Generate ERN for a Product","openapi":"post /ddex/ern/generate","href":"/api-reference/ddex/post-ddex-ern-generate"},{"title":"Generate ERN in batch","openapi":"post /ddex/ern/generate-batch","href":"/api-reference/ddex/post-ddex-ern-generate-batch"},{"title":"Queue MEAD generation for a Product","openapi":"post /ddex/mead/generate","href":"/api-reference/ddex/post-ddex-mead-generate"},{"title":"Update MEAD metadata for an entity","openapi":"put /ddex/mead/{entityId}","href":"/api-reference/ddex/put-ddex-mead-id"},{"title":"List DDEX messages","openapi":"get /ddex/messages","href":"/api-reference/ddex/get-ddex-messages"},{"title":"Get a DDEX message","openapi":"get /ddex/messages/{messageId}","href":"/api-reference/ddex/get-ddex-messages-id"},{"title":"Validate a DDEX message","openapi":"post /ddex/messages/{messageId}/validate","href":"/api-reference/ddex/post-ddex-messages-id-validate"},{"title":"Get a signed download URL for a message","openapi":"get /ddex/messages/{messageId}/download","href":"/api-reference/ddex/get-ddex-messages-id-download"},{"title":"Queue message delivery","openapi":"post /ddex/delivery/deliver/{messageId}","href":"/api-reference/ddex/post-ddex-delivery-deliver-id"},{"title":"Queue delivery for multiple messages","openapi":"post /ddex/delivery/deliver-batch","href":"/api-reference/ddex/post-ddex-delivery-deliver-batch"},{"title":"Retry delivery for a failed message","openapi":"post /ddex/delivery/retry/{messageId}","href":"/api-reference/ddex/post-ddex-delivery-retry-id"},{"title":"Get delivery status for a message","openapi":"get /ddex/delivery/status/{messageId}","href":"/api-reference/ddex/get-ddex-delivery-status-id"},{"title":"Get delivery logs for a message","openapi":"get /ddex/delivery/logs/{messageId}","href":"/api-reference/ddex/get-ddex-delivery-logs-id"},{"title":"Test connection to a DDEX provider","openapi":"post /ddex/delivery/test-connection","href":"/api-reference/ddex/post-ddex-delivery-test-connection"},{"title":"Test connection to all configured DDEX providers","openapi":"post /ddex/delivery/test-all-connections","href":"/api-reference/ddex/post-ddex-delivery-test-all-connections"},{"title":"List DDEX queue jobs (tenant-scoped)","openapi":"get /ddex/queue/jobs","href":"/api-reference/ddex/get-ddex-queue-jobs"},{"title":"Get a single DDEX queue job (tenant-scoped)","openapi":"get /ddex/queue/jobs/{jobId}","href":"/api-reference/ddex/get-ddex-queue-jobs-id"},{"title":"Get logs for a DDEX queue job (tenant-scoped)","openapi":"get /ddex/queue/jobs/{jobId}/logs","href":"/api-reference/ddex/get-ddex-queue-jobs-id-logs"},{"title":"Get DDEX monitoring dashboard for the current tenant","openapi":"get /ddex/monitoring/dashboard","href":"/api-reference/ddex/get-ddex-monitoring-dashboard"},{"title":"Get registry health status","openapi":"get /api/monitoring/registries/health","href":"/api-reference/ddex/get-registry-health"},{"title":"Get detailed adapter health information","openapi":"get /api/monitoring/registries/adapters","href":"/api-reference/ddex/get-adapter-health"},{"title":"Get list of registered providers","openapi":"get /api/monitoring/registries/providers","href":"/api-reference/ddex/get-registered-providers"},{"title":"Get aggregated adapter metrics","openapi":"get /api/monitoring/registries/metrics","href":"/api-reference/ddex/get-adapter-metrics"},{"title":"List global DDEX providers","openapi":"get /ddex/providers","href":"/api-reference/ddex/get-ddex-providers"},{"title":"Get provider details","openapi":"get /ddex/providers/{providerId}","href":"/api-reference/ddex/get-ddex-providers-id"},{"title":"Get provider statistics for tenant","openapi":"get /ddex/providers/{providerId}/stats","href":"/api-reference/ddex/get-ddex-providers-id-stats"},{"title":"List tenant provider configurations","openapi":"get /ddex/tenant-providers","href":"/api-reference/ddex/get-ddex-tenant-providers"},{"title":"Create tenant provider configuration","openapi":"post /ddex/tenant-providers","href":"/api-reference/ddex/post-ddex-tenant-providers"},{"title":"Get a tenant provider configuration","openapi":"get /ddex/tenant-providers/{id}","href":"/api-reference/ddex/get-ddex-tenant-providers-id"},{"title":"Update tenant provider configuration","openapi":"put /ddex/tenant-providers/{id}","href":"/api-reference/ddex/put-ddex-tenant-providers-id"},{"title":"Delete tenant provider configuration","openapi":"delete /ddex/tenant-providers/{id}","href":"/api-reference/ddex/delete-ddex-tenant-providers-id"},{"title":"Get DDEX rate limit usage statistics","openapi":"get /ddex/usage","href":"/api-reference/ddex/get-ddex-usage"},{"title":"Get comprehensive DDEX usage dashboard","openapi":"get /ddex/usage/dashboard","href":"/api-reference/ddex/get-ddex-usage-dashboard"}]},{"group":"Default Settings","pages":[{"title":"Get Default Settings (Tenant/Catalog Level)","openapi":"get /defaultsettings/{entityType}","href":"/api-reference/default-settings/get-defaultsettings-id"},{"title":"Create Default Setting (Tenant/Catalog Level)","openapi":"post /defaultsettings/{entityType}","href":"/api-reference/default-settings/post-defaultsettings-id"},{"title":"Get Default Settings (Entity-Specific)","openapi":"get /defaultsettings/{entityType}/{entityId}","href":"/api-reference/default-settings/get-defaultsettings-id-id"},{"title":"Create Default Setting (Entity-Specific)","openapi":"post /defaultsettings/{entityType}/{entityId}","href":"/api-reference/default-settings/post-defaultsettings-id-id"},{"title":"Update Default Setting (Tenant/Catalog Level)","openapi":"put /defaultsettings/{entityType}/{settingId}","href":"/api-reference/default-settings/put-defaultsettings-id-id"},{"title":"Delete Default Setting (Tenant/Catalog Level)","openapi":"delete /defaultsettings/{entityType}/{settingId}","href":"/api-reference/default-settings/delete-defaultsettings-id-id"},{"title":"Update Default Setting (Entity-Specific)","openapi":"put /defaultsettings/{entityType}/{entityId}/{settingId}","href":"/api-reference/default-settings/put-defaultsettings-id-id-id"},{"title":"Delete Default Setting (Entity-Specific)","openapi":"delete /defaultsettings/{entityType}/{entityId}/{settingId}","href":"/api-reference/default-settings/delete-defaultsettings-id-id-id"},{"title":"Get Templates","openapi":"get /defaultsettings/templates","href":"/api-reference/default-settings/get-defaultsettings-templates"},{"title":"Create Template","openapi":"post /defaultsettings/templates","href":"/api-reference/default-settings/post-defaultsettings-templates"},{"title":"Get Popular Templates","openapi":"get /defaultsettings/templates/popular","href":"/api-reference/default-settings/get-defaultsettings-templates-popular"},{"title":"Update Template","openapi":"put /defaultsettings/templates/{templateId}","href":"/api-reference/default-settings/put-defaultsettings-templates-id"},{"title":"Delete Template","openapi":"delete /defaultsettings/templates/{templateId}","href":"/api-reference/default-settings/delete-defaultsettings-templates-id"},{"title":"Apply Template","openapi":"post /defaultsettings/templates/{templateId}/apply","href":"/api-reference/default-settings/post-defaultsettings-templates-id-apply"},{"title":"Preview Resolved Defaults","openapi":"post /defaultsettings/preview/resolve","href":"/api-reference/default-settings/post-defaultsettings-preview-resolve"},{"title":"Preview Asset Defaults","openapi":"post /defaultsettings/preview/asset","href":"/api-reference/default-settings/post-defaultsettings-preview-asset"},{"title":"Preview Product Defaults","openapi":"post /defaultsettings/preview/product","href":"/api-reference/default-settings/post-defaultsettings-preview-product"},{"title":"Preview Release Defaults","openapi":"post /defaultsettings/preview/release","href":"/api-reference/default-settings/post-defaultsettings-preview-release"},{"title":"Get Default Setting by ID","openapi":"get /defaultsettings/settings/{settingId}","href":"/api-reference/default-settings/get-defaultsettings-settings-id"},{"title":"Clone Default Settings","openapi":"post /defaultsettings/clone","href":"/api-reference/default-settings/post-defaultsettings-clone"}]},{"group":"Dmp Import","pages":[{"title":"Preview a DMP export before importing","openapi":"post /dmp/import/preview","href":"/api-reference/dmp-import/post-dmp-import-preview"},{"title":"Execute a DMP import","openapi":"post /dmp/import/execute","href":"/api-reference/dmp-import/post-dmp-import-execute"},{"title":"Retry a single failed record from a prior import","openapi":"post /dmp/import/retry-record","href":"/api-reference/dmp-import/post-dmp-import-retry-record"}]},{"group":"Download","pages":[{"title":"Generate a data download","openapi":"post /download/generate","href":"/api-reference/download/post-download-generate"},{"title":"Get download status","openapi":"get /download/{id}/status","href":"/api-reference/download/get-download-id-status"},{"title":"List downloads","openapi":"get /download/list","href":"/api-reference/download/get-download-list"},{"title":"Generate download (deprecated)","openapi":"post /download/generate/download","href":"/api-reference/download/post-download-generate-download"}]},{"group":"Expense","pages":[{"title":"Get Expenses","openapi":"get /expense/","href":"/api-reference/expense/get-expense"},{"title":"Create Expense","openapi":"post /expense/","href":"/api-reference/expense/post-expense"},{"title":"Create Bulk Expenses","openapi":"post /expense/bulk","href":"/api-reference/expense/post-expense-bulk"},{"title":"Get Expense Summary","openapi":"get /expense/summary","href":"/api-reference/expense/get-expense-summary"},{"title":"Get Expense","openapi":"get /expense/{id}","href":"/api-reference/expense/get-expense-id"},{"title":"Update Expense","openapi":"put /expense/{id}","href":"/api-reference/expense/put-expense-id"},{"title":"Delete Bulk Expenses","openapi":"post /expense/bulk/delete","href":"/api-reference/expense/post-expense-bulk-delete"}]},{"group":"File","pages":[{"title":"Upload Royalty File","openapi":"post /file/royalty","href":"/api-reference/file/post-file-royalty"},{"title":"Process/Decompress Royalty File","openapi":"put /file/royalty/decompress/{tenant}/{id}","href":"/api-reference/file/put-file-royalty-decompress-id-id"},{"title":"Check File Decompression Status","openapi":"get /file/royalty/{id}","href":"/api-reference/file/get-file-royalty-id"},{"title":"Delete royalty file and associated BigQuery table","openapi":"delete /file/royalty/{id}","href":"/api-reference/file/delete-file-royalty-id"},{"title":"Get File Upload Info","openapi":"get /file/","href":"/api-reference/file/get-file"},{"title":"Get File Summary","openapi":"get /file/summary","href":"/api-reference/file/get-file-summary"},{"title":"Generate Royalty Report File","openapi":"post /file/createroyalty","href":"/api-reference/file/post-file-createroyalty"},{"title":"Resend Pending Files","openapi":"post /file/resend-pending-files","href":"/api-reference/file/post-file-resend-pending-files"},{"title":"Get File Upload URL","openapi":"post /file/upload-url","href":"/api-reference/file/post-file-upload-url"},{"title":"Restart detection for an upload whose session expired","openapi":"post /file/{id}/redetect","href":"/api-reference/file/post-file-id-redetect"},{"title":"Retry a failed royalty file","openapi":"post /file/{fileId}/retry","href":"/api-reference/file/post-file-id-retry"},{"title":"Confirm File Detection","openapi":"post /file/confirm-detection/{sessionId}","href":"/api-reference/file/post-file-confirm-detection-id"},{"title":"Start Source Creator from Detection Session","openapi":"post /file/session/{sessionId}/start-source-creator","href":"/api-reference/file/post-file-session-id-start-source-creator"},{"title":"Confirm Upload Completion","openapi":"post /file/confirm-upload-completion","href":"/api-reference/file/post-file-confirm-upload-completion"},{"title":"Get File Upload URL (Legacy)","openapi":"post /file/getUploadUrl","href":"/api-reference/file/post-file-get-upload-url"},{"title":"Enable automatic processing for files","openapi":"post /file/enable-auto-processing","href":"/api-reference/file/post-file-enable-auto-processing"},{"title":"Get auto-processing configuration","openapi":"get /file/auto-processing-config","href":"/api-reference/file/get-file-auto-processing-config"},{"title":"Get royalty file detection status","openapi":"get /file/detection/{sessionId}","href":"/api-reference/file/get-file-detection-id"},{"title":"Confirm or reject detected royalty source","openapi":"post /file/detection/{sessionId}","href":"/api-reference/file/post-file-detection-id"},{"title":"List all royalty sources","openapi":"get /file/sources","href":"/api-reference/file/get-file-sources"},{"title":"Get file download URL","openapi":"get /file/{id}/download","href":"/api-reference/file/get-file-id-download"},{"title":"Get royalty processing job status","openapi":"get /file/processing/{jobId}","href":"/api-reference/file/get-file-processing-id"}]},{"group":"Fuga Delivery","pages":[{"title":"Get Available Delivery Providers","openapi":"get /product/delivery-providers","href":"/api-reference/fuga-delivery/get-product-delivery-providers"},{"title":"Get Product Deliveries","openapi":"get /product/{id}/deliveries","href":"/api-reference/fuga-delivery/get-product-id-deliveries"},{"title":"Create Product Delivery","openapi":"post /product/{id}/deliveries","href":"/api-reference/fuga-delivery/post-product-id-deliveries"},{"title":"Validate Product Delivery","openapi":"post /product/{id}/deliveries/validate","href":"/api-reference/fuga-delivery/post-product-id-deliveries-validate"},{"title":"Create batch deliveries for multiple products","openapi":"post /product/batch-delivery","href":"/api-reference/fuga-delivery/batch-product-delivery"},{"title":"Get Product Delivery Details","openapi":"get /product/{id}/deliveries/{deliveryId}","href":"/api-reference/fuga-delivery/get-product-id-deliveries-id"},{"title":"Cancel Product Delivery","openapi":"delete /product/{id}/deliveries/{deliveryId}","href":"/api-reference/fuga-delivery/delete-product-id-deliveries-id"},{"title":"Retry Product Delivery","openapi":"put /product/{id}/deliveries/{deliveryId}/retry","href":"/api-reference/fuga-delivery/put-product-id-deliveries-id-retry"},{"title":"Get FUGA Delivery Metrics","openapi":"get /api/monitoring/fuga/metrics","href":"/api-reference/fuga-delivery/get-api-monitoring-fuga-metrics"},{"title":"Get FUGA Delivery Health Report","openapi":"get /api/monitoring/fuga/health","href":"/api-reference/fuga-delivery/get-api-monitoring-fuga-health"},{"title":"Get Active Alerts","openapi":"get /api/monitoring/fuga/alerts","href":"/api-reference/fuga-delivery/get-api-monitoring-fuga-alerts"},{"title":"Get Stuck Deliveries","openapi":"get /api/monitoring/fuga/stuck-deliveries","href":"/api-reference/fuga-delivery/get-api-monitoring-fuga-stuck-deliveries"},{"title":"Get FTP Connection Health","openapi":"get /api/monitoring/fuga/ftp-health","href":"/api-reference/fuga-delivery/get-api-monitoring-fuga-ftp-health"},{"title":"Update Alert Thresholds (Admin Only)","openapi":"put /api/monitoring/fuga/thresholds","href":"/api-reference/fuga-delivery/put-api-monitoring-fuga-thresholds"},{"title":"Get Prometheus Metrics","openapi":"get /metrics/fuga","href":"/api-reference/fuga-delivery/get-metrics-fuga"}]},{"group":"Integration","pages":[{"title":"Check Paystack Balance","openapi":"get /integrations/paystack/balance","href":"/api-reference/integration/get-integrations-paystack-balance"},{"title":"List Supported Paystack Banks","openapi":"get /integrations/paystack/banks","href":"/api-reference/integration/get-integrations-paystack-banks"},{"title":"Verify Bank Account Number","openapi":"get /integrations/paystack/verify-account","href":"/api-reference/integration/get-integrations-paystack-verify-account"},{"title":"Create Paystack Transfer Recipient","openapi":"post /integrations/paystack/recipients","href":"/api-reference/integration/post-integrations-paystack-recipients"},{"title":"Reconcile Paystack Payment Transfer Status","openapi":"post /integrations/paystack/reconcile/{id}","href":"/api-reference/integration/post-integrations-paystack-reconcile-id"}]},{"group":"Label","pages":[{"title":"Create Label","openapi":"post /labels/","href":"/api-reference/label/post-labels"},{"title":"List Label Access","openapi":"get /labels/{labelId}/access","href":"/api-reference/label/get-labels-id-access"},{"title":"Add Label Access","openapi":"post /labels/{labelId}/access","href":"/api-reference/label/post-labels-id-access"},{"title":"Update Label Access","openapi":"patch /labels/{labelId}/access/{tenantUserId}","href":"/api-reference/label/patch-labels-id-access-id"},{"title":"Remove Label Access","openapi":"delete /labels/{labelId}/access/{tenantUserId}","href":"/api-reference/label/delete-labels-id-access-id"},{"title":"Get Label Settings","openapi":"get /labels/{id}/settings","href":"/api-reference/label/get-labels-id-settings"},{"title":"Update Label Settings","openapi":"put /labels/{id}/settings","href":"/api-reference/label/put-labels-id-settings"},{"title":"Get Label Hierarchy","openapi":"get /labels/hierarchy","href":"/api-reference/label/get-labels-hierarchy"},{"title":"Bulk Delete Labels","openapi":"post /labels/bulk/delete","href":"/api-reference/label/post-labels-bulk-delete"},{"title":"Get Label by ID","openapi":"get /labels/{id}","href":"/api-reference/label/get-labels-id"},{"title":"Update Label","openapi":"put /labels/{id}","href":"/api-reference/label/put-labels-id"},{"title":"Delete Label","openapi":"delete /labels/{id}","href":"/api-reference/label/delete-labels-id"},{"title":"Add Artist to Label","openapi":"post /labels/{labelId}/artists","href":"/api-reference/label/post-labels-id-artists"},{"title":"Remove Artist from Label","openapi":"delete /labels/{labelId}/artists/{artistId}","href":"/api-reference/label/delete-labels-id-artists-id"},{"title":"Add Product to Label","openapi":"post /labels/{labelId}/products","href":"/api-reference/label/post-labels-id-products"},{"title":"Remove Product from Label","openapi":"delete /labels/{labelId}/products/{productId}","href":"/api-reference/label/delete-labels-id-products-id"}]},{"group":"Labelgrid","pages":[{"title":"Get LabelGrid credential status","openapi":"get /ddex/labelgrid/credentials","href":"/api-reference/labelgrid/get-ddex-labelgrid-credentials"},{"title":"Store LabelGrid credentials","openapi":"put /ddex/labelgrid/credentials","href":"/api-reference/labelgrid/put-ddex-labelgrid-credentials"},{"title":"Clear LabelGrid credentials","openapi":"delete /ddex/labelgrid/credentials","href":"/api-reference/labelgrid/delete-ddex-labelgrid-credentials"},{"title":"Test the LabelGrid connection","openapi":"post /ddex/labelgrid/test-connection","href":"/api-reference/labelgrid/post-ddex-labelgrid-test-connection"}]},{"group":"Merlin","pages":[{"title":"Get Merlin Configuration","openapi":"get /merlin/config","href":"/api-reference/merlin/get-merlin-config"},{"title":"Create or update Merlin's non-secret configuration","openapi":"post /merlin/config","href":"/api-reference/merlin/post-merlin-config"},{"title":"Test FTP connection","openapi":"post /merlin/test-connection","href":"/api-reference/merlin/post-merlin-test-connection"},{"title":"Get current FTP connection status","openapi":"get /merlin/connection-status","href":"/api-reference/merlin/get-merlin-connection-status"},{"title":"Get import configuration","openapi":"get /merlin/import/config","href":"/api-reference/merlin/get-merlin-import-config"},{"title":"Update import configuration","openapi":"put /merlin/import/config","href":"/api-reference/merlin/put-merlin-import-config"},{"title":"Get enabled Merlin features","openapi":"get /merlin/features","href":"/api-reference/merlin/get-merlin-features"},{"title":"Trigger a manual import","openapi":"post /merlin/import/trigger","href":"/api-reference/merlin/post-merlin-import-trigger"},{"title":"List pending imports awaiting approval","openapi":"get /merlin/pending","href":"/api-reference/merlin/get-merlin-pending"},{"title":"List pending imports grouped by DSP and period","openapi":"get /merlin/pending/grouped","href":"/api-reference/merlin/get-merlin-pending-grouped"},{"title":"Get details of a pending import","openapi":"get /merlin/pending/{id}","href":"/api-reference/merlin/get-merlin-pending-id"},{"title":"Preview file contents before approval","openapi":"get /merlin/pending/{id}/preview","href":"/api-reference/merlin/get-merlin-pending-id-preview"},{"title":"Approve a single pending import","openapi":"post /merlin/pending/{id}/approve","href":"/api-reference/merlin/post-merlin-pending-id-approve"},{"title":"Reject a pending import","openapi":"post /merlin/pending/{id}/reject","href":"/api-reference/merlin/post-merlin-pending-id-reject"},{"title":"Approve multiple pending imports at once","openapi":"post /merlin/pending/bulk-approve","href":"/api-reference/merlin/post-merlin-pending-bulk-approve"},{"title":"Reject multiple pending imports at once","openapi":"post /merlin/pending/bulk-reject","href":"/api-reference/merlin/post-merlin-pending-bulk-reject"},{"title":"Get AI-powered approval recommendations","openapi":"get /merlin/pending/recommendations","href":"/api-reference/merlin/get-merlin-pending-recommendations"},{"title":"Get files eligible for auto-approval","openapi":"get /merlin/pending/auto-approvable","href":"/api-reference/merlin/get-merlin-pending-auto-approvable"},{"title":"Get files eligible for group approval","openapi":"get /merlin/pending/groupable","href":"/api-reference/merlin/get-merlin-pending-groupable"},{"title":"Get import history","openapi":"get /merlin/history","href":"/api-reference/merlin/get-merlin-history"},{"title":"Get import statistics","openapi":"get /merlin/stats","href":"/api-reference/merlin/get-merlin-stats"},{"title":"Get detailed metrics and analytics","openapi":"get /merlin/metrics","href":"/api-reference/merlin/get-merlin-metrics"}]},{"group":"Notifications","pages":[{"title":"Get Notifications","openapi":"get /notifications","href":"/api-reference/notifications/get-notifications"},{"title":"Get Unread Notification Count","openapi":"get /notifications/unread/count","href":"/api-reference/notifications/get-notifications-unread-count"},{"title":"Mark All Notifications as Read","openapi":"patch /notifications/mark-all-read","href":"/api-reference/notifications/patch-notifications-mark-all-read"},{"title":"Mark Notification as Read","openapi":"patch /notifications/{notificationId}/read","href":"/api-reference/notifications/patch-notifications-id-read"},{"title":"Get Notification Preferences","openapi":"get /notifications/preferences","href":"/api-reference/notifications/get-notifications-preferences"},{"title":"Update Notification Preferences","openapi":"put /notifications/preferences","href":"/api-reference/notifications/put-notifications-preferences"}]},{"group":"Payment Requests","pages":[{"title":"Get Payment Requests","openapi":"get /payment-request/","href":"/api-reference/payment-requests/get-payment-request"},{"title":"New Payment Request","openapi":"post /payment-request/","href":"/api-reference/payment-requests/post-payment-request"},{"title":"Get Payment Request","openapi":"get /payment-request/{id}","href":"/api-reference/payment-requests/get-payment-request-id"},{"title":"Update Payment Request","openapi":"put /payment-request/{id}","href":"/api-reference/payment-requests/put-payment-request-id"},{"title":"Delete Payment Request","openapi":"delete /payment-request/{id}","href":"/api-reference/payment-requests/delete-payment-request-id"},{"title":"Bulk Approve Payment Requests","openapi":"post /payment-request/bulk/approve","href":"/api-reference/payment-requests/post-payment-request-bulk-approve"},{"title":"Delete Bulk Payment Requests","openapi":"post /payment-request/bulk/delete","href":"/api-reference/payment-requests/post-payment-request-bulk-delete"},{"title":"Approve Payment Request","openapi":"patch /payment-request/{id}/approve","href":"/api-reference/payment-requests/patch-payment-request-id-approve"},{"title":"Decline Payment Request","openapi":"patch /payment-request/{id}/decline","href":"/api-reference/payment-requests/patch-payment-request-id-decline"}]},{"group":"Payment Settings","pages":[{"title":"Get Payment Settings","openapi":"get /payment-setting","href":"/api-reference/payment-settings/get-payment-setting"},{"title":"Create New Payment Setting","openapi":"post /payment-setting","href":"/api-reference/payment-settings/post-payment-setting"},{"title":"Get Payment Setting","openapi":"get /payment-setting/{id}","href":"/api-reference/payment-settings/get-payment-setting-id"},{"title":"Update Payment Setting","openapi":"put /payment-setting/{id}","href":"/api-reference/payment-settings/put-payment-setting-id"},{"title":"Delete Payment Setting","openapi":"delete /payment-setting/{id}","href":"/api-reference/payment-settings/delete-payment-setting-id"},{"title":"Delete Bulk Payment Settings","openapi":"post /payment-setting/bulk/delete","href":"/api-reference/payment-settings/post-payment-setting-bulk-delete"}]},{"group":"Payments","pages":[{"title":"Get Payments","openapi":"get /payment/","href":"/api-reference/payments/get-payment"},{"title":"Create Payment","openapi":"post /payment/","href":"/api-reference/payments/post-payment"},{"title":"Get Payment Summary","openapi":"get /payment/summary","href":"/api-reference/payments/get-payment-summary"},{"title":"Get Payment","openapi":"get /payment/{id}","href":"/api-reference/payments/get-payment-id"},{"title":"Update Payment","openapi":"put /payment/{id}","href":"/api-reference/payments/put-payment-id"},{"title":"Delete Payment","openapi":"delete /payment/{id}","href":"/api-reference/payments/delete-payment-id"},{"title":"Create Bulk Payments","openapi":"post /payment/bulk","href":"/api-reference/payments/post-payment-bulk"},{"title":"Delete Bulk Payments","openapi":"post /payment/bulk/delete","href":"/api-reference/payments/post-payment-bulk-delete"}]},{"group":"Pro Credentials","pages":[{"title":"List the tenant's PRO credential sets","openapi":"get /pro-credentials","href":"/api-reference/pro-credentials/get-pro-credentials"},{"title":"Create a PRO credential set","openapi":"post /pro-credentials","href":"/api-reference/pro-credentials/post-pro-credentials"},{"title":"Get a PRO credential set","openapi":"get /pro-credentials/{id}","href":"/api-reference/pro-credentials/get-pro-credentials-id"},{"title":"Update a PRO credential set","openapi":"patch /pro-credentials/{id}","href":"/api-reference/pro-credentials/patch-pro-credentials-id"},{"title":"Delete a PRO credential set","openapi":"delete /pro-credentials/{id}","href":"/api-reference/pro-credentials/delete-pro-credentials-id"},{"title":"Test connectivity for a PRO credential set","openapi":"post /pro-credentials/{id}/test","href":"/api-reference/pro-credentials/post-pro-credentials-id-test"}]},{"group":"Product","pages":[{"title":"Get Products","openapi":"get /product/","href":"/api-reference/product/get-product"},{"title":"Create Product","openapi":"post /product/","href":"/api-reference/product/post-product"},{"title":"Get Product Summary","openapi":"get /product/summary","href":"/api-reference/product/get-product-summary"},{"title":"Get Product","openapi":"get /product/{id}","href":"/api-reference/product/get-product-id"},{"title":"Update Product","openapi":"put /product/{id}","href":"/api-reference/product/put-product-id"},{"title":"Delete Product","openapi":"delete /product/{id}","href":"/api-reference/product/delete-product-id"},{"title":"Update Product Artists","openapi":"put /product/{id}/artists","href":"/api-reference/product/put-product-id-artists"},{"title":"Update Product Assets","openapi":"put /product/{id}/assets","href":"/api-reference/product/put-product-id-assets"},{"title":"Get Product Stats","openapi":"get /product/{id}/stats","href":"/api-reference/product/get-product-id-stats"},{"title":"Set Default Split for Product from Artist","openapi":"put /product/{id}/setdefaultsplit","href":"/api-reference/product/put-product-id-setdefaultsplit"},{"title":"Download Product Metadata","openapi":"post /product/download/metadata","href":"/api-reference/product/post-product-download-metadata"},{"title":"Download Products CSV","openapi":"post /product/download/csv","href":"/api-reference/product/post-product-download-csv"},{"title":"Upload Product Media","openapi":"post /product/{id}/media","href":"/api-reference/product/post-product-id-media"},{"title":"Delete Product Media","openapi":"delete /product/{id}/media/{mediaName}","href":"/api-reference/product/delete-product-id-media-id"},{"title":"Bulk Delivery Readiness Check","openapi":"get /product/delivery-readiness","href":"/api-reference/product/get-product-delivery-readiness"},{"title":"Set Product Cover Art","openapi":"patch /product/{id}/cover-art","href":"/api-reference/product/patch-product-id-cover-art"},{"title":"Create Bulk Products","openapi":"post /product/bulk","href":"/api-reference/product/post-product-bulk"},{"title":"Update Bulk Product Splits","openapi":"put /product/bulksplits","href":"/api-reference/product/put-product-bulksplits"},{"title":"Delete Bulk Products","openapi":"post /product/bulk/delete","href":"/api-reference/product/post-product-bulk-delete"},{"title":"Set Default Split for Bulk Products","openapi":"put /product/bulk/defaultsplit","href":"/api-reference/product/put-product-bulk-defaultsplit"},{"title":"Delete Splits from Bulk Products","openapi":"post /product/bulk/deletesplit","href":"/api-reference/product/post-product-bulk-deletesplit"},{"title":"Trigger Product Delivery (Legacy)","openapi":"post /product/{id}/delivery","href":"/api-reference/product/post-product-id-delivery"},{"title":"Get Product Delivery Status (Legacy)","openapi":"get /product/{id}/delivery/status","href":"/api-reference/product/get-product-id-delivery-status"}]},{"group":"Publisher Bulk Ops","pages":[{"title":"Bulk-import many statement files for a publisher in one call","openapi":"post /publisher/publishers/{id}/statements/bulk-import","href":"/api-reference/publisher-bulk-ops/post-publisher-publishers-id-statements-bulk-import"},{"title":"Sources, months and built statements for the Build-from-files dialog","openapi":"get /publisher/statements/from-files/sources","href":"/api-reference/publisher-bulk-ops/get-publisher-statements-from-files-sources"},{"title":"Build a draft statement from an Add-files table","openapi":"post /publisher/statements/from-files","href":"/api-reference/publisher-bulk-ops/post-publisher-statements-from-files"},{"title":"What stops a statement from posting to the ledger in full","openapi":"get /publisher/statements/{id}/setup-checklist","href":"/api-reference/publisher-bulk-ops/get-publisher-statements-id-setup-checklist"},{"title":"Batch post-to-ledger for many statements","openapi":"post /publisher/statements/bulk-post","href":"/api-reference/publisher-bulk-ops/post-publisher-statements-bulk-post"},{"title":"Bulk-render writer and/or publisher statement PDFs as one zip","openapi":"post /publisher/statements/bulk-render","href":"/api-reference/publisher-bulk-ops/post-publisher-statements-bulk-render"},{"title":"Post one statement's matched writer shares to the ledger","openapi":"post /publisher/statements/{id}/post-to-ledger","href":"/api-reference/publisher-bulk-ops/post-publisher-statements-id-post-to-ledger"},{"title":"Reverse a statement's live ledger postings","openapi":"post /publisher/statements/{id}/reverse-ledger-posting","href":"/api-reference/publisher-bulk-ops/post-publisher-statements-id-reverse-ledger-posting"}]},{"group":"Publisher Writer Agreements","pages":[{"title":"List publisher-writer agreements","openapi":"get /publisher-writer/agreements","href":"/api-reference/publisher-writer-agreements/get-publisher-writer-agreements"},{"title":"Create a publisher-writer agreement","openapi":"post /publisher-writer/agreements","href":"/api-reference/publisher-writer-agreements/post-publisher-writer-agreements"},{"title":"Get a publisher-writer agreement by ID","openapi":"get /publisher-writer/agreements/{id}","href":"/api-reference/publisher-writer-agreements/get-publisher-writer-agreements-id"},{"title":"Update a publisher-writer agreement","openapi":"put /publisher-writer/agreements/{id}","href":"/api-reference/publisher-writer-agreements/put-publisher-writer-agreements-id"},{"title":"Delete a publisher-writer agreement","openapi":"delete /publisher-writer/agreements/{id}","href":"/api-reference/publisher-writer-agreements/delete-publisher-writer-agreements-id"},{"title":"Update an agreement's status","openapi":"patch /publisher-writer/agreements/{id}/status","href":"/api-reference/publisher-writer-agreements/patch-publisher-writer-agreements-id-status"},{"title":"Add a territory to an agreement","openapi":"post /publisher-writer/agreements/{id}/territories","href":"/api-reference/publisher-writer-agreements/post-publisher-writer-agreements-id-territories"},{"title":"Remove a territory from an agreement","openapi":"delete /publisher-writer/agreements/{id}/territories/{territoryCode}","href":"/api-reference/publisher-writer-agreements/delete-publisher-writer-agreements-id-territories-id"}]},{"group":"Publishers","pages":[{"title":"List publishers","openapi":"get /publisher/publishers","href":"/api-reference/publishers/get-publisher-publishers"},{"title":"Create a publisher","openapi":"post /publisher/publishers","href":"/api-reference/publishers/post-publisher-publishers"},{"title":"Get the tenant's first publisher record","openapi":"get /publisher/publishers/me","href":"/api-reference/publishers/get-publisher-publishers-me"},{"title":"Get a publisher","openapi":"get /publisher/publishers/{id}","href":"/api-reference/publishers/get-publisher-publishers-id"},{"title":"Update a publisher","openapi":"put /publisher/publishers/{id}","href":"/api-reference/publishers/put-publisher-publishers-id"},{"title":"Delete a publisher","openapi":"delete /publisher/publishers/{id}","href":"/api-reference/publishers/delete-publisher-publishers-id"},{"title":"List publishers merged with their linked TenantUser info","openapi":"get /publisher/publishers-with-user-data","href":"/api-reference/publishers/get-publisher-publishers-with-user-data"},{"title":"Export a CWR registration file for one publisher","openapi":"post /publisher/publishers/export/cwr","href":"/api-reference/publishers/post-publisher-publishers-export-cwr"},{"title":"List a publisher's territories","openapi":"get /publisher/publishers/{id}/territories","href":"/api-reference/publishers/get-publisher-publishers-id-territories"},{"title":"Add a territory to a publisher","openapi":"post /publisher/publishers/{id}/territories","href":"/api-reference/publishers/post-publisher-publishers-id-territories"},{"title":"Update a publisher territory","openapi":"put /publisher/publishers/{id}/territories/{territoryId}","href":"/api-reference/publishers/put-publisher-publishers-id-territories-id"},{"title":"Delete a publisher territory","openapi":"delete /publisher/publishers/{id}/territories/{territoryId}","href":"/api-reference/publishers/delete-publisher-publishers-id-territories-id"},{"title":"List a publisher's agreements","openapi":"get /publisher/publishers/{id}/agreements","href":"/api-reference/publishers/get-publisher-publishers-id-agreements"},{"title":"Add an agreement to a publisher","openapi":"post /publisher/publishers/{id}/agreements","href":"/api-reference/publishers/post-publisher-publishers-id-agreements"},{"title":"Update a publisher agreement","openapi":"put /publisher/publishers/{id}/agreements/{agreementId}","href":"/api-reference/publishers/put-publisher-publishers-id-agreements-id"},{"title":"Delete a publisher agreement","openapi":"delete /publisher/publishers/{id}/agreements/{agreementId}","href":"/api-reference/publishers/delete-publisher-publishers-id-agreements-id"},{"title":"List statements for a publisher","openapi":"get /publisher/publishers/{id}/statements","href":"/api-reference/publishers/get-publisher-publishers-id-statements"},{"title":"Generate a publisher royalty statement","openapi":"post /publisher/publishers/{id}/statements","href":"/api-reference/publishers/post-publisher-publishers-id-statements"},{"title":"Get statement detail","openapi":"get /publisher/publishers/{id}/statements/{statementId}","href":"/api-reference/publishers/get-publisher-publishers-id-statements-id"},{"title":"Transition a statement's status","openapi":"patch /publisher/publishers/{id}/statements/{statementId}/status","href":"/api-reference/publishers/patch-publisher-publishers-id-statements-id-status"},{"title":"Download the statement PDF","openapi":"get /publisher/publishers/{id}/statements/{statementId}/pdf","href":"/api-reference/publishers/get-publisher-publishers-id-statements-id-pdf"},{"title":"Ingest a PRO statement file into statement lines","openapi":"post /publisher/publishers/{id}/statements/{statementId}/ingest","href":"/api-reference/publishers/post-publisher-publishers-id-statements-id-ingest"},{"title":"List ingested statement lines","openapi":"get /publisher/publishers/{id}/statements/{statementId}/lines","href":"/api-reference/publishers/get-publisher-publishers-id-statements-id-lines"},{"title":"Manually match (or unmatch) a statement line to a CWR work","openapi":"patch /publisher/publishers/{id}/statements/{statementId}/lines/{lineId}/match","href":"/api-reference/publishers/patch-publisher-publishers-id-statements-id-lines-id-match"},{"title":"Run the fuzzy auto-matcher across unmatched lines","openapi":"post /publisher/publishers/{id}/statements/{statementId}/lines/auto-match","href":"/api-reference/publishers/post-publisher-publishers-id-statements-id-lines-auto-match"},{"title":"List variance flags for a statement","openapi":"get /publisher/publishers/{id}/statements/{statementId}/variance-flags","href":"/api-reference/publishers/get-publisher-publishers-id-statements-id-variance-flags"},{"title":"(Re)run variance detection for a statement","openapi":"post /publisher/publishers/{id}/statements/{statementId}/variance-flags/detect","href":"/api-reference/publishers/post-publisher-publishers-id-statements-id-variance-flags-detect"},{"title":"Update a single variance flag's status","openapi":"patch /publisher/publishers/{id}/statements/{statementId}/variance-flags/{flagId}/status","href":"/api-reference/publishers/patch-publisher-publishers-id-statements-id-variance-flags-id-status"},{"title":"Bulk-update variance flag statuses","openapi":"post /publisher/publishers/{id}/statements/{statementId}/variance-flags/bulk-approve","href":"/api-reference/publishers/post-publisher-publishers-id-statements-id-variance-flags-bulk-approve"},{"title":"List comments on a variance flag","openapi":"get /publisher/publishers/{id}/statements/{statementId}/variance-flags/{flagId}/comments","href":"/api-reference/publishers/get-publisher-publishers-id-statements-id-variance-flags-id-comments"},{"title":"Append a comment to a variance flag thread","openapi":"post /publisher/publishers/{id}/statements/{statementId}/variance-flags/{flagId}/comments","href":"/api-reference/publishers/post-publisher-publishers-id-statements-id-variance-flags-id-comments"},{"title":"List manual adjustments on a statement (H-05)","openapi":"get /publisher/publishers/{id}/statements/{statementId}/adjustments","href":"/api-reference/publishers/get-publisher-publishers-id-statements-id-adjustments"},{"title":"Add a manual adjustment to a statement (H-05)","openapi":"post /publisher/publishers/{id}/statements/{statementId}/adjustments","href":"/api-reference/publishers/post-publisher-publishers-id-statements-id-adjustments"},{"title":"Remove a manual adjustment from a statement (H-05)","openapi":"delete /publisher/publishers/{id}/statements/{statementId}/adjustments/{adjustmentId}","href":"/api-reference/publishers/delete-publisher-publishers-id-statements-id-adjustments-id"},{"title":"Email the rendered statement PDF to recipients","openapi":"post /publisher/publishers/{id}/statements/{statementId}/email","href":"/api-reference/publishers/post-publisher-publishers-id-statements-id-email"},{"title":"List sub-publishing agreements","openapi":"get /publisher/sub-publishing","href":"/api-reference/publishers/get-publisher-sub-publishing"},{"title":"Create a sub-publishing agreement","openapi":"post /publisher/sub-publishing","href":"/api-reference/publishers/post-publisher-sub-publishing"},{"title":"Get a sub-publishing agreement","openapi":"get /publisher/sub-publishing/{id}","href":"/api-reference/publishers/get-publisher-sub-publishing-id"},{"title":"Update a sub-publishing agreement","openapi":"put /publisher/sub-publishing/{id}","href":"/api-reference/publishers/put-publisher-sub-publishing-id"},{"title":"Check for territory conflicts between two publishers","openapi":"post /publisher/sub-publishing/check-conflicts","href":"/api-reference/publishers/post-publisher-sub-publishing-check-conflicts"},{"title":"List an agreement's discussion messages (H-07)","openapi":"get /publisher/sub-publishing/{id}/messages","href":"/api-reference/publishers/get-publisher-sub-publishing-id-messages"},{"title":"Post a message to an agreement's discussion thread (H-07)","openapi":"post /publisher/sub-publishing/{id}/messages","href":"/api-reference/publishers/post-publisher-sub-publishing-id-messages"},{"title":"List a sub-publishing agreement's recoupment ledger","openapi":"get /publisher/sub-publishing/{id}/recoupment","href":"/api-reference/publishers/get-publisher-sub-publishing-id-recoupment"},{"title":"One-shot publishing analytics dashboard payload","openapi":"get /publisher/analytics/summary","href":"/api-reference/publishers/get-publisher-analytics-summary"},{"title":"Earnings grouped by statement-line source PRO","openapi":"get /publisher/analytics/earnings/by-society","href":"/api-reference/publishers/get-publisher-analytics-earnings-by-society"},{"title":"Earnings grouped by right type","openapi":"get /publisher/analytics/earnings/by-right-type","href":"/api-reference/publishers/get-publisher-analytics-earnings-by-right-type"},{"title":"Earnings grouped by statement-line territory","openapi":"get /publisher/analytics/earnings/by-territory","href":"/api-reference/publishers/get-publisher-analytics-earnings-by-territory"},{"title":"Earnings by the programme or film a cue was used in","openapi":"get /publisher/analytics/earnings/by-placement","href":"/api-reference/publishers/get-publisher-analytics-earnings-by-placement"},{"title":"Earnings by cue type (BMI USE CODE)","openapi":"get /publisher/analytics/earnings/by-cue-type","href":"/api-reference/publishers/get-publisher-analytics-earnings-by-cue-type"},{"title":"Top-earning matched works","openapi":"get /publisher/analytics/earnings/by-work","href":"/api-reference/publishers/get-publisher-analytics-earnings-by-work"},{"title":"Earnings over time, by month or quarter","openapi":"get /publisher/analytics/earnings/by-period","href":"/api-reference/publishers/get-publisher-analytics-earnings-by-period"},{"title":"Earnings grouped by publisher","openapi":"get /publisher/analytics/earnings/by-publisher","href":"/api-reference/publishers/get-publisher-analytics-earnings-by-publisher"},{"title":"Earnings attributed to individual songwriters","openapi":"get /publisher/analytics/earnings/by-writer","href":"/api-reference/publishers/get-publisher-analytics-earnings-by-writer"},{"title":"The work-matching queue, worst-first","openapi":"get /publisher/analytics/unmatched-lines","href":"/api-reference/publishers/get-publisher-analytics-unmatched-lines"},{"title":"Statement coverage and line match-rate","openapi":"get /publisher/analytics/statement-coverage","href":"/api-reference/publishers/get-publisher-analytics-statement-coverage"},{"title":"Recoupment status across sub-publishing agreements","openapi":"get /publisher/analytics/recoupment-status","href":"/api-reference/publishers/get-publisher-analytics-recoupment-status"}]},{"group":"Publishing Bootstrap","pages":[{"title":"Queue a catalog scan that stages skeleton work proposals","openapi":"post /publishing-bootstrap/scan","href":"/api-reference/publishing-bootstrap/post-publishing-bootstrap-scan"},{"title":"Get scan job status","openapi":"get /publishing-bootstrap/job/{jobId}","href":"/api-reference/publishing-bootstrap/get-publishing-bootstrap-job-id"},{"title":"List all staged items in a batch","openapi":"get /publishing-bootstrap/batch/{batchId}","href":"/api-reference/publishing-bootstrap/get-publishing-bootstrap-batch-id"},{"title":"Get the read-only G-PUBSEED diff for a batch","openapi":"get /publishing-bootstrap/batch/{batchId}/diff","href":"/api-reference/publishing-bootstrap/get-publishing-bootstrap-batch-id-diff"},{"title":"Override a pending item before apply","openapi":"put /publishing-bootstrap/items/{id}","href":"/api-reference/publishing-bootstrap/put-publishing-bootstrap-items-id"},{"title":"Apply pending items — the only CWR write path","openapi":"post /publishing-bootstrap/apply","href":"/api-reference/publishing-bootstrap/post-publishing-bootstrap-apply"},{"title":"Reject pending items","openapi":"post /publishing-bootstrap/reject","href":"/api-reference/publishing-bootstrap/post-publishing-bootstrap-reject"}]},{"group":"Publishing Claims","pages":[{"title":"List claims for the tenant inbox","openapi":"get /publishing/claims","href":"/api-reference/publishing-claims/get-publishing-claims"},{"title":"Get a claim with its message thread","openapi":"get /publishing/claims/{id}","href":"/api-reference/publishing-claims/get-publishing-claims-id"},{"title":"Transition a claim's status","openapi":"patch /publishing/claims/{id}/status","href":"/api-reference/publishing-claims/patch-publishing-claims-id-status"},{"title":"Post a comment on a claim's thread","openapi":"post /publishing/claims/{id}/messages","href":"/api-reference/publishing-claims/post-publishing-claims-id-messages"},{"title":"Request a signed upload URL for claim evidence","openapi":"post /publishing/claims/{id}/evidence","href":"/api-reference/publishing-claims/post-publishing-claims-id-evidence"},{"title":"Register an uploaded evidence file on a claim","openapi":"post /publishing/claims/{id}/evidence/attach","href":"/api-reference/publishing-claims/post-publishing-claims-id-evidence-attach"},{"title":"Transition many claims to the same status in one call","openapi":"post /publishing/claims/bulk-resolve","href":"/api-reference/publishing-claims/post-publishing-claims-bulk-resolve"}]},{"group":"Release","pages":[{"title":"Get Releases","openapi":"get /releases","href":"/api-reference/release/get-releases"},{"title":"Create Release","openapi":"post /releases","href":"/api-reference/release/post-releases"},{"title":"Get Release Statistics","openapi":"get /releases/stats","href":"/api-reference/release/get-releases-stats"},{"title":"Get Release by ID","openapi":"get /releases/{id}","href":"/api-reference/release/get-releases-id"},{"title":"Update Release","openapi":"put /releases/{id}","href":"/api-reference/release/put-releases-id"},{"title":"Delete Release","openapi":"delete /releases/{id}","href":"/api-reference/release/delete-releases-id"},{"title":"Duplicate Release","openapi":"post /releases/{id}/duplicate","href":"/api-reference/release/post-releases-id-duplicate"},{"title":"Submit Release for Review","openapi":"post /releases/{id}/submit","href":"/api-reference/release/post-releases-id-submit"},{"title":"Review Release (Admin Only)","openapi":"post /releases/{id}/review","href":"/api-reference/release/post-releases-id-review"},{"title":"Add Feedback to Release","openapi":"post /releases/{id}/feedback","href":"/api-reference/release/post-releases-id-feedback"},{"title":"Revert Release Status (Admin Only)","openapi":"post /releases/{id}/revert-status","href":"/api-reference/release/post-releases-id-revert-status"},{"title":"Upload Media Files to Release","openapi":"post /releases/{id}/media/files","href":"/api-reference/release/post-releases-id-media-files"},{"title":"Submit Media Links to Release","openapi":"post /releases/{id}/media/links","href":"/api-reference/release/post-releases-id-media-links"},{"title":"Get Release Media","openapi":"get /releases/{id}/media","href":"/api-reference/release/get-releases-id-media"},{"title":"Delete Release Media","openapi":"delete /releases/{id}/media/{mediaId}","href":"/api-reference/release/delete-releases-id-media-id"},{"title":"Upload Media File to Track","openapi":"post /releases/{id}/tracks/{trackId}/media/file","href":"/api-reference/release/post-releases-id-tracks-id-media-file"},{"title":"Submit Media Link to Track","openapi":"post /releases/{id}/tracks/{trackId}/media/link","href":"/api-reference/release/post-releases-id-tracks-id-media-link"},{"title":"Get Track Media","openapi":"get /releases/{id}/tracks/{trackId}/media","href":"/api-reference/release/get-releases-id-tracks-id-media"},{"title":"Delete Track Media","openapi":"delete /releases/{id}/tracks/{trackId}/media/{mediaId}","href":"/api-reference/release/delete-releases-id-tracks-id-media-id"},{"title":"Create a new track (release asset)","openapi":"post /releases/{id}/tracks","href":"/api-reference/release/post-releases-id-tracks"},{"title":"Update a track (release asset)","openapi":"put /releases/{id}/tracks/{trackId}","href":"/api-reference/release/put-releases-id-tracks-id"},{"title":"Delete a track (release asset)","openapi":"delete /releases/{id}/tracks/{trackId}","href":"/api-reference/release/delete-releases-id-tracks-id"},{"title":"Reorder Release Tracks","openapi":"post /releases/{id}/tracks/reorder","href":"/api-reference/release/post-releases-id-tracks-reorder"},{"title":"Link Existing Asset to Release","openapi":"post /releases/{id}/tracks/link-asset","href":"/api-reference/release/post-releases-id-tracks-link-asset"}]},{"group":"Reports","pages":[{"title":"Get tenant-wide reporting defaults","openapi":"get /reports/settings","href":"/api-reference/reports/get-reports-settings"},{"title":"Update tenant-wide reporting defaults","openapi":"put /reports/settings","href":"/api-reference/reports/put-reports-settings"},{"title":"List reports","openapi":"get /reports","href":"/api-reference/reports/get-reports"},{"title":"Create a report draft","openapi":"post /reports","href":"/api-reference/reports/post-reports"},{"title":"Get a report","openapi":"get /reports/{id}","href":"/api-reference/reports/get-reports-id"},{"title":"Update a report's narrative overrides","openapi":"patch /reports/{id}/narrative","href":"/api-reference/reports/patch-reports-id-narrative"},{"title":"Recompute a report's data snapshot","openapi":"post /reports/{id}/refresh-data","href":"/api-reference/reports/post-reports-id-refresh-data"},{"title":"Finalize a report","openapi":"post /reports/{id}/finalize","href":"/api-reference/reports/post-reports-id-finalize"},{"title":"Download a report as PDF","openapi":"get /reports/{id}/pdf","href":"/api-reference/reports/get-reports-id-pdf"}]},{"group":"Revenue","pages":[{"title":"Get Revenues","openapi":"get /revenue/","href":"/api-reference/revenue/get-revenue"},{"title":"Create Revenue","openapi":"post /revenue/","href":"/api-reference/revenue/post-revenue"},{"title":"Create Bulk Revenues","openapi":"post /revenue/bulk","href":"/api-reference/revenue/post-revenue-bulk"},{"title":"Get Revenue Summary","openapi":"get /revenue/summary","href":"/api-reference/revenue/get-revenue-summary"},{"title":"Get Revenue","openapi":"get /revenue/{id}","href":"/api-reference/revenue/get-revenue-id"},{"title":"Update Revenue","openapi":"put /revenue/{id}","href":"/api-reference/revenue/put-revenue-id"},{"title":"Delete Revenue","openapi":"delete /revenue/{id}","href":"/api-reference/revenue/delete-revenue-id"},{"title":"Delete Bulk Revenues","openapi":"post /revenue/bulk/delete","href":"/api-reference/revenue/post-revenue-bulk-delete"}]},{"group":"Royalties","pages":[{"title":"Get Royalties Summary","openapi":"get /royalty/","href":"/api-reference/royalties/get-royalty"},{"title":"Get unallocated-revenue worklist","openapi":"get /royalty/unallocated","href":"/api-reference/royalties/get-royalty-unallocated"},{"title":"Get Royalties grouped by month (Accounting period)","openapi":"get /royalty/accountingperiod","href":"/api-reference/royalties/get-royalty-accountingperiod"},{"title":"Get Royalties grouped by month (Sale period)","openapi":"get /royalty/month","href":"/api-reference/royalties/get-royalty-month"},{"title":"Get Royalties grouped by DSP (Providers)","openapi":"get /royalty/dsp","href":"/api-reference/royalties/get-royalty-dsp"},{"title":"Get Royalties grouped by country","openapi":"get /royalty/country","href":"/api-reference/royalties/get-royalty-country"},{"title":"Get Royalties grouped by artist","openapi":"get /royalty/artist","href":"/api-reference/royalties/get-royalty-artist"},{"title":"Get Royalties grouped by product","openapi":"get /royalty/product","href":"/api-reference/royalties/get-royalty-product"},{"title":"Get Royalties grouped by asset","openapi":"get /royalty/asset","href":"/api-reference/royalties/get-royalty-asset"},{"title":"Get Royalties grouped by table source","openapi":"get /royalty/tables","href":"/api-reference/royalties/get-royalty-tables"},{"title":"Get Royalties grouped by sale type","openapi":"get /royalty/saletype","href":"/api-reference/royalties/get-royalty-saletype"},{"title":"Get Royalties grouped by aggregator","openapi":"get /royalty/aggregator","href":"/api-reference/royalties/get-royalty-aggregator"},{"title":"Get top gainers and losers vs the previous period","openapi":"get /royalty/top-movers","href":"/api-reference/royalties/get-royalty-top-movers"},{"title":"Get a month/quarter x dimension crosstab","openapi":"get /royalty/crosstab","href":"/api-reference/royalties/get-royalty-crosstab"},{"title":"Get a sale-month x accounting-month royalty matrix","openapi":"get /royalty/period-matrix","href":"/api-reference/royalties/get-royalty-period-matrix"},{"title":"Get a track's royalty lifecycle since release","openapi":"get /royalty/lifecycle","href":"/api-reference/royalties/get-royalty-lifecycle"},{"title":"Get the unified master + publishing + neighbouring-rights view","openapi":"get /royalty/consolidated","href":"/api-reference/royalties/get-royalty-consolidated"},{"title":"List the caller's saved analytics views","openapi":"get /royalty/saved-views","href":"/api-reference/royalties/get-royalty-saved-views"},{"title":"Create a saved analytics view","openapi":"post /royalty/saved-views","href":"/api-reference/royalties/post-royalty-saved-views"},{"title":"Reorder the caller's saved analytics views","openapi":"patch /royalty/saved-views/reorder","href":"/api-reference/royalties/patch-royalty-saved-views-reorder"},{"title":"Update a saved analytics view","openapi":"patch /royalty/saved-views/{id}","href":"/api-reference/royalties/patch-royalty-saved-views-id"},{"title":"Delete a saved analytics view","openapi":"delete /royalty/saved-views/{id}","href":"/api-reference/royalties/delete-royalty-saved-views-id"}]},{"group":"Search","pages":[{"title":"Global search across all entities","openapi":"get /search","href":"/api-reference/search/global-search"},{"title":"Get recent searches","openapi":"get /search/recent","href":"/api-reference/search/get-recent-searches"},{"title":"Clear recent searches","openapi":"delete /search/recent","href":"/api-reference/search/clear-recent-searches"}]},{"group":"Source Creator","pages":[{"title":"Step 1 — Upload and analyze a sample file","openapi":"post /source-creator/analyze","href":"/api-reference/source-creator/post-source-creator-analyze"},{"title":"Step 1b — Set the DataClass for a session","openapi":"put /source-creator/sessions/{id}/data-class","href":"/api-reference/source-creator/put-source-creator-sessions-id-data-class"},{"title":"Step 2 — Get AI column-mapping suggestions","openapi":"post /source-creator/ai-map-columns","href":"/api-reference/source-creator/post-source-creator-ai-map-columns"},{"title":"Step 2b — Save user-confirmed column mappings","openapi":"put /source-creator/sessions/{id}/mappings","href":"/api-reference/source-creator/put-source-creator-sessions-id-mappings"},{"title":"Confirm accounting/sale periods for a session","openapi":"put /source-creator/sessions/{id}/periods","href":"/api-reference/source-creator/put-source-creator-sessions-id-periods"},{"title":"Step 3 — Generate BigQuery SQL from confirmed mappings","openapi":"post /source-creator/generate-queries","href":"/api-reference/source-creator/post-source-creator-generate-queries"},{"title":"Step 4 — Test generated queries in the BigQuery sandbox","openapi":"post /source-creator/test-queries","href":"/api-reference/source-creator/post-source-creator-test-queries"},{"title":"Step 5 — Save as a draft RoyaltySource","openapi":"post /source-creator/save","href":"/api-reference/source-creator/post-source-creator-save"},{"title":"Reuse an existing source without the full wizard","openapi":"post /source-creator/reuse","href":"/api-reference/source-creator/post-source-creator-reuse"},{"title":"Get an existing source's column mappings for pre-filling the wizard","openapi":"get /source-creator/sources/{id}/mappings","href":"/api-reference/source-creator/get-source-creator-sources-id-mappings"},{"title":"Get an existing source's queries for copy \u0026 modify versioning","openapi":"get /source-creator/sources/{id}/queries","href":"/api-reference/source-creator/get-source-creator-sources-id-queries"},{"title":"Get a smart source-name suggestion based on mapped data","openapi":"post /source-creator/sessions/{id}/suggest-name","href":"/api-reference/source-creator/post-source-creator-sessions-id-suggest-name"},{"title":"List the caller's active wizard sessions","openapi":"get /source-creator/sessions","href":"/api-reference/source-creator/get-source-creator-sessions"},{"title":"Get full session state for resuming the wizard","openapi":"get /source-creator/sessions/{id}","href":"/api-reference/source-creator/get-source-creator-sessions-id"},{"title":"Delete a wizard session","openapi":"delete /source-creator/sessions/{id}","href":"/api-reference/source-creator/delete-source-creator-sessions-id"},{"title":"Re-parse the session's file with a different header-row count","openapi":"patch /source-creator/sessions/{id}/header-rows","href":"/api-reference/source-creator/patch-source-creator-sessions-id-header-rows"}]},{"group":"Sources","pages":[{"title":"List All Royalty Sources (Admin)","openapi":"get /sources/admin","href":"/api-reference/sources/get-sources-admin"},{"title":"Create Royalty Source (Admin)","openapi":"post /sources/admin","href":"/api-reference/sources/post-sources-admin"},{"title":"Get Royalty Source by ID (Admin)","openapi":"get /sources/admin/{id}","href":"/api-reference/sources/get-sources-admin-id"},{"title":"Update Royalty Source (Admin)","openapi":"put /sources/admin/{id}","href":"/api-reference/sources/put-sources-admin-id"},{"title":"Delete Royalty Source (Admin)","openapi":"delete /sources/admin/{id}","href":"/api-reference/sources/delete-sources-admin-id"},{"title":"List Tenant Sources","openapi":"get /sources","href":"/api-reference/sources/get-sources"},{"title":"Add Tenant Source","openapi":"post /sources","href":"/api-reference/sources/post-sources"},{"title":"Get Tenant Source by RoyaltySource ID","openapi":"get /sources/{id}","href":"/api-reference/sources/get-sources-id"},{"title":"Update Tenant Source by RoyaltySource ID","openapi":"put /sources/{id}","href":"/api-reference/sources/put-sources-id"},{"title":"Remove Tenant Source by RoyaltySource ID","openapi":"delete /sources/{id}","href":"/api-reference/sources/delete-sources-id"},{"title":"Activate Tenant Source by RoyaltySource ID","openapi":"post /sources/{id}/activate","href":"/api-reference/sources/post-sources-id-activate"},{"title":"Deactivate Tenant Source by RoyaltySource ID","openapi":"post /sources/{id}/deactivate","href":"/api-reference/sources/post-sources-id-deactivate"}]},{"group":"Splits","pages":[{"title":"Get splits","openapi":"get /split/","href":"/api-reference/splits/get-split"},{"title":"Create split","openapi":"post /split/","href":"/api-reference/splits/post-split"},{"title":"Get Split Summary","openapi":"get /split/summary","href":"/api-reference/splits/get-split-summary"},{"title":"Create Default Splits","openapi":"post /split/default","href":"/api-reference/splits/post-split-default"},{"title":"Bulk delete Splits","openapi":"post /split/bulk/delete","href":"/api-reference/splits/post-split-bulk-delete"},{"title":"Bulk delete catalog splits","openapi":"delete /split/bulk/catalog-splits","href":"/api-reference/splits/delete-split-bulk-catalog-splits"},{"title":"Match Splits","openapi":"post /split/match","href":"/api-reference/splits/post-split-match"},{"title":"Get Split","openapi":"get /split/{id}","href":"/api-reference/splits/get-split-id"},{"title":"Update Split","openapi":"put /split/{id}","href":"/api-reference/splits/put-split-id"},{"title":"Delete Split","openapi":"delete /split/{id}","href":"/api-reference/splits/delete-split-id"}]},{"group":"Statements","pages":[{"title":"Cross-publisher statements list","openapi":"get /statements/publisher","href":"/api-reference/statements/get-statements-publisher"},{"title":"Get statements roster","openapi":"get /statements","href":"/api-reference/statements/get-statements"},{"title":"Export statements roster as CSV","openapi":"get /statements/export","href":"/api-reference/statements/get-statements-export"},{"title":"Pending-close summary","openapi":"get /statements/periods/pending-close","href":"/api-reference/statements/get-statements-periods-pending-close"},{"title":"Publish closed-period statements to members","openapi":"post /statements/periods/notify","href":"/api-reference/statements/post-statements-periods-notify"},{"title":"Close a finalized statement period","openapi":"post /statements/periods/close","href":"/api-reference/statements/post-statements-periods-close"},{"title":"Get user statements timeline","openapi":"get /statements/users/{tenantUserId}","href":"/api-reference/statements/get-statements-users-id"},{"title":"Get statement detail for a user + period","openapi":"get /statements/users/{tenantUserId}/{periodStart}/{periodEnd}","href":"/api-reference/statements/get-statements-users-id-id-id"},{"title":"Download statement as PDF","openapi":"get /statements/users/{tenantUserId}/{periodStart}/{periodEnd}/pdf","href":"/api-reference/statements/get-statements-users-id-id-id-pdf"},{"title":"Finalize a statement","openapi":"post /statements/users/{tenantUserId}/{periodStart}/{periodEnd}/finalize","href":"/api-reference/statements/post-statements-users-id-id-id-finalize"},{"title":"Record a payment against a statement","openapi":"post /statements/users/{tenantUserId}/{periodStart}/{periodEnd}/payments","href":"/api-reference/statements/post-statements-users-id-id-id-payments"},{"title":"Post an adjustment against a statement","openapi":"post /statements/users/{tenantUserId}/{periodStart}/{periodEnd}/adjustments","href":"/api-reference/statements/post-statements-users-id-id-id-adjustments"},{"title":"Place a statement on hold","openapi":"post /statements/users/{tenantUserId}/{periodStart}/{periodEnd}/hold","href":"/api-reference/statements/post-statements-users-id-id-id-hold"},{"title":"Resume a held statement","openapi":"post /statements/users/{tenantUserId}/{periodStart}/{periodEnd}/resume","href":"/api-reference/statements/post-statements-users-id-id-id-resume"},{"title":"Void a statement","openapi":"post /statements/users/{tenantUserId}/{periodStart}/{periodEnd}/void","href":"/api-reference/statements/post-statements-users-id-id-id-void"},{"title":"Raise a dispute against a statement","openapi":"post /statements/users/{tenantUserId}/{periodStart}/{periodEnd}/disputes","href":"/api-reference/statements/post-statements-users-id-id-id-disputes"}]},{"group":"User","pages":[{"title":"Get Users","openapi":"get /user/","href":"/api-reference/user/get-user"},{"title":"Create User","openapi":"post /user/","href":"/api-reference/user/post-user"},{"title":"List workspace invites","openapi":"get /user/invites","href":"/api-reference/user/get-user-invites"},{"title":"Resend workspace invite","openapi":"post /user/invites/{inviteId}/resend","href":"/api-reference/user/post-user-invites-id-resend"},{"title":"Cancel workspace invite","openapi":"post /user/invites/{inviteId}/cancel","href":"/api-reference/user/post-user-invites-id-cancel"},{"title":"Create Bulk User","openapi":"post /user/bulk","href":"/api-reference/user/post-user-bulk"},{"title":"Get User Summary","openapi":"get /user/summary","href":"/api-reference/user/get-user-summary"},{"title":"Get User","openapi":"get /user/{id}","href":"/api-reference/user/get-user-id"},{"title":"Update User","openapi":"patch /user/{id}","href":"/api-reference/user/patch-user-id"},{"title":"Delete User","openapi":"delete /user/{id}","href":"/api-reference/user/delete-user-id"},{"title":"Add User to Tenant","openapi":"put /user/{id}/aut","href":"/api-reference/user/put-user-id-aut"},{"title":"Get User Stats","openapi":"get /user/{id}/stats","href":"/api-reference/user/get-user-id-stats"},{"title":"Get User Monthly Stats","openapi":"get /user/{id}/monthly","href":"/api-reference/user/get-user-id-monthly"},{"title":"Get User Artists","openapi":"get /user/{id}/artists","href":"/api-reference/user/get-user-id-artists"},{"title":"Get User Assets","openapi":"get /user/{id}/assets","href":"/api-reference/user/get-user-id-assets"},{"title":"Get User Products","openapi":"get /user/{id}/products","href":"/api-reference/user/get-user-id-products"},{"title":"Download User Data","openapi":"post /user/download/csv","href":"/api-reference/user/post-user-download-csv"},{"title":"Bulk Delete Users","openapi":"post /user/bulk/delete","href":"/api-reference/user/post-user-bulk-delete"},{"title":"Remove User Email","openapi":"delete /user/{id}/email/{email}","href":"/api-reference/user/delete-user-id-email-id"},{"title":"Create Bulk Entity","openapi":"post /user/bulk/entity","href":"/api-reference/user/post-user-bulk-entity"}]},{"group":"Vertofx","pages":[{"title":"Get Verto Wallets","openapi":"get /integrations/vertofx/wallets","href":"/api-reference/vertofx/get-integrations-vertofx-wallets"},{"title":"Get Beneficiaries List","openapi":"get /integrations/vertofx/beneficiaries","href":"/api-reference/vertofx/get-integrations-vertofx-beneficiaries"},{"title":"Create Beneficiary","openapi":"post /integrations/vertofx/beneficiaries","href":"/api-reference/vertofx/post-integrations-vertofx-beneficiaries"},{"title":"Get Beneficiary Details","openapi":"get /integrations/vertofx/beneficiaries/{id}","href":"/api-reference/vertofx/get-integrations-vertofx-beneficiaries-id"},{"title":"Update VertoFx Beneficiary","openapi":"put /integrations/vertofx/beneficiaries/{id}","href":"/api-reference/vertofx/put-integrations-vertofx-beneficiaries-id"},{"title":"Delete VertoFx Beneficiary","openapi":"delete /integrations/vertofx/beneficiaries/{id}","href":"/api-reference/vertofx/delete-integrations-vertofx-beneficiaries-id"},{"title":"Get VertoFx Purpose Codes","openapi":"get /integrations/vertofx/purpose-codes","href":"/api-reference/vertofx/get-integrations-vertofx-purpose-codes"},{"title":"Create VertoFx Payment Request (v2)","openapi":"post /integrations/vertofx/payment-requests/v2","href":"/api-reference/vertofx/post-integrations-vertofx-payment-requests-v2"},{"title":"Link Verto Beneficiary to User","openapi":"post /integrations/vertofx/beneficiaries/link","href":"/api-reference/vertofx/post-integrations-vertofx-beneficiaries-link"},{"title":"Unlink Verto Beneficiary From User","openapi":"delete /integrations/vertofx/beneficiaries/{beneficiaryId}/unlink","href":"/api-reference/vertofx/delete-integrations-vertofx-beneficiaries-id-unlink"},{"title":"Get VertoFx Payment Requests","openapi":"get /integrations/vertofx/payment-requests","href":"/api-reference/vertofx/get-integrations-vertofx-payment-requests"},{"title":"Create VertoFx Payment Request","openapi":"post /integrations/vertofx/payment-requests","href":"/api-reference/vertofx/post-integrations-vertofx-payment-requests"},{"title":"Get VertoFx Payment Request Details","openapi":"get /integrations/vertofx/payment-requests/{id}","href":"/api-reference/vertofx/get-integrations-vertofx-payment-requests-id"}]},{"group":"Webhook Config","pages":[{"title":"List tenant settings (optionally assembled as webhook config)","openapi":"get /tenant/settings","href":"/api-reference/webhook-config/get-tenant-settings"},{"title":"Get a single tenant setting","openapi":"get /tenant/settings/{name}","href":"/api-reference/webhook-config/get-tenant-setting"},{"title":"Create or update a tenant setting","openapi":"put /tenant/settings/{name}","href":"/api-reference/webhook-config/update-tenant-setting"},{"title":"Delete a tenant setting","openapi":"delete /tenant/settings/{name}","href":"/api-reference/webhook-config/delete-tenant-setting"}]},{"group":"Webhook Deliveries","pages":[{"title":"Get webhook deliveries","openapi":"get /webhook-deliveries","href":"/api-reference/webhook-deliveries/get-webhook-deliveries"},{"title":"Get webhook delivery summary","openapi":"get /webhook-deliveries/summary","href":"/api-reference/webhook-deliveries/get-webhook-delivery-summary"},{"title":"Get webhook delivery statistics","openapi":"get /webhook-deliveries/stats","href":"/api-reference/webhook-deliveries/get-webhook-delivery-stats"},{"title":"Get webhook delivery details","openapi":"get /webhook-deliveries/{id}","href":"/api-reference/webhook-deliveries/get-webhook-delivery-by-id"},{"title":"Retry webhook delivery","openapi":"post /webhook-deliveries/{id}/retry","href":"/api-reference/webhook-deliveries/retry-webhook-delivery"}]},{"group":"Webhooks","pages":[{"title":"Paystack transfer \u0026 payment events webhook","openapi":"post /paystack/webhook","href":"/api-reference/webhooks/post-paystack-webhook"},{"title":"Stripe billing events webhook","openapi":"post /stripe/webhook","href":"/api-reference/webhooks/post-stripe-webhook"}]},{"group":"Websocket Events","pages":[{"title":"WebSocket Connection Information","openapi":"get /websocket","href":"/api-reference/websocket-events/get-websocket"}]},{"group":"White Label","pages":[{"title":"Get the tenant's brand tokens","openapi":"get /tenant/branding","href":"/api-reference/white-label/get-tenant-branding"},{"title":"Update the tenant's brand tokens","openapi":"put /tenant/branding","href":"/api-reference/white-label/put-tenant-branding"},{"title":"Connect a custom domain to the tenant's workspace","openapi":"post /domains/setup","href":"/api-reference/white-label/post-domains-setup"},{"title":"Get live validation/SSL status for the tenant's custom domain","openapi":"get /domains/status","href":"/api-reference/white-label/get-domains-status"},{"title":"Get step-by-step setup/validation instructions for the tenant's custom domain","openapi":"get /domains/instructions","href":"/api-reference/white-label/get-domains-instructions"},{"title":"Switch the validation method for the tenant's custom domain","openapi":"post /domains/switch-validation","href":"/api-reference/white-label/post-domains-switch-validation"},{"title":"Remove the tenant's custom domain","openapi":"delete /domains","href":"/api-reference/white-label/delete-domains"},{"title":"Restart validation for the tenant's custom domain","openapi":"post /domains/restart-validation","href":"/api-reference/white-label/post-domains-restart-validation"},{"title":"List all tenants' custom domains (platform admin)","openapi":"get /domains/all","href":"/api-reference/white-label/get-domains-all"},{"title":"Get the tenant's email sending domain configuration","openapi":"get /tenant/email-domain","href":"/api-reference/white-label/get-tenant-email-domain"},{"title":"Register a new email sending domain for the tenant","openapi":"post /tenant/email-domain","href":"/api-reference/white-label/post-tenant-email-domain"},{"title":"Delete the tenant's email sending domain","openapi":"delete /tenant/email-domain","href":"/api-reference/white-label/delete-tenant-email-domain"},{"title":"Trigger a verification check for the tenant's email domain","openapi":"post /tenant/email-domain/verify","href":"/api-reference/white-label/post-tenant-email-domain-verify"},{"title":"Get the tenant's email sender configuration and domain status","openapi":"get /tenant/email-settings","href":"/api-reference/white-label/get-tenant-email-settings"},{"title":"Update the tenant's email sender configuration","openapi":"put /tenant/email-settings","href":"/api-reference/white-label/put-tenant-email-settings"},{"title":"List available email templates","openapi":"get /email-templates","href":"/api-reference/white-label/get-email-templates"},{"title":"Get the tenant's resolved email branding settings","openapi":"get /email-templates/branding","href":"/api-reference/white-label/get-email-templates-branding"},{"title":"Preview a rendered email template with sample data and tenant branding","openapi":"get /email-templates/{templateName}/preview","href":"/api-reference/white-label/get-email-templates-id-preview"},{"title":"Send a test email using the specified template and tenant branding","openapi":"post /email-templates/{templateName}/test","href":"/api-reference/white-label/post-email-templates-id-test"}]},{"group":"Works","pages":[{"title":"List works","openapi":"get /work/works","href":"/api-reference/works/get-work-works"},{"title":"Create a work","openapi":"post /work/works","href":"/api-reference/works/post-work-works"},{"title":"Get a work by ID","openapi":"get /work/works/{id}","href":"/api-reference/works/get-work-works-id"},{"title":"Update a work","openapi":"put /work/works/{id}","href":"/api-reference/works/put-work-works-id"},{"title":"Delete a work","openapi":"delete /work/works/{id}","href":"/api-reference/works/delete-work-works-id"},{"title":"Replace a work's writer splits","openapi":"put /work/works/{id}/writers","href":"/api-reference/works/put-work-works-id-writers"},{"title":"List work-writer relationships","openapi":"get /work/work-writers","href":"/api-reference/works/get-work-work-writers"},{"title":"List all registrations","openapi":"get /work/registrations","href":"/api-reference/works/get-work-registrations"},{"title":"Create or update a CWR registration","openapi":"post /work/registrations","href":"/api-reference/works/post-work-registrations"},{"title":"Registration summary statistics","openapi":"get /work/registrations/summary","href":"/api-reference/works/get-work-registrations-summary"},{"title":"Get a registration by ID","openapi":"get /work/registrations/{id}","href":"/api-reference/works/get-work-registrations-id"},{"title":"Delete a registration","openapi":"delete /work/registrations/{id}","href":"/api-reference/works/delete-work-registrations-id"},{"title":"Update registration status","openapi":"patch /work/registrations/{id}/status","href":"/api-reference/works/patch-work-registrations-id-status"},{"title":"Queue a registration for PRO submission","openapi":"post /work/registrations/{id}/queue","href":"/api-reference/works/post-work-registrations-id-queue"},{"title":"Queue multiple registrations for PRO submission","openapi":"post /work/registrations/queue-batch","href":"/api-reference/works/post-work-registrations-queue-batch"},{"title":"Requeue a dead-lettered registration","openapi":"post /work/registrations/{id}/requeue","href":"/api-reference/works/post-work-registrations-id-requeue"},{"title":"Requeue multiple dead-lettered registrations","openapi":"post /work/registrations/requeue-batch","href":"/api-reference/works/post-work-registrations-requeue-batch"},{"title":"Get registration status (lightweight)","openapi":"get /work/registrations/status/{registrationId}","href":"/api-reference/works/get-work-registrations-status-id"},{"title":"List conflicts for a registration","openapi":"get /work/registrations/{id}/conflicts","href":"/api-reference/works/get-work-registrations-id-conflicts"},{"title":"Resolve (or update) a registration conflict","openapi":"post /work/registrations/{id}/conflicts/{conflictId}/resolve","href":"/api-reference/works/post-work-registrations-id-conflicts-id-resolve"},{"title":"List registrations for a specific work","openapi":"get /work/{workId}/registrations","href":"/api-reference/works/get-work-id-registrations"},{"title":"List claims filed on a work","openapi":"get /work/works/{workId}/claims","href":"/api-reference/works/get-work-works-id-claims"},{"title":"File an ownership/share claim on a work","openapi":"post /work/works/{workId}/claims","href":"/api-reference/works/post-work-works-id-claims"},{"title":"Link a work to a recording","openapi":"post /work/{workId}/recordings/{assetId}","href":"/api-reference/works/post-work-id-recordings-id"},{"title":"Unlink a recording from a work","openapi":"delete /work/{workId}/recordings/{assetId}","href":"/api-reference/works/delete-work-id-recordings-id"},{"title":"List recordings linked to a work","openapi":"get /work/{workId}/recordings","href":"/api-reference/works/get-work-id-recordings"},{"title":"Set the primary recording for a work","openapi":"post /work/{workId}/recordings/{assetId}/primary","href":"/api-reference/works/post-work-id-recordings-id-primary"},{"title":"Get the primary recording for a work","openapi":"get /work/{workId}/recordings/primary","href":"/api-reference/works/get-work-id-recordings-primary"},{"title":"List works linked to a recording","openapi":"get /work/recordings/{assetId}/works","href":"/api-reference/works/get-work-recordings-id-works"}]},{"group":"Writers","pages":[{"title":"List writers","openapi":"get /writer/writers","href":"/api-reference/writers/get-writer-writers"},{"title":"Create a writer","openapi":"post /writer/writers","href":"/api-reference/writers/post-writer-writers"},{"title":"Get a writer, including associated works","openapi":"get /writer/writers/{id}","href":"/api-reference/writers/get-writer-writers-id"},{"title":"Update a writer","openapi":"put /writer/writers/{id}","href":"/api-reference/writers/put-writer-writers-id"},{"title":"Delete a writer","openapi":"delete /writer/writers/{id}","href":"/api-reference/writers/delete-writer-writers-id"},{"title":"Get AllTrack creator affiliation status for writer","openapi":"get /writer/{id}/alltrack/affiliation","href":"/api-reference/writers/get-writer-id-alltrack-affiliation"},{"title":"Submit AllTrack creator affiliation registration","openapi":"post /writer/{id}/alltrack/affiliation","href":"/api-reference/writers/post-writer-id-alltrack-affiliation"},{"title":"Get a workspace user's AllTrack affiliation","openapi":"get /writer/by-user/{tenantUserId}/alltrack/affiliation","href":"/api-reference/writers/get-writer-by-user-id-alltrack-affiliation"},{"title":"Submit an AllTrack affiliation for a workspace user","openapi":"post /writer/by-user/{tenantUserId}/alltrack/affiliation","href":"/api-reference/writers/post-writer-by-user-id-alltrack-affiliation"},{"title":"Associate a writer with a work","openapi":"post /writer/writers/{writerId}/works/{workId}","href":"/api-reference/writers/post-writer-writers-id-works-id"},{"title":"Remove a writer from a work","openapi":"delete /writer/writers/{writerId}/works/{workId}","href":"/api-reference/writers/delete-writer-writers-id-works-id"},{"title":"List all writers with linked user data merged in","openapi":"get /writer/writers-with-user-data","href":"/api-reference/writers/get-writer-writers-with-user-data"}]}]},"basePath":"","title":"Update Asset DDEX Metadata - Royalti.io API","buildId":"dpl_42LwxxU1kGN114H4XzwGYXa9ZDah","deploymentId":"dpl_42LwxxU1kGN114H4XzwGYXa9ZDah","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-C-hEh3I2.js","utils-CnF4QiUD.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-C7PVNbel.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-8ytevL2A.js","snippetPresets-BT1alx3v.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","conditional-requirements-CFM0id0Q.js","ApiExamples-BLXC0i_W.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-CyLIGI9_.js","shallow-DC0lGVIW.js","getApiPlaygroundDisplay-CgDQ85tN.js","CodeSnippet-6-I-Gpv9.js","CodeSnippets-BAk1kDdu.js","Page-C945cI-W.js","getPastedJson-B276RuWN.js","icon-BqP8etTm.js","MethodPill-DM6sbxG1.js","DuplicateIcon-PyJglOaE.js","createIcon-CMeOMAc_.js","DynamicMarkdown-BoyYAA8K.js","SectionHeading-DAYv3gvZ.js","axios-vUo_bRtp.js","Markdown-BhTTmazV.js","clsx-CR-RHrVC.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-CBUH0-zX.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-BmARFYNC.js"]}