Update user by ID

PATCH

/users/{userId}

Users

Updates an existing user with the specified fields. Only provided fields will be updated.

Request

Path Params

Body Params application/jsonRequired

Examples

Responses

🟢200OK

application/json

User updated successfully

Body

🟠400Bad Request

🟠401Unauthorized

🟠404Record Not Found

Request Example

Shell

JavaScript

Java

Swift

curl --location --request PATCH '/users/' \
--header 'Content-Type: application/json' \
--data-raw '{
    "nickname": "string",
    "profileImage": "http://example.com",
    "lang": "en",
    "timezone": "UTC",
    "externalId": "string",
    "status": "active",
    "role": "owner"
}'

Response Example

{
    "userId": "string",
    "principalId": "string",
    "externalId": "string",
    "nickname": "string",
    "profileImage": "http://example.com",
    "lang": "en",
    "timezone": "UTC",
    "role": "member",
    "status": "active",
    "referralCode": "string",
    "referredBy": "string",
    "referredCount": 0,
    "welcomeEmailRequested": true,
    "welcomeEmailSentAt": "2019-08-24T14:15:22.123Z",
    "accountId": "stringstri",
    "workspaceId": "stringstri",
    "updatedAt": "2019-08-24T14:15:22.123Z"
}

Modified at 2026-04-02 15:44:25

Get user by ID

Delete (anonymise) user by ID