Update a user

Updates the user information for the given user id.

put

Path parameters

idstringRequired

Header parameters

BrandUrlstringRequired

The brand URL of the request. This is used to identify the brand.

Example: YOUR_BRAND_URL

AuthkeystringRequired

This is used to authenticate the request. If the request is not authenticated, the server will return a 401 Unauthorized response.

Example: YOUR_AUTH_KEY

Body

application/jsontext/jsonapplication/*+json

The presentation data transfer object for updating the user.

usernamestring | nullableOptional

The username of the user.

Example: username

emailAddressstring · email | nullableOptional

The email address of the user.

Example: [e-mail]

nickNamestring | nullableOptional

The nickname of the user.

Example: example

firstNamestring | nullableOptional

The first name of the user.

Example: John

lastNamestring | nullableOptional

The nickname of the user.

Example: Doe

languageCodestring | nullableOptional

The language code of the user. The language code is composed of two parts: the language code and the country code. The language code is a lowercase two-letter code derived from ISO 639-1. The country code is an uppercase two-letter code derived from ISO 3166.

Example: en-US

timeZoneIdstring | nullableOptional

The id time zone of the user.

phoneNumberstring · tel | nullableOptional

The primary phone number of the user. The phone number is in the E.164 format.

Example: [phone]

phoneNumber1string · tel | nullableOptional

The phone number 1 of the user. The phone number is in the E.164 format.

Example: [phone]

avatarstring | nullableOptional

The avatar of the user. The avatar is a URL of the image.

biostring | nullableOptional

The bio is a short description of the user.

Example: example

websitestring · uri | nullableOptional

The website of the user want to update. The website is a URL of the user.

Example: https://mywebsite.com

Responses

200

The request was successful.

application/json

401

The user is not authorized to access the requested resource. The request is missing the required AuthKey header.

application/json

403

The user's access was denied.

application/json

429

The user has exceeded the rate limit.

application/json

723

The user email already exists in the system.

application/json

724

The username already exists in the system.

application/json

put

HTTPcURLJavaScriptPython

PUT /api/users/{id} HTTP/1.1
Host: protocol.jframework.dev
BrandUrl: text
Authkey: text
Content-Type: application/json
Accept: */*
Content-Length: 285

{
  "username": "username",
  "emailAddress": "[e-mail]",
  "nickName": "example",
  "firstName": "John",
  "lastName": "Doe",
  "languageCode": "en-US",
  "timeZoneId": "text",
  "phoneNumber": "[phone]",
  "phoneNumber1": "[phone]",
  "avatar": "text",
  "bio": "example",
  "website": "https://mywebsite.com"
}

application/jsontext/jsonapplication/*+json

{
  "success": true,
  "statusCode": 200,
  "message": "The request was successful.",
  "data": {
    "brandId": "xZrwkBM58VN",
    "parentUser": {
      "code": "PZBAAE",
      "avatar": "https://www.jframework.io/admin.jpg",
      "packageId": "yDpX0wAbpGRqjv3l",
      "packageCode": "STANDARD",
      "emailAddress": "[e-mail]",
      "nickName": "Admin",
      "roles": [
        "Admin"
      ],
      "id": "2rlzM7wMPlamsSa"
    },
    "code": "AABA24461C0E194BEF3E",
    "username": "john.doe",
    "firstName": "John",
    "lastName": "Doe",
    "nickName": null,
    "avatar": "https://www.johndoe.com/avatar.jpg",
    "emailAddress": "[e-mail]",
    "phoneNumber": "+01234567890",
    "website": "https://www.johndoe.com",
    "bio": null,
    "type": "EndUser",
    "isEmailAddressVerified": null,
    "isUserVerified": null,
    "riskMark": 50,
    "roles": [
      {
        "parentBrandId": "xZrwkBM58VN",
        "guid": "4fbe7168-cea6-4d41-85fd-080770a827e6",
        "code": "SUPER_ADMIN",
        "name": "Super Admin",
        "description": "Super Admin",
        "tags": "#Admin",
        "type": "BuiltIn",
        "permissions": [
          "USER.CREATE"
        ],
        "id": "2rlzM7w"
      }
    ],
    "referralCode": "AABAAE",
    "testMode": false,
    "tags": null,
    "status": "Active",
    "isSystem": false,
    "package": "STANDARD",
    "packageId": "yDpX0wAbpGRqjv3l",
    "languageCode": "vi-VN",
    "timeZoneId": "QlzwLjGaKvAvbD5x",
    "expiryDate": "2025-06-07T13:15:32.1069381Z",
    "themeStyle": "light",
    "enableSignInDetection": true,
    "isUserIntegration": false,
    "id": "2rlzM7wMrxdPLmsza",
    "createdDate": "2025-05-08T13:15:32.1069391Z"
  },
  "errors": []
}