Sign in

v66

OpenAPI 3.1.0raw.githubusercontent.com2026-08-04176310979.2 KB
users
V1

Update User

Update an existing user.

put/api/v1/users/

Request body

emailstring required

Email address of the user

first_namestring nullable

First name of the user

last_namestring nullable

Last name of the user

role_idinteger required

ID of the role assigned to the user

last_updated_commentsstring nullable

Comments for the most recent edit to the user.

Example request

{
  "email": "user@syllable.ai",
  "first_name": "Jane",
  "last_name": "Smith",
  "role_id": 1,
  "last_updated_comments": "Updated to change which role was assigned"
}

Response

Successful Response

emailstring required

Email address of the user

first_namestring nullable

First name of the user

last_namestring nullable

Last name of the user

role_idinteger required

ID of the role assigned to the user

last_updated_commentsstring nullable

Comments for the most recent edit to the user.

idinteger required

Internal ID of the user

role_namestring required

Name of the role assigned to the user

email_sentboolean required

Whether the welcome email has been sent to the user

activity_status'not_invited' | 'invited' | 'active' required
last_updatedstring date-time required

The timestamp of the most recent update to the user

last_updated_bystring nullable

The email address of the user who last updated the user

last_session_atstring date-time nullable

The timestamp of the user's last session

Example response

{
  "email": "user@syllable.ai",
  "first_name": "Jane",
  "last_name": "Smith",
  "role_id": 1,
  "last_updated_comments": "Updated to change which role was assigned",
  "id": 1,
  "role_name": "Admin",
  "email_sent": true,
  "last_updated_by": "admin@email.com",
  "last_session_at": "2025-01-01T12:00:00Z"
}