Create User

Create a new user.

POST /api/v1/users

Typescript (SDK)

TypeScript

import { SyllableSDK } from "syllable-sdk";

const syllableSDK = new SyllableSDK({
  apiKeyHeader: process.env["SYLLABLESDK_API_KEY_HEADER"] ?? "",
});

async function run() {
  const result = await syllableSDK.v1.create({
    email: "[e-mail]",
    firstName: "Jane",
    lastName: "Smith",
    roleId: 1,
    loginType: "username_and_password",
  });

  console.log(result);
}

run();

200

{
  "email": "<string>",
  "role_id": 123,
  "id": 123,
  "role_name": "<string>",
  "email_sent": true,
  "last_updated": "2023-11-07T05:31:56Z",
  "first_name": "Jane",
  "last_name": "Smith",
  "utm": {
    "utm_source": "<string>",
    "utm_medium": "<string>",
    "utm_campaign": "<string>",
    "utm_term": "<string>",
    "utm_content": "<string>"
  },
  "last_updated_comments": "Updated to change which role was assigned",
  "last_updated_by": "[e-mail]",
  "last_session_at": "2025-01-01T12:00:00Z"
}

Authorizations

Syllable-API-Key · string · header · required

Body

application/json

Request model to create a user.

email · string · required

Email address of the user

Example:

"[e-mail]"

role_id · integer · required

ID of the role assigned to the user

Example:

1

first_name · string | null

First name of the user

Example:

"Jane"

last_name · string | null

Last name of the user

Example:

"Smith"

utm · DaoUtm · object

Optional UTM campaign attribution to record in user_metadata.

Show child attributes

login_type · enum<string> | null

The type of login to use for the user. If not provided, defaults to google for @gmail.com email addresses, and username and password otherwise.

Available options: google, username_and_password

Example:

"username_and_password"

skip_auth · boolean · default: false

Whether to skip authentication for the user.

Response

200

application/json

Successful Response

Information about a user.

email · string · required

Email address of the user

Example:

"[e-mail]"

role_id · integer · required

ID of the role assigned to the user

Example:

1

id · integer · required

Internal ID of the user

Example:

1

role_name · string · required

Name of the role assigned to the user

Example:

"Admin"

email_sent · boolean · required

Whether the welcome email has been sent to the user

Example:

true

activity_status · enum<string> · required

The activity status of the user

Available options: not_invited, invited, active

Example:

"invited"

last_updated · string<date-time> · required

The timestamp of the most recent update to the user

first_name · string | null

First name of the user

Example:

"Jane"

last_name · string | null

Last name of the user

Example:

"Smith"

utm · DaoUtm · object

Optional UTM campaign attribution to record in user_metadata.

Show child attributes

last_updated_comments · string | null

Comments for the most recent edit to the user.

Example:

"Updated to change which role was assigned"

last_updated_by · string | null

The email address of the user who last updated the user

Example:

"[e-mail]"

last_session_at · string<date-time> | null

The timestamp of the user's last session

Example:

"2025-01-01T12:00:00Z"