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

ApiKeyAuthenticationJWTAuthenticationJWTHttpHeaderAuthentication

Path parameters

organizationIdintegerrequired

Organization ID

userIdintegerrequired

User ID

Body

emailstringoptional

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

Example: [e-mail]

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

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://studio.edgeimpulse.com/v1/api/organizations/{organizationId}/whitelabel/users/{userId}' \
  --header 'x-api-key: YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
    "email": "[e-mail]",
    "name": "Don Quijote de la Mancha",
    "activated": true,
    "suspended": false,
    "suspensionReason": "Spamming the forum",
    "jobTitle": "Knight",
    "experiments": [
      "text"
    ]
  }'

200

200

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

OK