Skip to main content
POST
/
defaultsettings
/
templates
Create Template
curl --request POST \
  --url https://api.royalti.io/defaultsettings/templates \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "name": "Hip-Hop Album Defaults",
  "description": "Standard settings for hip-hop album releases",
  "category": "content",
  "entityType": "release",
  "settings": {
    "content": {
      "type": "Audio",
      "format": "Album",
      "mainGenre": [
        "Hip-Hop",
        "Rap"
      ],
      "explicit": "explicit",
      "language": "en"
    }
  },
  "isPublic": true,
  "tags": [
    "hip-hop",
    "album",
    "explicit"
  ]
}'
{
  "success": true,
  "message": "Template created successfully",
  "data": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "name": "<string>",
    "description": "<string>",
    "category": "content",
    "entityType": "catalog",
    "settings": {
      "content": {
        "type": "Audio",
        "format": "Single",
        "version": "<string>",
        "explicit": "explicit",
        "language": "<string>",
        "mainGenre": [
          "<string>"
        ],
        "subGenre": [
          "<string>"
        ],
        "contributors": {}
      },
      "business": {
        "label": "<string>",
        "copyright": "<string>",
        "publisher": "<string>",
        "copyrightOwner": "<string>",
        "distribution": "<string>",
        "status": "Live"
      },
      "ddex": {
        "enableDDEX": true,
        "labelName": "<string>",
        "resourceReference": "<string>",
        "grid": "<string>",
        "icpn": "<string>"
      },
      "validation": {
        "requireGenre": true,
        "requireLyrics": true,
        "requireDescription": true,
        "minimumTrackCount": 1,
        "maximumTrackCount": 2
      }
    },
    "isPublic": true,
    "isSystem": false,
    "usageCount": 0,
    "tags": [
      "<string>"
    ],
    "createdBy": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "createdAt": "2023-11-07T05:31:56Z",
    "updatedAt": "2023-11-07T05:31:56Z"
  }
}

​
Description

POST /defaultsettings/templates Description: Create a new reusable template for default settings. Method: POST Request Body:
ParameterTypeDescriptionRequired
namestringTemplate nameYes
descriptionstringTemplate descriptionNo
categorystringSettings categoryYes
entityTypestringTarget entity typeYes
settingsobjectTemplate settingsYes
isPublicbooleanPublic visibility (default: true)No
tagsarrayTags for categorizationNo

​
Code Examples

const response = await fetch('https://api.royalti.io/defaultsettings/templates', {
  method: 'POST',
  headers: {
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    "name": "sample-name",
    "description": "sample-description",
    "category": "sample-category",
    "entityType": "sample-entityType",
    "isPublic": true,
    "tags": [
      {}
    ]
  })
});

const data = await response.json();
console.log(data);

Authorizations

​
Authorization
string
header
required

JWT Authorization header using the Bearer scheme. Format: "Bearer {token}"

Body

application/json
​
name
string
required

Template name

​
category
enum<string>
required
Available options:
content,
business,
ddex,
validation
​
entityType
enum<string>
required
Available options:
catalog,
asset,
product,
release
​
settings
object
required

The actual settings data organized by category

​
description
string

Template description

​
isPublic
boolean
default:true
​
tags
string[]

Response

Template created successfully

​
success
boolean
Example:

true

​
message
string
Example:

"Template created successfully"

​
data
object

A reusable template for default settings