Update a user within a child company.

put

https://ship.cars/api/usermanagement/v2/company/children/{childCompanyId}/users/{userId}

This method updates a user within a child company.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

childCompanyId

string

required

userId

string

required

Body Params

name

string

required

^{0}|(?=.*\S)[\p{L}\p{M}\p{N}\p{P}\p{S}\p{Z} ]{1,100}$

admin

boolean

Defaults to false

Determines whether the account is an admin

street

string

^{0}|(?=.*\S)[\p{L}\p{M}\p{N}\p{P}\p{S}\p{Z} ]{1,200}$

Street

city

string

^{0}|(?=.*\S)[\p{L}\p{M}\p{N}\p{P}\p{S}\p{Z} ]{1,100}$

City

state

string

enum

^{0}|[a-zA-Z]{2}$

Two-letter abbreviation of the state

zipCode

string

^{0}|\d{5}(-\d{4})?$

US postal code of the area or district

string

required

phoneNumber

string

^{0}|(\+?1[ -]?)?$?\d{3}$?[ -]?\d{3}[ -]?\d{4}$

User account phone number.

active

boolean

roles

array of strings

roles

Allowed:

primaryRole

string

enum

Allowed:

Responses

204

No Content

Language

Credentials

OAuth2

Loading…

Response

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

application/json

400Bad Request

404Not Found