White Label Admin - Update white label user

White Label Admin - Update white label user

White label admin only API to update user properties.

POSThttps://studio.edgeimpulse.com/v1/api/organizations/{organizationId}/whitelabel/users/{userId}

Path parameters

organizationId*integer

Organization ID

userId*integer

User ID

Body

application/json

emailstring

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

Example: "[e-mail]"

namestring

New user full name

Example: "Don Quijote de la Mancha"

activatedboolean

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

Example: true

suspendedboolean

Whether the user is suspended or not.

Example: false

jobTitlestring

New user job title

Example: "Knight"

experimentsarray of string

List of user experiments

Response

200

OK

Body

application/json

success*boolean

Whether the operation succeeded

errorstring

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

Request

JavaScriptCurl

const response = await fetch('https://studio.edgeimpulse.com/v1/api/organizations/{organizationId}/whitelabel/users/{userId}', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

{
  "success": false,
  "error": "text"
}