> ## Documentation Index > Fetch the complete documentation index at: https://widgetic.com/llms.txt > Use this file to discover all available pages before exploring further. # Update Managed User > Updates an existing managed user. Only `externalId`, `metadata` and `isActive` can change, and `metadata` is replaced as a whole, so send all of it. `isActive: false` switches the managed user off: what it already has stays, and nothing new can be filed under it until you send `isActive: true`. Switching it off also ends all of its editor sessions, and they do not come back when you switch it on again. The `Idempotency-Key` header is required (`400` without it). ## OpenAPI ````yaml /openapi/widgetic-api-public.json put /managed-users/{id} openapi: 3.0.0 info: title: Widgetic API Gateway version: 1.0.0 description: API documentation for the Widgetic API Gateway license: name: Widgetic Integration License url: https://docs.widgetic.com/resources/license servers: - url: https://api.widgetic.com/v1 description: Production server variables: env: default: production description: Environment apiUrl: default: https://api.widgetic.com description: API URL apiVersion: default: /v1 description: API Version path prefix security: [] tags: [] paths: /managed-users/{id}: put: tags: - Managed Users summary: Update Managed User description: > Updates an existing managed user. Only `externalId`, `metadata` and `isActive` can change, and `metadata` is replaced as a whole, so send all of it. `isActive: false` switches the managed user off: what it already has stays, and nothing new can be filed under it until you send `isActive: true`. Switching it off also ends all of its editor sessions, and they do not come back when you switch it on again. The `Idempotency-Key` header is required (`400` without it). operationId: updateManagedUser parameters: - in: path name: id required: true schema: type: string format: uuid description: ID of the managed user to update - $ref: '#/components/parameters/IdempotencyKeyRequired' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/UpdateManagedUser' responses: '200': description: Managed user updated successfully content: application/json: schema: $ref: '#/components/schemas/ManagedUserResponse' '400': description: Invalid input content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '403': description: >- Forbidden - the caller is not a partner. A record managed by another account is never a 403. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '404': description: >- Managed user not found. A record managed by another account answers 404 as well, so you cannot learn whether another partner's record exists. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '409': description: Another managed user of yours already has this `externalId` content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' security: - apiKeyAuth: [] components: parameters: IdempotencyKeyRequired: in: header name: Idempotency-Key required: true description: >- Required: a call without it is refused with `400`. A key of your own that names this one request; a UUID is ideal. It is 8 to 50 characters of letters, digits, `-` and `_`. Send the same key again when you retry (after a timeout, a dropped connection or a `5xx`) and the call is carried out once: the retry gets the first answer back, marked `X-Idempotency-Cached: true`. The same key with a different body is refused with `422`, and a retry that arrives while the first call is still running with `409` (see `Retry-After`). schema: type: string minLength: 8 maxLength: 50 pattern: ^[a-zA-Z0-9_-]{8,50}$ example: 9b2d6f0a-3c41-4e5a-8d77-1f2e3a4b5c6d schemas: UpdateManagedUser: type: object properties: externalId: type: string description: >- Updated external identifier for the managed user. Must be unique among the managed users you manage (409 otherwise). example: updated-external-user-123 metadata: type: object description: Updated additional metadata for the managed user example: firstName: John lastName: Smith role: admin isActive: type: boolean description: > Switch the managed user off (`false`) or back on (`true`). A managed user that is off keeps everything already filed under it, and that content can still be listed, but nothing new can be filed under it (`409 MANAGED_USER_INACTIVE`). Send a real boolean, not the text "false". Switching a managed user off also ends all of its editor sessions. example: false example: externalId: updated-external-user-123 metadata: firstName: John lastName: Smith role: admin isActive: false ManagedUserResponse: type: object required: - success - data properties: success: type: boolean description: Always `true` on a success. example: true data: $ref: '#/components/schemas/ManagedUser' meta: $ref: '#/components/schemas/ResponseMeta' ErrorResponse: type: object required: - success - message - error additionalProperties: true properties: success: type: boolean description: Always `false` on a failure. example: false message: type: string description: The same text as `error.message`, for a caller that reads one line. error: $ref: '#/components/schemas/ErrorDetail' ManagedUser: type: object description: > A managed user as the API answers. The answer names its fields in camelCase (`externalId`), and so does the request that creates or changes a managed user; the snake_case spelling (`external_id`) is read too. required: - id - managerId - externalId - createdAt - updatedAt properties: id: type: string format: uuid description: Unique identifier for the managed user example: 123e4567-e89b-12d3-a456-426614174000 managerId: type: string format: uuid description: ID of the user who manages this managed user example: 123e4567-e89b-12d3-a456-426614174001 externalId: type: string description: >- Your own identifier for the managed user. Unique among the managed users you manage (two different partners may use the same value). example: external-user-123 metadata: type: object description: Additional metadata for the managed user example: firstName: John lastName: Doe role: editor isActive: type: boolean nullable: true description: > Whether new compositions, widgets and uploads can be filed under this managed user. `false` means it has been switched off (`updateManagedUser` with `is_active: false`): what it already has stays, and filing anything new under it answers `409 MANAGED_USER_INACTIVE`. A record from before the switch existed may answer `null`, which counts as on. example: true createdAt: type: string format: date-time description: Timestamp when the managed user was created example: '2023-01-01T00:00:00Z' updatedAt: type: string format: date-time description: Timestamp when the managed user was last updated example: '2023-01-02T00:00:00Z' example: id: 123e4567-e89b-12d3-a456-426614174000 managerId: 123e4567-e89b-12d3-a456-426614174001 externalId: external-user-123 metadata: firstName: John lastName: Doe role: editor isActive: true createdAt: '2023-01-01T00:00:00Z' updatedAt: '2023-01-02T00:00:00Z' ResponseMeta: type: object description: >- Extra information about the answer: where a page sits in a list, the cursor of the next page, or warnings about a call that succeeded with a caveat. additionalProperties: true properties: page: type: integer description: The page that was read, counting from 1. example: 1 size: type: integer description: How many items one page holds. example: 20 total: type: integer description: How many items the whole list has. example: 135 limit: type: integer description: The same as `size`. example: 20 offset: type: integer description: How many items come before this page. example: 0 hasNextPage: type: boolean example: true hasPreviousPage: type: boolean example: false nextCursor: type: string nullable: true description: >- Pass this as `cursor` to read the next page of a list that is read by cursor. `null` on the last page. warnings: type: array items: type: string description: >- Things the call did not do, though it succeeded (for example a table that could not be created just now). ErrorDetail: type: object required: - code - message - timestamp properties: code: type: string description: Machine-readable error code. example: RESOURCE_NOT_FOUND message: type: string description: Human-readable explanation. example: Composition not found param: type: string description: The field that caused the error, when one did. example: name docUrl: type: string description: Where this error is explained. suggestedAction: type: string description: What to do about it. retryAfter: type: integer description: >- Seconds to wait before trying again (rate limits). The same number is in the `Retry-After` header. example: 60 details: type: object additionalProperties: true description: >- More about the error: the fields that failed, a limit that was reached. correlationId: type: string description: Quote this when you ask support about the call. example: req_123e4567-e89b-12d3-a456-426614174000 timestamp: type: string format: date-time example: '2026-10-15T10:00:00.000Z' securitySchemes: apiKeyAuth: type: http scheme: bearer bearerFormat: JWT ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.