Skip to main content
POST
/
defaultsettings
/
templates
/
{templateId}
/
apply
Apply Template
curl --request POST \
  --url https://api.royalti.io/defaultsettings/templates/{templateId}/apply \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "entityType": "artist",
  "entityId": "660e8400-e29b-41d4-a716-446655440001"
}'
{
  "success": true,
  "message": "Template applied successfully",
  "data": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "TenantId": 123,
    "entityType": "tenant",
    "entityId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "category": "content",
    "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
      }
    },
    "isActive": true,
    "priority": 0,
    "createdAt": "2023-11-07T05:31:56Z",
    "updatedAt": "2023-11-07T05:31:56Z"
  }
}

​
Description

POST /defaultsettings/templates//apply Description: Apply a template to create a new default setting for an entity. This increments the template’s usage count. Method: POST Path Parameters:
ParameterTypeDescriptionRequired
templateIduuidID of template to applyYes
Request Body:
ParameterTypeDescriptionRequired
entityTypestringTarget entity typeYes
entityIduuidTarget entity ID (optional for tenant/catalog)Conditional

​
Code Examples

const response = await fetch('https://api.royalti.io/defaultsettings/templates/example-id/apply', {
  method: 'POST',
  headers: {
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    "entityType": "sample-entityType",
    "entityId": "sample-entityId"
  })
});

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

Authorizations

​
Authorization
string
header
required

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

Path Parameters

​
templateId
string<uuid>
required

ID of the template to apply

Body

application/json
​
entityType
enum<string>
required
Available options:
tenant,
label,
artist,
user,
catalog
​
entityId
string<uuid>

Response

Template applied successfully

​
success
boolean
Example:

true

​
message
string
Example:

"Template applied successfully"

​
data
object

A default setting entry