Create User - Syllable SDK

Typescript (SDK)

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: "user@syllable.ai",
    firstName: "Jane",
    lastName: "Smith",
    roleId: 1,
    loginType: "username_and_password",
  });

  console.log(result);
}

run();

import os
from syllable_sdk import SyllableSDK, models


with SyllableSDK(
    api_key_header=os.getenv("SYLLABLESDK_API_KEY_HEADER", ""),
) as ss_client:

    res = ss_client.v1.create(request={
        "email": "user@syllable.ai",
        "first_name": "Jane",
        "last_name": "Smith",
        "role_id": 1,
        "login_type": models.LoginType.USERNAME_AND_PASSWORD,
    })

    # Handle response
    print(res)

curl --request POST \
  --url https://api.syllable.cloud/api/v1/users/ \
  --header 'Content-Type: application/json' \
  --header 'Syllable-API-Key: <api-key>' \
  --data '
{
  "email": "user@syllable.ai",
  "role_id": 1,
  "first_name": "Jane",
  "last_name": "Smith",
  "utm": {
    "utm_source": "<string>",
    "utm_medium": "<string>",
    "utm_campaign": "<string>",
    "utm_term": "<string>",
    "utm_content": "<string>"
  },
  "login_type": "username_and_password",
  "skip_auth": false
}
'

const options = {
  method: 'POST',
  headers: {'Syllable-API-Key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    email: 'user@syllable.ai',
    role_id: 1,
    first_name: 'Jane',
    last_name: 'Smith',
    utm: {
      utm_source: '<string>',
      utm_medium: '<string>',
      utm_campaign: '<string>',
      utm_term: '<string>',
      utm_content: '<string>'
    },
    login_type: 'username_and_password',
    skip_auth: false
  })
};

fetch('https://api.syllable.cloud/api/v1/users/', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.syllable.cloud/api/v1/users/",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'email' => 'user@syllable.ai',
    'role_id' => 1,
    'first_name' => 'Jane',
    'last_name' => 'Smith',
    'utm' => [
        'utm_source' => '<string>',
        'utm_medium' => '<string>',
        'utm_campaign' => '<string>',
        'utm_term' => '<string>',
        'utm_content' => '<string>'
    ],
    'login_type' => 'username_and_password',
    'skip_auth' => false
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "Syllable-API-Key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.syllable.cloud/api/v1/users/"

	payload := strings.NewReader("{\n  \"email\": \"user@syllable.ai\",\n  \"role_id\": 1,\n  \"first_name\": \"Jane\",\n  \"last_name\": \"Smith\",\n  \"utm\": {\n    \"utm_source\": \"<string>\",\n    \"utm_medium\": \"<string>\",\n    \"utm_campaign\": \"<string>\",\n    \"utm_term\": \"<string>\",\n    \"utm_content\": \"<string>\"\n  },\n  \"login_type\": \"username_and_password\",\n  \"skip_auth\": false\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Syllable-API-Key", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.syllable.cloud/api/v1/users/")
  .header("Syllable-API-Key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"email\": \"user@syllable.ai\",\n  \"role_id\": 1,\n  \"first_name\": \"Jane\",\n  \"last_name\": \"Smith\",\n  \"utm\": {\n    \"utm_source\": \"<string>\",\n    \"utm_medium\": \"<string>\",\n    \"utm_campaign\": \"<string>\",\n    \"utm_term\": \"<string>\",\n    \"utm_content\": \"<string>\"\n  },\n  \"login_type\": \"username_and_password\",\n  \"skip_auth\": false\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.syllable.cloud/api/v1/users/")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Syllable-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"email\": \"user@syllable.ai\",\n  \"role_id\": 1,\n  \"first_name\": \"Jane\",\n  \"last_name\": \"Smith\",\n  \"utm\": {\n    \"utm_source\": \"<string>\",\n    \"utm_medium\": \"<string>\",\n    \"utm_campaign\": \"<string>\",\n    \"utm_term\": \"<string>\",\n    \"utm_content\": \"<string>\"\n  },\n  \"login_type\": \"username_and_password\",\n  \"skip_auth\": false\n}"

response = http.request(request)
puts response.read_body

{
  "email": "user@syllable.ai",
  "role_id": 1,
  "id": 1,
  "role_name": "Admin",
  "email_sent": true,
  "activity_status": "invited",
  "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": "admin@email.com",
  "last_session_at": "2025-01-01T12:00:00Z"
}

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>"
    }
  ]
}

POST

api

users

Typescript (SDK)

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: "user@syllable.ai",
    firstName: "Jane",
    lastName: "Smith",
    roleId: 1,
    loginType: "username_and_password",
  });

  console.log(result);
}

run();

import os
from syllable_sdk import SyllableSDK, models


