---
title: "White Label Admin - Update white label user"
method: POST
path: "/api/organizations/{organizationId}/whitelabel/users/{userId}"
tags: ["Organizations"]
---

# White Label Admin - Update white label user

`POST /api/organizations/{organizationId}/whitelabel/users/{userId}`

## Request

- Base URL: `https://studio.edgeimpulse.com/v1`
- URL: `https://studio.edgeimpulse.com/v1/api/organizations/{organizationId}/whitelabel/users/{userId}`
- Auth: one of:
  - API key in header `x-api-key`
  - API key in cookie `jwt`
  - API key in header `x-jwt-token`
  - OAuth 2
    - Authorization code: `/v1/oauth/authorize`
    - Client credentials
    - Implicit: `/v1/oauth/authorize`
    - Password
    - Token URL: `/v1/oauth/token`
- TypeScript: <https://skmtc.dev/edgeimpulse/apis/edge-impulse-api/docs/api/organizations/:organizationId/whitelabel/users/:userId/post.ts> (a function with typed inputs; its response is checked against the schema)

White label admin only API to update user properties.

## Path parameters

- `organizationId` integer, required
- `userId` integer, required

## Request body

- AdminUpdateUserRequest: Only fields set in this object will be updated.
  - `email` string: New email. This will also update the forum's email address but the user may need to logout/login back
  - `name` string: New user full name
  - `activated` boolean: Whether the user is active or not. Can only go from inactive to active.
  - `suspended` boolean: Whether the user is suspended or not.
  - `suspensionReason` string: Reason for suspension
  - `jobTitle` string: New user job title
  - `experiments` string[]: List of user experiments

## Response `200`

OK

- GenericApiResponse
  - `success` boolean, required: Whether the operation succeeded
  - `error` string: Optional error description (set if 'success' was false)

---

[API](https://skmtc.dev/edgeimpulse/apis/edge-impulse-api.md) - [All operations](https://skmtc.dev/edgeimpulse/apis/edge-impulse-api/llms.txt) - [OpenAPI document](https://skmtc.dev/edgeimpulse/apis/edge-impulse-api/revisions/e2a976d38427?raw)