---
updatedAt: 2025-09-10T20:58:53.000Z
agentTools:
  projectIndex: https://shipcars.readme.io/llms.txt
---

# Update a user within a child company.

This method updates a user within a child company.

# OpenAPI definition

```json
{
  "openapi": "3.0.1",
  "info": {
    "title": "User Management",
    "description": "Ship.Cars User Management",
    "contact": {
      "url": "https://ship.cars",
      "email": "support@ship.cars"
    },
    "version": "1.0.0"
  },
  "components": {
    "securitySchemes": {
      "bearerAuth": {
        "type": "oauth2",
        "flows": {
          "password": {
            "tokenUrl": "https://auth.ship.cars/auth/realms/master/protocol/openid-connect/token",
            "scopes": {}
          }
        }
      }
    }
  },
  "servers": [
    {
      "url": "https://ship.cars/api"
    }
  ],
  "paths": {
    "/usermanagement/v2/company/children/{childCompanyId}/users/{userId}": {
      "put": {
        "tags": [
          "Company Children Users API"
        ],
        "summary": "Update a user within a child company.",
        "description": "This method updates a user within a child company.",
        "operationId": "updateUser_1",
        "parameters": [
          {
            "name": "childCompanyId",
            "in": "path",
            "required": true,
            "schema": {
              "type": "string"
            },
            "example": "C-KHDBCYFIUVCBLBVNIXDAVTS6UU"
          },
          {
            "name": "userId",
            "in": "path",
            "required": true,
            "schema": {
              "type": "string"
            },
            "example": "U-KHDBCYFIUVCBLBVNIXDAVTS623"
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "required": [
                  "email",
                  "name"
                ],
                "type": "object",
                "properties": {
                  "name": {
                    "pattern": "^{0}|(?=.*\\S)[\\p{L}\\p{M}\\p{N}\\p{P}\\p{S}\\p{Z}\t]{1,100}$",
                    "type": "string",
                    "example": "John Smith"
                  },
                  "admin": {
                    "type": "boolean",
                    "description": "Determines whether the account is an admin",
                    "default": false
                  },
                  "street": {
                    "pattern": "^{0}|(?=.*\\S)[\\p{L}\\p{M}\\p{N}\\p{P}\\p{S}\\p{Z}\t]{1,200}$",
                    "type": "string",
                    "description": "Street",
                    "example": "161 W Cherry St"
                  },
                  "city": {
                    "pattern": "^{0}|(?=.*\\S)[\\p{L}\\p{M}\\p{N}\\p{P}\\p{S}\\p{Z}\t]{1,100}$",
                    "type": "string",
                    "description": "City",
                    "example": "Albion"
                  },
                  "state": {
                    "pattern": "^{0}|[a-zA-Z]{2}$",
                    "type": "string",
                    "description": "Two-letter abbreviation of the state",
                    "example": "IL",
                    "enum": [
                      "AL",
                      "AK",
                      "AS",
                      "AZ",
                      "AR",
                      "AA",
                      "AE",
                      "AP",
                      "CA",
                      "CO",
                      "CT",
                      "DE",
                      "DC",
                      "FL",
                      "GA",
                      "GU",
                      "HI",
                      "ID",
                      "IL",
                      "IN",
                      "IA",
                      "KS",
                      "KY",
                      "LA",
                      "ME",
                      "MD",
                      "MA",
                      "MI",
                      "MN",
                      "MS",
                      "MO",
                      "MT",
                      "NE",
                      "NV",
                      "NH",
                      "NJ",
                      "NM",
                      "NY",
                      "NC",
                      "ND",
                      "MP",
                      "OH",
                      "OK",
                      "OR",
                      "PA",
                      "PR",
                      "RI",
                      "SC",
                      "SD",
                      "TN",
                      "TX",
                      "UT",
                      "VT",
                      "VI",
                      "VA",
                      "WA",
                      "WV",
                      "WI",
                      "WY"
                    ]
                  },
                  "zipCode": {
                    "pattern": "^{0}|\\d{5}(-\\d{4})?$",
                    "type": "string",
                    "description": "US postal code of the area or district",
                    "example": "62806"
                  },
                  "email": {
                    "type": "string",
                    "example": "email@email.com"
                  },
                  "phoneNumber": {
                    "pattern": "^{0}|(\\+?1[ -]?)?\\(?\\d{3}\\)?[ -]?\\d{3}[ -]?\\d{4}$",
                    "type": "string",
                    "description": "User account phone number.",
                    "example": "1234567890"
                  },
                  "active": {
                    "type": "boolean",
                    "example": true
                  },
                  "roles": {
                    "type": "array",
                    "example": "Driver",
                    "items": {
                      "type": "string",
                      "example": "Driver",
                      "enum": [
                        "ACCOUNTANT",
                        "DISPATCHER",
                        "DRIVER",
                        "SUPERVISOR"
                      ]
                    }
                  },
                  "primaryRole": {
                    "type": "string",
                    "enum": [
                      "ACCOUNTANT",
                      "DISPATCHER",
                      "DRIVER",
                      "SUPERVISOR"
                    ]
                  }
                }
              }
            }
          },
          "required": true
        },
        "responses": {
          "204": {
            "description": "No Content"
          },
          "400": {
            "description": "Bad Request",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "timestamp": {
                      "type": "string",
                      "format": "date-time"
                    },
                    "httpStatus": {
                      "type": "integer",
                      "format": "int32"
                    },
                    "errorCode": {
                      "type": "integer",
                      "format": "int32"
                    },
                    "errorMessage": {
                      "type": "string"
                    },
                    "errorDetails": {
                      "type": "array",
                      "items": {
                        "type": "string"
                      }
                    }
                  }
                }
              }
            }
          },
          "404": {
            "description": "Not Found",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "timestamp": {
                      "type": "string",
                      "format": "date-time"
                    },
                    "httpStatus": {
                      "type": "integer",
                      "format": "int32"
                    },
                    "errorCode": {
                      "type": "integer",
                      "format": "int32"
                    },
                    "errorMessage": {
                      "type": "string"
                    },
                    "errorDetails": {
                      "type": "array",
                      "items": {
                        "type": "string"
                      }
                    }
                  }
                }
              }
            }
          }
        },
        "security": [
          {
            "bearerAuth": []
          }
        ]
      }
    }
  },
  "x-readme": {
    "explorer-enabled": true,
    "proxy-enabled": true
  }
}
```