Update
PATCH
/api/account/{id}
Headers
-
Specify effective organization_id for Admin and Group Organization Admins. This is a global header for all endpoints only taken into consideration when it makes sense (it won't be used in Auth, for example)
Path parameters
-
id integer(int64) Required
id
Body
-
can_view_carrier_ids array[integer(int64)]
-
can_view_other_carriers boolean
-
carrier_id integer(int64)
-
driver_license string
-
driver_license_expiration string(date-time)
-
driver_license_picture_id integer(int64)
-
driver_photo_id integer(int64)
-
driver_truck_number string
-
email string
-
language_code string
-
managed_organization_group_id integer(int64)
-
name string
-
organization_id integer(int64)
-
password string
-
password_confirmation string
-
phone_number string
-
username string
username can be currently empty, for use cases when it is better or mandatory using an email/phone, in this case a unique username will be auto-generated
-
yard_id integer(int64)
PATCH /api/account/{id}
curl \
-X PATCH https://api-dev.gatego.io:443/api/account/{id} \
-H "Authorization: Bearer $ACCESS_TOKEN" \
-H "Content-Type: application/json" \
-d '{"can_view_carrier_ids":[42],"can_view_other_carriers":true,"carrier_id":42,"driver_license":"string","driver_license_expiration":"2023-05-04T09:42:00+00:00","driver_license_picture_id":42,"driver_photo_id":42,"driver_truck_number":"string","email":"string","language_code":"string","managed_organization_group_id":42,"name":"string","organization_id":42,"password":"string","password_confirmation":"string","phone_number":"string","username":"string","yard_id":42}'
Request example
# Headers
# Payload
{
"can_view_carrier_ids": [
42
],
"can_view_other_carriers": true,
"carrier_id": 42,
"driver_license": "string",
"driver_license_expiration": "2023-05-04T09:42:00+00:00",
"driver_license_picture_id": 42,
"driver_photo_id": 42,
"driver_truck_number": "string",
"email": "string",
"language_code": "string",
"managed_organization_group_id": 42,
"name": "string",
"organization_id": 42,
"password": "string",
"password_confirmation": "string",
"phone_number": "string",
"username": "string",
"yard_id": 42
}
Response examples (200)
{
"active": true,
"can_view_carrier_ids": [
42
],
"can_view_other_carriers": true,
"carrier_id": 42,
"deleted_at": "2023-05-04T09:42:00+00:00",
"driver": {
"license": "string",
"license_expiration": "2023-05-04T09:42:00+00:00",
"license_picture_id": "string",
"photo_id": "string",
"truck_number": "string"
},
"driver_license": "string",
"driver_license_expiration": "2023-05-04T09:42:00+00:00",
"driver_license_picture_id": 42,
"driver_photo_id": 42,
"driver_truck_number": "string",
"email": "string",
"email_confirmed": false,
"hmac": "string",
"hmac_android": "string",
"hmac_ios": "string",
"id": 42,
"language_code": "string",
"last_login": "2023-05-04T09:42:00+00:00",
"last_login_app_version": "string",
"last_login_referer": "string",
"managed_organization_group": {
"id": 42,
"managed_organizations": [
{
"id": 42,
"name": "string"
}
],
"name": "string"
},
"name": "string",
"organization": {
"id": 42,
"name": "string"
},
"phone_number": "string",
"previous_last_login": "2023-05-04T09:42:00+00:00",
"role": "ADMIN",
"username": "string",
"yard_id": 42
}