White Label Admin - Update white label user

White Label Admin - Update white label user

post

White label admin only API to update user properties.

Authorizations

ApiKeyAuthenticationJWTAuthenticationJWTHttpHeaderAuthenticationOAuth2

Path parameters

organizationIdintegerRequired

Organization ID

userIdintegerRequired

User ID

Body

Only fields set in this object will be updated.

emailstringOptional

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

Example: [email protected]

namestringOptional

New user full name

Example: Don Quijote de la Mancha

activatedbooleanOptional

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

Example: true

suspendedbooleanOptional

Whether the user is suspended or not.

Example: false

suspensionReasonstringOptional

Reason for suspension

Example: Spamming the forum

jobTitlestringOptional

New user job title

Example: Knight

experimentsstring[]Optional

List of user experiments

Responses

200

OK

application/json

post

HTTPcURLJavaScriptPython

POST /v1/api/organizations/{organizationId}/whitelabel/users/{userId} HTTP/1.1
Host: studio.edgeimpulse.com
x-api-key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 183

{
  "email": "[email protected]",
  "name": "Don Quijote de la Mancha",
  "activated": true,
  "suspended": false,
  "suspensionReason": "Spamming the forum",
  "jobTitle": "Knight",
  "experiments": [
    "text"
  ]
}

200

OK

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