Skip to main content
POST
/
user
/
bulk
/
entity
Create Bulk Entity
curl --request POST \
  --url https://api.royalti.io/user/bulk/entity \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "data": [
    {
      "artistName": "<string>",
      "firstName": "<string>",
      "lastName": "<string>",
      "email": "[email protected]",
      "splitShare": 123
    }
  ],
  "sendEmail": true,
  "redirect_url": "<string>"
}
'
{
  "message": "Bulk entity creation completed.",
  "createdEntities": [
    {
      "artistName": "Melodic Harmony",
      "userName": "Emma Johnson"
    }
  ],
  "processedCount": 1,
  "errors": [
    "Invalid email format for Michael Chen",
    "Invalid split share percentage for Sonic Wave"
  ]
}
This endpoint requires authentication. Include your Bearer token in the Authorization header.

​
Description

/user/bulk/entity Description:
The /user/bulk/entity endpoint allows the creation of multiple entities in bulk by providing details for each entity, including artist name, first name, last name, email, and split share. Method:
POST Request Payload:
ParameterTypeDescription
dataarrayAn array of entity objects with their details.
sendEmailbooleanThis sends an invite email to the entities, by default it is true.
redirect_url (Optional)stringThe URL to redirect after creation.

​
Code Examples

const response = await fetch('https://api.royalti.io/user/bulk/entity', {
  method: 'POST',
  headers: {
    'Authorization': `Bearer ${token}`,
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    "data": [
      {
        "artistName": "sample-artistName",
        "firstName": "sample-firstName",
        "lastName": "sample-lastName",
        "email": "sample-email",
        "splitShare": 1
      }
    ],
    "sendEmail": true,
    "redirect_url": "sample-redirect_url"
  })
});

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
​
data
object[]
required
​
sendEmail
boolean
default:true

This sends an invite email to the entities

​
redirect_url
string

The URL to redirect after creation

Response

Success - Bulk entity creation completed

​
message
string
​
createdEntities
object[]
​
processedCount
integer
​
errors
string[]