Update user

Update user

Update user properties such as name. This function is only available through a JWT token.

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

Path parameters

userId*integer

User ID

Body

application/json

namestring

New full name

Example: "Jan Jongboom"

jobTitlestring

New job title

Example: "Embedded Software Engineer"

companyNamestring

New company name

Example: "Edge Impulse Inc."

experimentsarray of string

List of user experiments

projectsSortOrderUserProjectsSortOrder (enum)

created-asccreated-descadded-ascadded-descname-ascname-desclast-accessed-desc

timezonestring

User timezone.

Response

200

OK

Body

application/json

success*boolean

Whether the operation succeeded

errorstring

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

Request

JavaScriptCurlPython

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

Response

200

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