> ## Documentation Index > Fetch the complete documentation index at: /docs/llms.txt > Use this file to discover all available pages before exploring further. # Update a user > Updates the specified user object. Any parameters not provided remain unchanged. ## OpenAPI ````yaml energy-api/reference/flatpeak-api-spec-energy-tariffs.json PATCH /users/{user_id} openapi: 3.0.3 info: description: >- The tariff functions of the Flatpeak Energy API: tariff connection, prices, forecasts and costs. Generated from the full Energy API spec by scripts/build-tariff-spec.py. Do not edit. version: 2027-01-01.busbar title: 'Flatpeak Energy API: Tariffs' termsOfService: https://flatpeak.com/legal contact: name: Technical Support email: support@flatpeak.com url: https://flatpeak.com/contact license: name: Apache 2.0 url: https://flatpeak.com/legal servers: - url: https://energy-api.flatpeak.com security: - bearerAuth: [] tags: - name: Authentication description: >- Exchange your account credentials for a bearer token to authenticate API requests. - name: Connect description: >- Create and retrieve Connect sessions. Connect drives the user journeys for tariff connection and [tariff error reporting](/energy-api/reference/connect/tariff/error-report). What happens in those journeys reaches your backend as [Connect webhooks](/energy-api/guides/platform/events). - name: Users description: Create, retrieve, update, delete, and list users. - name: Locations description: Create, retrieve, update, delete, and list locations. - name: Devices description: >- Create, retrieve, update, delete and list devices; submit and retrieve their state; read and write their shared settings. - name: Meters description: Submit meter records and check batch status. - name: Tariffs description: Create, retrieve, delete, and list tariffs. - name: Prices description: Retrieve and audit calculated energy prices. - name: Costs description: Calculate the monetary cost of imported or exported energy. - name: Optimizations description: >- Rank the connected tariff to find the best times to consume or export energy, as inputs to your own scheduling. - name: Events description: Retrieve and list account events. externalDocs: description: Documentation url: https://docs.flatpeak.com paths: /users/{user_id}: parameters: - schema: type: string name: user_id in: path required: true patch: tags: - Users summary: Update a user description: >- Updates the specified user object. Any parameters not provided remain unchanged. operationId: update-user parameters: [] requestBody: $ref: '#/components/requestBodies/UserUpdate' responses: '200': $ref: '#/components/responses/User' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '409': $ref: '#/components/responses/409' '429': $ref: '#/components/responses/429' '500': $ref: '#/components/responses/500' '503': $ref: '#/components/responses/503' components: requestBodies: UserUpdate: content: application/json: schema: $ref: '#/components/schemas/UserInput' description: Updates a user. required: true responses: '400': description: >- 400 Bad Request: the request was malformed or a required field is missing or invalid. content: application/json: schema: $ref: '#/components/schemas/Error' '401': description: '401 Unauthorized: authentication credentials are missing or invalid.' content: application/json: schema: $ref: '#/components/schemas/Error' '403': description: '403 Forbidden: you do not have permission to access this resource.' content: application/json: schema: $ref: '#/components/schemas/Error' '404': description: '404 Not Found: the requested resource does not exist.' content: application/json: schema: $ref: '#/components/schemas/Error' '409': description: >- 409 Conflict: the resource conflicts with existing data, for example a duplicate reference. content: application/json: schema: $ref: '#/components/schemas/Error' '429': description: '429 Too Many Requests: the rate limit has been exceeded.' content: application/json: schema: $ref: '#/components/schemas/Error' '500': description: >- 500 Internal Server Error: an unexpected error occurred. Safe to retry with backoff. content: application/json: schema: $ref: '#/components/schemas/Error' '503': description: >- 503 Service Unavailable: the service is temporarily down for maintenance. Retry after the indicated delay. content: application/json: schema: $ref: '#/components/schemas/Error' User: description: 'Success: the user resource.' content: application/json: schema: $ref: '#/components/schemas/User' schemas: UserInput: type: object additionalProperties: false properties: reference_id: type: string description: Your own reference, for example an ID from your system. example: USR1234567890 title: UserInput description: Fields of a user that you set when creating or updating it. User: type: object title: User description: A user of your service. properties: id: type: string description: Flatpeak User ID. example: usr_65e421d1daa4a24082b4f590 pattern: ^[a-z]{2,4}_[A-Za-z0-9]+$ object: type: string description: Object type. example: user enum: - user default: user live_mode: type: boolean description: '`true` for live data, `false` for test data.' reference_id: type: string description: Your own reference, for example an ID from your system. example: USR1234567890 location_ids: type: array description: Flatpeak IDs of the user's locations. items: type: string example: loc_641b90b758fb8e6293716e40 account_id: type: string description: Flatpeak Account ID. example: acc_65e421bed29d88d9012e0662 pattern: ^[a-z]{2,4}_[A-Za-z0-9]+$ time_created: type: string description: Time when the object was created, in UTC. example: '2021-05-05T05:37:27Z' format: date-time required: - id - object - live_mode - account_id - time_created Error: type: object description: Standard error envelope returned by every non-2xx response. required: - object - type - code - message properties: object: type: string enum: - error default: error description: Object type. type: type: string description: High-level error category. example: invalid_request code: type: string description: Machine-readable error code, safe to branch on. example: not_found message: type: string description: Human-readable description of the error. example: The requested resource could not be found. context: type: string description: Optional originating context, for example `api.price_get`. example: api.price_get live_mode: type: boolean description: Whether the error occurred against live or test data. time_created: type: string format: date-time description: Time the error was generated (RFC 3339). example: '2026-01-01T00:00:00Z' securitySchemes: bearerAuth: type: http scheme: bearer description: Bearer token obtained from POST /auth/tokens. ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.