---
title: "Update user"
method: POST
path: "/api/users/{userId}"
tags: ["User"]
---

# Update user

`POST /api/users/{userId}`

## Request

- Base URL: `https://studio.edgeimpulse.com/v1`
- URL: `https://studio.edgeimpulse.com/v1/api/users/{userId}`
- Auth: one of:
  - API key in header `x-api-key`
  - API key in cookie `jwt`
  - API key in header `x-jwt-token`
  - OAuth 2
    - Authorization code: `/v1/oauth/authorize`
    - Client credentials
    - Implicit: `/v1/oauth/authorize`
    - Password
    - Token URL: `/v1/oauth/token`
- TypeScript: <https://skmtc.dev/edgeimpulse/apis/edge-impulse-api/docs/api/users/:userId/post.ts> (a function with typed inputs; its response is checked against the schema)

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

## Path parameters

- `userId` integer, required

## Request body

- UpdateUserRequest: Only fields set in this object will be updated.
  - `name` string: New full name
  - `jobTitle` string: New job title
  - `companyName` string: New company name
  - `experiments` string[]: List of user experiments
  - `projectsSortOrder` 'created-asc' | 'created-desc' | 'added-asc' | 'added-desc' | 'name-asc' | 'name-desc' | 'last-accessed-desc'
  - `timezone` string: User timezone.

## Response `200`

OK

- GenericApiResponse
  - `success` boolean, required: Whether the operation succeeded
  - `error` string: Optional error description (set if 'success' was false)

---

[API](https://skmtc.dev/edgeimpulse/apis/edge-impulse-api.md) - [All operations](https://skmtc.dev/edgeimpulse/apis/edge-impulse-api/llms.txt) - [OpenAPI document](https://skmtc.dev/edgeimpulse/apis/edge-impulse-api/revisions/e2a976d38427?raw)