ASasksyllable
users
V1

Create User

Changed on

Create a new user.

post/api/v1/users/

Request

  • Base URL
    https://api.syllable.cloud
  • URL
    https://api.syllable.cloud/api/v1/users/
  • Auth
    API key in header Syllable-API-Key

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

login_type'google' | 'username_and_password'

The type of login to use for the user.

skip_authboolean

Compatibility no-op; accepted but ignored.

Example request

{
  "email": "user@syllable.ai",
  "first_name": "Jane",
  "last_name": "Smith",
  "role_id": 1
}

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"
}

Changes

  • 097cf29e35eeRevision changes
    • info

      added the new optional request property

    • info

      added the optional property to the response with the status