PATCH
/
{version}
/
users
/
{user}

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
​
email
string
required
​
name
string
required
​
approved
boolean
default:
true
​
cover_photo
file | null
​
email_verified_at
string | null
​
last_seen_at
string | null
​
notes
string | null

Supports HTML.

​
notes_updated_at
string | null
​
phone_number
string | null
​
position_id
integer | null
​
profile_photo
file | null
​
rank_id
integer | null
​
specialty_id
integer | null
​
status_id
integer | null
​
unit_id
integer | null

Response

200 - application/json
​
data
object

Was this page helpful?

Delete userCreate a batch of users