HomeLog InSign Up

Update a user

Updates the user information for the given user id.

put
Path parameters
idstringRequired

The id of the user.

Header parameters
Brand-URLstringRequired

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

Example: YOUR_BRAND_URL
Auth-KeystringRequired

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

The presentation data transfer object for updating the user.

usernamestring · min: 1Required

The username of the user.

Example: username
emailAddressstring · email · min: 1Required

The email address of the user.

Example: [email protected]
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: +1234567890
phoneNumber1string · tel | nullableOptionalDeprecated

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

Example: +1234567890
avatarstring · uri | 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
put
PUT /api/v1/users/{id} HTTP/1.1
Host: protocol.jframework.io
Brand-URL: text
Auth-Key: text
Content-Type: application/json
Accept: */*
Content-Length: 323

{
  "username": "exampleuser",
  "emailAddress": "[email protected]",
  "nickName": "example",
  "firstName": "John",
  "lastName": "Doe",
  "languageCode": "en-US",
  "timeZoneId": "TimeZone_ID",
  "phoneNumber": "+1234567890",
  "phoneNumber1": "+1234567890",
  "avatar": "https://mywebsite.com/avatar.png",
  "bio": "example",
  "website": "https://mywebsite.com"
}
{
  "success": true,
  "statusCode": 200,
  "message": "The request was successful.",
  "data": {
    "id": "sApKpllz4sAplsmzha",
    "brandId": "xZrwkBM58VN",
    "parentUser": {
      "id": "sApKpllz4sAplsmzha",
      "code": "PZBAAE",
      "avatar": "https://www.jframework.io/admin.jpg",
      "packageId": "yDpX0wAbpGRqjv3l",
      "packageCode": "STANDARD",
      "emailAddress": "[email protected]",
      "nickName": "Admin",
      "roles": [
        "Admin"
      ]
    },
    "code": "AABA24461C0E194BEF3E",
    "username": "john.doe",
    "firstName": "John",
    "lastName": "Doe",
    "nickName": null,
    "avatar": "https://www.johndoe.com/avatar.jpg",
    "emailAddress": "[email protected]",
    "phoneNumber": "+01234567890",
    "website": "https://www.johndoe.com",
    "bio": null,
    "type": "EndUser",
    "isEmailAddressVerified": false,
    "isUserVerified": false,
    "riskMark": 50,
    "roles": [
      {
        "id": "sApKpllz4sAplsmzha",
        "parentBrandId": "xZrwkBM58VN",
        "guid": "f68f9877-5ffd-4d7c-b137-df91227121b8",
        "code": "SUPER_ADMIN",
        "name": "Super Admin",
        "description": "Super Admin",
        "tags": "#Admin",
        "type": "BuiltIn",
        "permissions": [
          "USER.CREATE"
        ]
      }
    ],
    "referralCode": "AABAAE",
    "testMode": false,
    "tags": null,
    "status": "Active",
    "isSystem": false,
    "package": {
      "id": "sApKpllz4sAplsmzha",
      "code": "CODE",
      "name": "NAME",
      "imageURL": "IMAGE",
      "patternAvatarURL": "https://www.example.com/pattern.jpg",
      "styles": "{\"color\": \"red\"}",
      "description": "DESCRIPTION",
      "tags": "TAGS",
      "isFree": true,
      "zOrder": 1,
      "features": [
        {
          "title": "Feature Title",
          "unit": "Unit",
          "quantity": 10,
          "isUnlimited": false,
          "id": "sApKpllz4sAplsmzha",
          "parentBrandId": "Brand_ID",
          "eventId": "Event_ID",
          "type": "Function",
          "code": "Code",
          "name": "Feature Name",
          "image": "https://www.example.com/image.jpg",
          "styles": "{\"color\": \"red\"}",
          "description": "Feature Description",
          "tags": "#Tag1, #Tag2",
          "zOrder": 1,
          "status": "Active"
        }
      ],
      "prices": [
        {
          "id": "sApKpllz4sAplsmzha",
          "code": "Code",
          "name": "Name",
          "amount": 10,
          "currency": "USD",
          "description": "Description",
          "checkoutLink": "CheckoutLink",
          "tags": "Tags",
          "packageName": "PackageName",
          "packageId": "PackageId",
          "subscriptionName": "SubscriptionName",
          "subscriptionTypeId": "SubscriptionTypeId",
          "zOrder": 1
        }
      ],
      "isDefault": true
    },
    "packageId": "yDpX0wAbpGRqjv3l",
    "languageCode": "vi-VN",
    "timeZoneId": "QlzwLjGaKvAvbD5x",
    "expiryDate": "2025-07-23T06:56:00.7768288Z",
    "themeStyle": "light",
    "enableSignInDetection": true,
    "isUserIntegration": false,
    "createdDate": "2025-06-23T06:56:00.7768301Z"
  },
  "errors": []
}
PreviousUnsuspend a userNextUpdate user type

Last updated

Was this helpful?