Skip to main content
PATCH
/
api
/
v1
/
users
/
{id}
Partial Update
curl --request PATCH \
  --url https://api.main.apexscore.ai/api/v1/users/{id}/ \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "full_name": "<string>",
  "organization_members": [
    {}
  ],
  "last_login": "2023-11-07T05:31:56Z",
  "is_active": true,
  "date_joined": "2023-11-07T05:31:56Z",
  "email": "jsmith@example.com",
  "first_name": "<string>",
  "last_name": "<string>",
  "user_permissions": [
    123
  ]
}
'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "full_name": "<string>",
  "email": "jsmith@example.com",
  "first_name": "<string>",
  "last_name": "<string>"
}

Authorizations

​
Authorization
string
header
required

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

Path Parameters

​
id
string<uuid>
required

A UUID string identifying this user.

Body

application/json
​
full_name
string
Maximum string length: 250
​
organization_members
object[]
​
last_login
string<date-time> | null
​
is_active
boolean

Designates whether this user should be treated as active. Unselect this instead of deleting accounts.

​
date_joined
string<date-time>
​
email
string<email>
Maximum string length: 255
​
first_name
string | null
Maximum string length: 50
​
last_name
string | null
Maximum string length: 100
​
user_permissions
integer[]

Specific permissions for this user.

Response

200 - application/json
​
id
string<uuid>
required
read-only
​
full_name
string
required
Maximum string length: 250
​
email
string<email>
required
Maximum string length: 255
​
first_name
string | null
Maximum string length: 50
​
last_name
string | null
Maximum string length: 100