> ## Documentation Index
> Fetch the complete documentation index at: https://apidocs.royalti.io/llms.txt
> Use this file to discover all available pages before exploring further.
# Update User
> **/user/{userId}**
This endpoint requires authentication. Include your Bearer token in the Authorization header.
## Description
**/user/{userId}**
**Description:**\
The `/user/{userId}` endpoint allows updating the details of a specific user identified by their unique userId.
**Method:**\
`PATCH`
**Request Payload:**
| Parameter | Type | Description |
| -------------------- | ------ | ------------------------------------------------------------- |
| firstName | string | The updated first name of the user. |
| lastName | string | The updated last name of the user. |
| ipi | string | The updated IPI (Interested Parties Information) of the user. |
| role | string | The updated role of the user. |
| nickName | string | The updated nickname of the user. |
| userType | string | The updated type of user. |
| phone *(Optional)* | string | The updated phone number of the user. |
| country *(Optional)* | string | The updated country of the user. |
## Code Examples
```javascript Node.js theme={null}
const response = await fetch('https://api.royalti.io/user/example-id', {
method: 'PATCH',
headers: {
'Authorization': `Bearer ${token}`,
'Content-Type': 'application/json'
},
body: JSON.stringify({})
});
const data = await response.json();
console.log(data);
```
```python Python theme={null}
import requests
response = requests.patch(
'https://api.royalti.io/user/example-id',
headers={
'Authorization': f'Bearer {token}'
},
json={}
)
data = response.json()
print(data)
```
```bash cURL theme={null}
curl -X PATCH https://api.royalti.io/user/example-id \
-H "Authorization: Bearer YOUR_TOKEN" \
-H "Content-Type: application/json" \
-d '{}'
```
## OpenAPI
````yaml patch /user/{id}
openapi: 3.0.0
info:
title: Royalti.io API
description: "# Royalti API\r\n\r\nThis is the Royalti music royalty management platform API server.\r\n\r\n## Overview\r\n\r\nThe Royalti API provides comprehensive music royalty management services including:\r\n- Music publishing and writer management\r\n- Royalty processing and analytics\r\n- DDEX integration for music industry standards\r\n- File processing and pattern recognition\r\n- Payment processing and distribution\r\n\r\n## Authentication\r\n\r\nThe API uses JWT-based authentication with multiple protection levels:\r\n- Public endpoints for basic operations\r\n- Protected endpoints requiring valid JWT tokens\r\n- Admin endpoints for administrative functions\r\n\r\n## Features\r\n\r\n- Multi-dimensional royalty analytics\r\n- CWR (Collective Works Registration) support\r\n- DDEX integration for music metadata\r\n- Advanced file processing with pattern recognition\r\n- Real-time data processing with queue system"
version: 2.6.0
contact:
name: Royalti.io Support
email: support@royalti.io
url: https://royalti.io
license:
name: Proprietary
url: https://royalti.io/terms
servers:
- url: https://api.royalti.io
description: Production server
- url: https://api-dev.royalti.io
description: Development server
- url: http://localhost:8084
description: Local development
security:
- bearerAuth: []
tags:
- name: Accounting
description: Accounting and financial transaction operations
- name: DDEX
description: DDEX operations (ERN/MEAD, messages, delivery, providers)
- name: Label
description: Label management operations
- name: Internal Webhooks
description: Internal system webhooks for royalty processing and downloads
- name: Payment Webhooks
description: Payment processor webhook endpoints
- name: Billing Webhooks
description: Stripe billing and subscription webhooks
- name: Infrastructure Webhooks
description: Cloudflare domain and SSL webhooks
- name: Distribution Webhooks
description: Digital distribution platform webhooks (FUGA)
paths:
/user/{id}:
patch:
tags:
- User
summary: Update User
description: >-
**/user/{userId}**
**Description:**
The `/user/{userId}` endpoint allows updating the details of a specific
user identified by their unique userId.
**Method:**
`PATCH`
**Request Payload:**
| Parameter | Type | Description |
| --- | --- | --- |
| firstName | string | The updated first name of the user. |
| lastName | string | The updated last name of the user. |
| ipi | string | The updated IPI (Interested Parties Information) of the
user. |
| role | string | The updated role of the user. |
| nickName | string | The updated nickname of the user. |
| userType | string | The updated type of user. |
| phone _(Optional)_ | string | The updated phone number of the user. |
| country _(Optional)_ | string | The updated country of the user. |
parameters:
- name: id
in: path
required: true
description: User ID
schema:
type: string
requestBody:
required: true
content:
multipart/form-data:
schema:
type: object
properties:
firstName:
type: string
description: The updated first name of the user
lastName:
type: string
description: The updated last name of the user
ipi:
type: string
description: The updated IPI (Interested Parties Information) of the user
role:
type: string
description: The updated role of the user
nickName:
type: string
description: The updated nickname of the user
userType:
type: string
description: The updated type of user
phone:
type: string
description: The updated phone number of the user
country:
type: string
description: The updated country of the user
file:
type: string
format: binary
description: Profile image file
responses:
'200':
description: success
content:
application/json:
schema:
type: object
'401':
description: Unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'404':
description: Not Found
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'500':
description: Internal Server Error
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
security:
- bearerAuth: []
components:
schemas:
Error:
type: object
properties:
success:
type: boolean
example: false
error:
type: object
properties:
code:
type: string
message:
type: string
details:
type: array
items:
type: string
securitySchemes:
bearerAuth:
type: http
scheme: bearer
bearerFormat: JWT
description: >-
JWT Authorization header using the Bearer scheme. Format: "Bearer
{token}"
````