Skip to main content
PUT
/
api
/
v3
/
users
Update a User
curl --request PUT \
  --url https://apix.us.amity.co/api/v3/users \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "userId": "<string>",
  "displayName": "<string>",
  "profileHandle": "<string>",
  "roles": [
    "<string>"
  ],
  "metadata": {},
  "avatarFileId": "<string>",
  "avatarCustomUrl": "<string>",
  "description": "<string>"
}
'
{
  "users": [
    {
      "userId": "<string>",
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z",
      "_id": "<string>",
      "path": "<string>",
      "userInternalId": "<string>",
      "userPublicId": "<string>",
      "roles": [
        "<string>"
      ],
      "permissions": [],
      "displayName": "<string>",
      "profileHandle": "<string>",
      "description": "<string>",
      "avatarFileId": "<string>",
      "avatarCustomUrl": "<string>",
      "flagCount": 123,
      "hashFlag": {
        "bits": 123,
        "hashes": 123,
        "hash": [
          "<string>"
        ]
      },
      "metadata": {},
      "isGlobalBan": true,
      "isBrand": true,
      "isDeleted": true
    }
  ],
  "roles": [
    {
      "roleId": "<string>",
      "updatedAt": "2023-11-07T05:31:56Z",
      "permissions": [
        "<string>"
      ],
      "isDeleted": false,
      "displayName": "<string>",
      "createdAt": "2023-11-07T05:31:56Z"
    }
  ],
  "files": [
    {
      "fileId": "<string>",
      "fileUrl": "<string>",
      "accessType": "public",
      "altText": "<string>",
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z",
      "attributes": {
        "name": "<string>",
        "extension": "<string>",
        "size": 123,
        "mimeType": "<string>",
        "metadata": {
          "exif": {},
          "gps": {},
          "height": 123,
          "width": 123,
          "isFull": true
        }
      }
    }
  ]
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

User to be updated

​
userId
string
Maximum string length: 50
​
displayName
string
Maximum string length: 100
​
profileHandle
string
Maximum string length: 100
​
roles
string[]

Only administrator can update system roles (moderator and admin)

Maximum array length: 10
Maximum string length: 100
​
metadata
object

User metadata (max: 5,000 bytes)

​
avatarFileId
string
Maximum string length: 50
​
avatarCustomUrl
string
Maximum string length: 1000
​
description
string
Maximum string length: 500

Response

User

​
users
object[]
​
roles
object[]
​
files
object[]