Update user

Update user

post

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

Authorizations

ApiKeyAuthenticationJWTAuthenticationJWTHttpHeaderAuthentication

Path parameters

userIdintegerrequired

User ID

Body

namestringoptional

New full name

Example: Jan Jongboom

jobTitlestringoptional

New job title

Example: Embedded Software Engineer

companyNamestringoptional

New company name

Example: Edge Impulse Inc.

experimentsstring[]optional

List of user experiments

projectsSortOrderstring · enumoptional

Default sort order on the projects list

Options: created-asc, created-desc, added-asc, added-desc, name-asc, name-desc, last-accessed-desc

timezonestringoptional

User timezone.

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://studio.edgeimpulse.com/v1/api/users/{userId}' \
  --header 'x-api-key: YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
    "name": "Jan Jongboom",
    "jobTitle": "Embedded Software Engineer",
    "companyName": "Edge Impulse Inc.",
    "experiments": [
      "text"
    ],
    "projectsSortOrder": "created-asc",
    "timezone": "text"
  }'

200

200

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

OK