Organizations

White Label Admin - Update white label user

White label admin only API to update user properties.

post/api/organizations/{organizationId}/whitelabel/users/{userId}

Request

Base URL
https://studio.edgeimpulse.com/v1
Auth
- API key in header x-api-key
- or API key in cookie jwt
- or API key in header x-jwt-token
- or 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.

Path parameters

organizationIdinteger required

Organization ID

userIdinteger required

User ID

Request body

emailstring

New email. This will also update the forum's email address but the user may need to logout/login back

namestring

New user full name

activatedboolean

Whether the user is active or not. Can only go from inactive to active.

suspendedboolean

Whether the user is suspended or not.

suspensionReasonstring

Reason for suspension

jobTitlestring

New user job title

experimentsstring[]

List of user experiments

Example request

{
  "email": "quijote@lamancha.es",
  "name": "Don Quijote de la Mancha",
  "activated": true,
  "suspensionReason": "Spamming the forum",
  "jobTitle": "Knight"
}

Response

successboolean required

Whether the operation succeeded

errorstring

Optional error description (set if 'success' was false)

Changes

No recorded changes to this operation across all 1 revision of this API.