The
/user/
endpoint allows the creation of a single user by providing their details, such as first name, last name, nickname, user type, and email address.
Method:POST
Request Payload:
Parameter | Type | Description |
---|---|---|
firstName | string | The first name of the user. |
lastName | string | The last name of the user. |
nickName | string | The nickname of the user. |
userType | string | The type of user (e.g., Artist, Manager). |
string | The email address of the user. | |
ipi (Optional) | string | The IPI (Interested Parties Information) of the user. |
role | string | The role of the user in the workspace |
phone (Optional) | string | The user’s phone number. |
country (Optional) | string | The user’s country. |
sendEmail (Optional) | boolean | This sends an invite email to the user, by default it is true. |
redirect_url (Optional) | string | The URL to redirect the user to after the creation. |
message (Optional) | string | For passing the invite email custom message. |
Authentication
This endpoint requires authentication. Include your bearer token in the Authorization header.Request Body
Request Schema
Field | Type | Required | Description |
---|---|---|---|
firstName | string | ✅ | The first name of the user |
lastName | string | ✅ | The last name of the user |
nickName | string | ✅ | The nickname of the user |
userType | string | ✅ | The type of user (e.g., Artist, Manager) |
email | string | ✅ | The email address of the user |
ipi | string | ❌ | The IPI (Interested Parties Information) of the user |
role | string | ✅ | The role of the user in the workspace |
phone | string | ❌ | The user’s phone number |
country | string | ❌ | The user’s country |
sendEmail | boolean | ❌ | This sends an invite email to the user, by default it is true |
redirect_url | string | ❌ | The URL to redirect the user to after the creation |
message | string | ❌ | For passing the invite email custom message |
Responses
✅ 201 - Success
⚠️ 400 - Error - Prior Email Association with workspace
⚠️ 401 - Unauthorized
⚠️ 404 - Not Found
❌ 500 - Internal Server Error
Tags
User
Authorizations
JWT Authorization header using the Bearer scheme. Format: "Bearer {token}"
Body
application/json
The first name of the user
The last name of the user
The nickname of the user
The type of user (e.g., Artist, Manager)
The email address of the user
The role of the user in the workspace
The IPI (Interested Parties Information) of the user
The user's phone number
The user's country
This sends an invite email to the user, by default it is true
The URL to redirect the user to after the creation
For passing the invite email custom message