Update user

Update user

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

post

/api/users/{userId}

Authorizations

ApiKeyAuthenticationJWTAuthenticationJWTHttpHeaderAuthentication

Path parameters

userIdintegerrequired

User ID

Body

namestring

New full name

Example: Jan Jongboom

jobTitlestring

New job title

Example: Embedded Software Engineer

companyNamestring

New company name

Example: Edge Impulse Inc.

projectsSortOrderstring · enum

Default sort order on the projects list

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

timezonestring

User timezone.

experimentsstring[]

List of user experiments

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.","projectsSortOrder":"created-asc","experiments":[null]}'

200

200

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

OK