Skip to main content
POST
/
api
/
v1
/
directory_members
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.directory.create({
    directoryMemberCreate: {
      name: "Jane Doe",
      type: "contact",
      extensions: [
        {
          name: "work",
          numbers: [
            {
              number: "+1234567890",
              rules: [
                {
                  "language": "en",
                },
              ],
            },
          ],
        },
      ],
      contactTags: {
        "tag1": [
          "value1",
        ],
        "tag2": [
          "value2",
        ],
      },
    },
  });

  console.log(result);
}

run();
{
  "name": "<string>",
  "type": "<string>",
  "id": 123,
  "updated_at": "2023-11-07T05:31:56Z",
  "extensions": [
    {
      "name": "work",
      "numbers": [
        {
          "number": "+1234567890",
          "rules": [
            {
              "language": "en"
            }
          ]
        }
      ]
    }
  ],
  "contact_tags": {
    "tag1": [
      "value1"
    ],
    "tag2": [
      "value2"
    ]
  },
  "last_updated_by": "[email protected]"
}

Authorizations

Syllable-API-Key
string
header
required

Query Parameters

response_format
enum<string>
default:normalized

Directory response format: normalized (default) strips @hours and formats times; raw returns stored @hours values.

Available options:
normalized,
raw

Body

application/json

Request model to create a directory member.

name
string
required

Name of the directory member

Example:

"Jane Doe"

type
string
required

Type of the directory member

Example:

"contact"

extensions
DirectoryExtension · object[] | null

List of extensions for the directory member

Example:
[
{
"name": "work",
"numbers": [
{
"number": "+1234567890",
"rules": [{ "language": "en" }]
}
]
}
]
contact_tags
Contact Tags · object

Tags for the directory member

Example:
{ "tag1": ["value1"], "tag2": ["value2"] }

Response

Successful Response

Model for a directory member (i.e. a contact).

name
string
required

Name of the directory member

Example:

"Jane Doe"

type
string
required

Type of the directory member

Example:

"contact"

id
integer
required

Internal ID of the directory member

Example:

1

updated_at
string<date-time>
required

Timestamp of most recent update

Example:

"2024-01-01T00:00:00Z"

extensions
DirectoryExtension · object[] | null

List of extensions for the directory member

Example:
[
{
"name": "work",
"numbers": [
{
"number": "+1234567890",
"rules": [{ "language": "en" }]
}
]
}
]
contact_tags
Contact Tags · object

Tags for the directory member

Example:
{ "tag1": ["value1"], "tag2": ["value2"] }
last_updated_by
string | null

Email of the user who last updated the directory member