PATCH
/
{version}
/
users
/
{user}
curl --request PATCH \
  --url https://api.perscom.io/{version}/users/{user} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "name": "<string>",
  "email": "<string>",
  "email_verified_at": "2023-11-07T05:31:56Z",
  "phone_number": "<string>",
  "position_id": 123,
  "rank_id": 123,
  "specialty_id": 123,
  "status_id": 123,
  "unit_id": 123,
  "approved": true,
  "notes": "<string>",
  "notes_updated_at": "2023-11-07T05:31:56Z",
  "last_seen_at": "2023-11-07T05:31:56Z"
}'
{
  "data": {
    "id": 123,
    "name": "<string>",
    "email": "<string>",
    "email_verified_at": "2023-11-07T05:31:56Z",
    "phone_number": "<string>",
    "position_id": 123,
    "rank_id": 123,
    "specialty_id": 123,
    "status_id": 123,
    "unit_id": 123,
    "approved": true,
    "online": true,
    "notes": "<string>",
    "notes_updated_at": "2023-11-07T05:31:56Z",
    "profile_photo_url": "<string>",
    "cover_photo_url": "<string>",
    "discord_user_id": "<string>",
    "timezone": "<string>",
    "last_seen_at": "2023-11-07T05:31:56Z",
    "last_assignment_change_date": "2023-11-07T05:31:56Z",
    "last_rank_change_date": "2023-11-07T05:31:56Z",
    "label": "<string>",
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z"
  }
}

Authorizations

​
Authorization
string
header
required

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

Path Parameters

​
version
enum<string>
default:v2
required

The API version to use.

Available options:
v1,
v2
​
user
integer
required

Query Parameters

​
include
enum<string>
Available options:
assignment_records,
assignment_records.*,
attachments,
award_records,
award_records.*,
award_records.award.*,
combat_records,
combat_records.*,
fields,
position,
primary_assignment_records,
primary_assignment_records.*,
qualification_records,
qualification_records.*,
rank,
rank.*,
rank_records,
rank_records.*,
secondary_assignment_records,
secondary_assignment_records.*,
service_records,
service_records.*,
specialty,
status,
unit,
unit.*

Body

application/json
​
name
string
required
​
email
string
required
​
email_verified_at
string | null
​
phone_number
string | null
​
position_id
integer | null
​
rank_id
integer | null
​
specialty_id
integer | null
​
status_id
integer | null
​
unit_id
integer | null
​
approved
boolean
default:true
​
notes
string | null

Supports HTML.

​
notes_updated_at
string | null
​
profile_photo
file | null
​
cover_photo
file | null
​
last_seen_at
string | null

Response

200
application/json
OK
​
data
object

Was this page helpful?

Delete userCreate a batch of users