> ## Documentation Index > Fetch the complete documentation index at: https://doc.extole.com/llms.txt > Use this file to discover all available pages before exploring further. # Update a user > Updates the staff user account. Only fields present in the request body are changed. Returns the updated user. ## OpenAPI ````yaml /api-reference/management.json put /v2/users/{userId} openapi: 3.0.1 info: description: >- Configuration endpoints for the Extole platform: campaigns, components, audiences, persons, rewards, reporting, integrations setup, and administrative tooling. title: Management API version: '1.0' servers: - description: Production url: https://api.extole.io security: - HEADER: [] - QUERY: [] - COOKIE: [] tags: - name: Audiences - name: Authentication - name: Batch Jobs - name: Blocks - name: Campaigns - name: Components - name: Components Settings - name: Domains - name: Email - name: Erasure - name: Event Streams - name: File Validation Monitors - name: Optout - name: Profiles - name: Promotion Links - name: Report Schedules - name: Report Types - name: Reports - name: Reward Suppliers - name: Security Keys - name: Settings - name: User Notifications - name: User Subscriptions - name: Users - name: Webhooks paths: /v2/users/{userId}: put: tags: - Users summary: Update a user description: >- Updates the staff user account. Only fields present in the request body are changed. Returns the updated user. operationId: updateUser parameters: - in: path name: userId required: true schema: type: string requestBody: content: application/json: example: email: email first_name: first_name last_name: last_name password: password scopes: - CLIENT_ADMIN schema: $ref: '#/components/schemas/UserUpdateRequest' responses: '200': content: application/json: schema: $ref: '#/components/schemas/UserResponse' description: Successful response '400': content: application/json: examples: binding_error: $ref: '#/components/examples/binding_error' common_password: $ref: '#/components/examples/common_password' duplicate_user: $ref: '#/components/examples/duplicate_user' invalid_json: $ref: '#/components/examples/invalid_json' invalid_parameter: $ref: '#/components/examples/invalid_parameter' invalid_password_change_limit: $ref: '#/components/examples/invalid_password_change_limit' invalid_password_length: $ref: '#/components/examples/invalid_password_length' invalid_password_strength_letters_digits: $ref: >- #/components/examples/invalid_password_strength_letters_digits invalid_password_strength_letters_digits_punctuation: $ref: >- #/components/examples/invalid_password_strength_letters_digits_punctuation invalid_user_email: $ref: '#/components/examples/invalid_user_email' invalid_user_first_name: $ref: '#/components/examples/invalid_user_first_name' invalid_user_id: $ref: '#/components/examples/invalid_user_id' invalid_user_last_name: $ref: '#/components/examples/invalid_user_last_name' missing_request_body: $ref: '#/components/examples/missing_request_body' password_already_used: $ref: '#/components/examples/password_already_used' unauthorized_scope: $ref: '#/components/examples/unauthorized_scope' user_scopes_missing: $ref: '#/components/examples/user_scopes_missing' user_self_scopes_update: $ref: '#/components/examples/user_self_scopes_update' schema: $ref: '#/components/schemas/RestExceptionResponse' description: Bad Request '401': content: application/json: examples: method_unauthorized: $ref: '#/components/examples/method_unauthorized' schema: $ref: '#/components/schemas/RestExceptionResponse' description: Unauthorized '402': content: application/json: examples: payment_required: $ref: '#/components/examples/payment_required' schema: $ref: '#/components/schemas/RestExceptionResponse' description: Payment Required '403': content: application/json: examples: access_denied: $ref: '#/components/examples/access_denied' account_disabled: $ref: '#/components/examples/account_disabled' invalid_scope: $ref: '#/components/examples/invalid_scope' method_unauthorized: $ref: '#/components/examples/method_unauthorized' missing_access_token: $ref: '#/components/examples/missing_access_token' schema: $ref: '#/components/schemas/RestExceptionResponse' description: Forbidden '415': content: application/json: examples: unsupported_media_type: $ref: '#/components/examples/unsupported_media_type' schema: $ref: '#/components/schemas/RestExceptionResponse' description: Unsupported Media Type '429': content: application/json: examples: too_many_requests: $ref: '#/components/examples/too_many_requests' schema: $ref: '#/components/schemas/RestExceptionResponse' description: Too Many Requests components: schemas: UserUpdateRequest: description: Body of a `PUT /v2/users/{userId}` request. properties: email: type: string first_name: nullable: true type: string last_name: nullable: true type: string password: type: string scopes: items: enum: - CLIENT_ADMIN - CLIENT_SUPERUSER - SELF_SERVICE - USER_SUPPORT type: string type: array uniqueItems: true type: object UserResponse: properties: email: type: string first_name: type: string last_logged_in: type: string last_name: type: string locked: type: boolean scopes: items: enum: - CLIENT_ADMIN - CLIENT_SUPERUSER - SELF_SERVICE - USER_SUPPORT type: string type: array uniqueItems: true user_id: type: string required: - email - first_name - last_logged_in - last_name - locked - scopes - user_id type: object RestExceptionResponse: description: Represents the API error response properties: code: description: Specific error code for this error type, documented per endpoint type: string http_status_code: description: >- HTTP status code that was returned with this error, useful if client get response code format: int32 type: integer message: description: User readable English description of the error type: string parameters: additionalProperties: description: >- Attributes related to the error, varies be error code, documented per endpoint type: object description: >- Attributes related to the error, varies be error code, documented per endpoint type: object unique_id: description: >- Unique id associated with this error, useful for discussions with Extole type: string required: - code - http_status_code - message - parameters - unique_id type: object examples: binding_error: summary: binding_error value: code: binding_error http_status_code: 400 message: Argument is not of the expected type parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 common_password: summary: common_password value: code: common_password http_status_code: 400 message: Password is too weak parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 duplicate_user: summary: duplicate_user value: code: duplicate_user http_status_code: 400 message: User already exists parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 invalid_json: summary: invalid_json value: code: invalid_json http_status_code: 400 message: JSON is invalid parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 invalid_parameter: summary: invalid_parameter value: code: invalid_parameter http_status_code: 400 message: Parameter is invalid. parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 invalid_password_change_limit: summary: invalid_password_change_limit value: code: invalid_password_change_limit http_status_code: 400 message: >- Password has been changed too many times. Your account has been disabled. Please contact: support@extole.com parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 invalid_password_length: summary: invalid_password_length value: code: invalid_password_length http_status_code: 400 message: Password is too short parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 invalid_password_strength_letters_digits: summary: invalid_password_strength_letters_digits value: code: invalid_password_strength_letters_digits http_status_code: 400 message: >- Password is too weak, it must contain at least one digit, one lowercase, and one uppercase letter parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 invalid_password_strength_letters_digits_punctuation: summary: invalid_password_strength_letters_digits_punctuation value: code: invalid_password_strength_letters_digits_punctuation http_status_code: 400 message: >- Password is too weak, it must contain at least one digit, one lowercase letter, one uppercase letter, and one punctuation mark parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 invalid_user_email: summary: invalid_user_email value: code: invalid_user_email http_status_code: 400 message: The provided user email was invalid parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 invalid_user_first_name: summary: invalid_user_first_name value: code: invalid_user_first_name http_status_code: 400 message: The provided user first name was invalid parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 invalid_user_id: summary: invalid_user_id value: code: invalid_user_id http_status_code: 400 message: Invalid user id parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 invalid_user_last_name: summary: invalid_user_last_name value: code: invalid_user_last_name http_status_code: 400 message: The provided user last name was invalid parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 missing_request_body: summary: missing_request_body value: code: missing_request_body http_status_code: 400 message: Missing request body parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 password_already_used: summary: password_already_used value: code: password_already_used http_status_code: 400 message: Password had already been used, choose another one parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 unauthorized_scope: summary: unauthorized_scope value: code: unauthorized_scope http_status_code: 400 message: User is not authorized to have the specified role parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 user_scopes_missing: summary: user_scopes_missing value: code: user_scopes_missing http_status_code: 400 message: User must have at least one scope parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 user_self_scopes_update: summary: user_self_scopes_update value: code: user_self_scopes_update http_status_code: 400 message: User cannot update its own scopes parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 method_unauthorized: summary: method_unauthorized value: code: method_unauthorized http_status_code: 401 message: Unauthorized access to this endpoint parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 payment_required: summary: payment_required value: code: payment_required http_status_code: 402 message: The access_token provided is associated with an unpaid account. parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 access_denied: summary: access_denied value: code: access_denied http_status_code: 403 message: >- The access_token provided is not permitted to access the specified resource. parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 account_disabled: summary: account_disabled value: code: account_disabled http_status_code: 403 message: >- The credentials provided with this request are invalid. Account has been disabled. parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 invalid_scope: summary: invalid_scope value: code: invalid_scope http_status_code: 403 message: Invalid scope parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 missing_access_token: summary: missing_access_token value: code: missing_access_token http_status_code: 403 message: No access_token was provided with this request. parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 unsupported_media_type: summary: unsupported_media_type value: code: unsupported_media_type http_status_code: 415 message: Request had an unsupported or no media type parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 too_many_requests: summary: too_many_requests value: code: too_many_requests http_status_code: 429 message: >- The server is unable to process your request at the moment, please retry later. parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 securitySchemes: HEADER: in: header name: Authorization type: apiKey x-bearer-format: bearer QUERY: in: query name: access_token type: apiKey COOKIE: in: cookie name: extole_token type: apiKey ````