White Label Admin - Update white label user

White label admin only API to update user properties.

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

White Label Admin - Update white label user

cURL

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

import requests

url = "https://studio.edgeimpulse.com/v1/api/organizations/{organizationId}/whitelabel/users/{userId}"

payload = {
    "email": "[e-mail]",
    "name": "Don Quijote de la Mancha",
    "activated": True,
    "suspended": False,
    "suspensionReason": "Spamming the forum",
    "jobTitle": "Knight",
    "experiments": ["<string>"]
}
headers = {
    "x-api-key": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    email: '[e-mail]',
    name: 'Don Quijote de la Mancha',
    activated: true,
    suspended: false,
    suspensionReason: 'Spamming the forum',
    jobTitle: 'Knight',
    experiments: ['<string>']
  })
};

fetch('https://studio.edgeimpulse.com/v1/api/organizations/{organizationId}/whitelabel/users/{userId}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://studio.edgeimpulse.com/v1/api/organizations/{organizationId}/whitelabel/users/{userId}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'email' => '[e-mail]',
    'name' => 'Don Quijote de la Mancha',
    'activated' => true,
    'suspended' => false,
    'suspensionReason' => 'Spamming the forum',
    'jobTitle' => 'Knight',
    'experiments' => [
        '<string>'
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "x-api-key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://studio.edgeimpulse.com/v1/api/organizations/{organizationId}/whitelabel/users/{userId}"

	payload := strings.NewReader("{\n  \"email\": \"[e-mail]\",\n  \"name\": \"Don Quijote de la Mancha\",\n  \"activated\": true,\n  \"suspended\": false,\n  \"suspensionReason\": \"Spamming the forum\",\n  \"jobTitle\": \"Knight\",\n  \"experiments\": [\n    \"<string>\"\n  ]\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("x-api-key", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://studio.edgeimpulse.com/v1/api/organizations/{organizationId}/whitelabel/users/{userId}")
  .header("x-api-key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"email\": \"[e-mail]\",\n  \"name\": \"Don Quijote de la Mancha\",\n  \"activated\": true,\n  \"suspended\": false,\n  \"suspensionReason\": \"Spamming the forum\",\n  \"jobTitle\": \"Knight\",\n  \"experiments\": [\n    \"<string>\"\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://studio.edgeimpulse.com/v1/api/organizations/{organizationId}/whitelabel/users/{userId}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"email\": \"[e-mail]\",\n  \"name\": \"Don Quijote de la Mancha\",\n  \"activated\": true,\n  \"suspended\": false,\n  \"suspensionReason\": \"Spamming the forum\",\n  \"jobTitle\": \"Knight\",\n  \"experiments\": [\n    \"<string>\"\n  ]\n}"

response = http.request(request)
puts response.read_body

200

{
  "success": true,
  "error": "<string>"
}

Authorizations

ApiKeyAuthenticationJWTAuthenticationJWTHttpHeaderAuthenticationOAuth2

x-api-key · string · header · required

Path Parameters

organizationId · integer · required

Organization ID

userId · integer · required

User ID

Body

application/json

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

Example:

"[e-mail]"

name · string

New user full name

Example:

"Don Quijote de la Mancha"

activated · boolean

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

Example:

true

suspended · boolean

Whether the user is suspended or not.

Example:

false

suspensionReason · string

Reason for suspension

Example:

"Spamming the forum"

jobTitle · string

New user job title

Example:

"Knight"

experiments · string[]

List of user experiments

Response

200 - application/json

OK

success · boolean · required

Whether the operation succeeded

error · string

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