Skip to main content
POST
/
api
/
users
/
{userId}
Update user
curl --request POST \
  --url https://studio.edgeimpulse.com/v1/api/users/{userId} \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '{
  "name": "Jan Jongboom",
  "jobTitle": "Embedded Software Engineer",
  "companyName": "Edge Impulse Inc.",
  "experiments": [
    "<string>"
  ],
  "projectsSortOrder": "created-asc",
  "timezone": "<string>"
}'
{
  "success": true,
  "error": "<string>"
}

Authorizations

​
x-api-key
string
header
required

Path Parameters

​
userId
integer
required

User ID

Body

application/json

Only fields set in this object will be updated.

​
name
string

New full name

Example:

"Jan Jongboom"

​
jobTitle
string

New job title

Example:

"Embedded Software Engineer"

​
companyName
string

New company name

Example:

"Edge Impulse Inc."

​
experiments
string[]

List of user experiments

​
projectsSortOrder
enum<string>

Default sort order on the projects list

Available options:
created-asc,
created-desc,
added-asc,
added-desc,
name-asc,
name-desc,
last-accessed-desc
​
timezone
string

User timezone.

Response

200 - application/json

OK

​
success
boolean
required

Whether the operation succeeded

​
error
string

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

⌘I