/users/{id}/

put

https://ship.cars/api/users/{id}/

Updates an identified user account.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

string

required

Unique ID of the user.

Body Params

full_name

string

length ≤ 60

Full name of the user.

display_name

string

length ≤ 60

Display name of the user.

additional_phone_number

string

length ≤ 64

Additional phone number of the user.

time_zone

string

length ≤ 64

Home time zone of the user.

external_id

string

length ≤ 64

ID of the user that is used by external systems.

is_driver

boolean

Indicates whether the user is a driver.

truck_capacity

integer

1 to 15

Capacity of the car carrier trailer of the user. Applicable only to driver users.

truck_enclosed

boolean

Indicates whether the car carrier trailer of the user is enclosed. Applicable only to driver users.

truck_handles_inoperable

boolean

Indicates whether the car carrier trailer of the user is equipped to handle inoperable vehicles. Applicable only to driver users.

demo

boolean

Defaults to false

Indicates whether this is a demo user.

Responses

Language

Credentials

OAuth2

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Success

400Bad Request

401Unauthorized

403Forbidden

404Not Found