User

Update current user

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

post/api/user

Request

  • Base URL
    https://studio.edgeimpulse.com/v1
  • Auth
    • API key in header x-api-key
    • or API key in cookie jwt
    • or API key in header x-jwt-token
    • or OAuth 2
      Authorization code/v1/oauth/authorize
      Client credentials
      Implicit/v1/oauth/authorize
      Password
      Token URL/v1/oauth/token
  • TypeScript
    A function with typed inputs. Its response is checked against the schema.

Request body

namestring

New full name

jobTitlestring

New job title

companyNamestring

New company name

experimentsstring[]

List of user experiments

projectsSortOrder'created-asc' | 'created-desc' | 'added-asc' | 'added-desc' | 'name-asc' | 'name-desc' | 'last-accessed-desc'
timezonestring

User timezone.

Example request

{
  "name": "Jan Jongboom",
  "jobTitle": "Embedded Software Engineer",
  "companyName": "Edge Impulse Inc."
}

Response

OK

successboolean required

Whether the operation succeeded

errorstring

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

Changes

No recorded changes to this operation across all 1 revision of this API.