with SyllableSDK(
    api_key_header=os.getenv("SYLLABLESDK_API_KEY_HEADER", ""),
) as ss_client:

    res = ss_client.v1.create(request={
        "email": "user@syllable.ai",
        "first_name": "Jane",
        "last_name": "Smith",
        "role_id": 1,
        "login_type": models.LoginType.USERNAME_AND_PASSWORD,
    })

    # Handle response
    print(res)

curl --request POST \
  --url https://api.syllable.cloud/api/v1/users/ \
  --header 'Content-Type: application/json' \
  --header 'Syllable-API-Key: <api-key>' \
  --data '
{
  "email": "user@syllable.ai",
  "role_id": 1,
  "first_name": "Jane",
  "last_name": "Smith",
  "utm": {
    "utm_source": "<string>",
    "utm_medium": "<string>",
    "utm_campaign": "<string>",
    "utm_term": "<string>",
    "utm_content": "<string>"
  },
  "login_type": "username_and_password",
  "skip_auth": false
}
'

const options = {
  method: 'POST',
  headers: {'Syllable-API-Key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    email: 'user@syllable.ai',
    role_id: 1,
    first_name: 'Jane',
    last_name: 'Smith',
    utm: {
      utm_source: '<string>',
      utm_medium: '<string>',
      utm_campaign: '<string>',
      utm_term: '<string>',
      utm_content: '<string>'
    },
    login_type: 'username_and_password',
    skip_auth: false
  })
};

fetch('https://api.syllable.cloud/api/v1/users/', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.syllable.cloud/api/v1/users/",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'email' => 'user@syllable.ai',
    'role_id' => 1,
    'first_name' => 'Jane',
    'last_name' => 'Smith',
    'utm' => [
        'utm_source' => '<string>',
        'utm_medium' => '<string>',
        'utm_campaign' => '<string>',
        'utm_term' => '<string>',
        'utm_content' => '<string>'
    ],
    'login_type' => 'username_and_password',
    'skip_auth' => false
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "Syllable-API-Key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.syllable.cloud/api/v1/users/"

	payload := strings.NewReader("{\n  \"email\": \"user@syllable.ai\",\n  \"role_id\": 1,\n  \"first_name\": \"Jane\",\n  \"last_name\": \"Smith\",\n  \"utm\": {\n    \"utm_source\": \"<string>\",\n    \"utm_medium\": \"<string>\",\n    \"utm_campaign\": \"<string>\",\n    \"utm_term\": \"<string>\",\n    \"utm_content\": \"<string>\"\n  },\n  \"login_type\": \"username_and_password\",\n  \"skip_auth\": false\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Syllable-API-Key", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.syllable.cloud/api/v1/users/")
  .header("Syllable-API-Key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"email\": \"user@syllable.ai\",\n  \"role_id\": 1,\n  \"first_name\": \"Jane\",\n  \"last_name\": \"Smith\",\n  \"utm\": {\n    \"utm_source\": \"<string>\",\n    \"utm_medium\": \"<string>\",\n    \"utm_campaign\": \"<string>\",\n    \"utm_term\": \"<string>\",\n    \"utm_content\": \"<string>\"\n  },\n  \"login_type\": \"username_and_password\",\n  \"skip_auth\": false\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.syllable.cloud/api/v1/users/")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Syllable-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"email\": \"user@syllable.ai\",\n  \"role_id\": 1,\n  \"first_name\": \"Jane\",\n  \"last_name\": \"Smith\",\n  \"utm\": {\n    \"utm_source\": \"<string>\",\n    \"utm_medium\": \"<string>\",\n    \"utm_campaign\": \"<string>\",\n    \"utm_term\": \"<string>\",\n    \"utm_content\": \"<string>\"\n  },\n  \"login_type\": \"username_and_password\",\n  \"skip_auth\": false\n}"

response = http.request(request)
puts response.read_body

{
  "email": "user@syllable.ai",
  "role_id": 1,
  "id": 1,
  "role_name": "Admin",
  "email_sent": true,
  "activity_status": "invited",
  "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": "admin@email.com",
  "last_session_at": "2025-01-01T12:00:00Z"
}

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>"
    }
  ]
}

Authorizations

Syllable-API-Key

string

header

required

Body

application/json

Request model to create a user.

string

required

Email address of the user

Example:

"user@syllable.ai"

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 | null

Optional UTM campaign attribution to record in user_metadata.

Show child attributes

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

Successful Response

Information about a user.

string

required

Email address of the user

Example:

"user@syllable.ai"

role_id

integer

required

ID of the role assigned to the user

Example:

1

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 | null

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:

"admin@email.com"

last_session_at

string<date-time> | null

The timestamp of the user's last session

Example:

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