Create Directory Member

Create a new member in the directory

POST/api/v1/directory_members/

Authentication

Syllable-API-Keyrequired

Send Syllable-API-Key in the header.

Need a credential? Create or manage an API token in the Syllable Console.

Parameters

Query parameters

response_format enum<string> query optional

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

Allowed values ["normalized","raw"]Default normalizedExample normalized

Request body

application/json

body DirectoryMemberCreate required

5 fields

namestringrequired

Name of the directory member

typestringrequired

Type of the directory member

extensionsDirectoryExtension[] | nulloptional

List of extensions for the directory member

Item schema

itemsDirectoryExtensionrequired

2 fields

namestringrequired

Directory extension name

numbersDirectoryExtensionNumber[] | nulloptional

Directory extension numbers.

Item schema

itemsDirectoryExtensionNumberrequired

3 fields

numberstringrequired

Phone number or SIP URI

rulesobject[] | nulloptional

Directory extension number rules. To include a language rule, use key "language" with a language code value.

Item schema

itemsobjectrequired

1 field

{key}stringoptional

sip_transfer_modeenum<string> | nulloptional

How to perform the SIP transfer, INVITE or REFER.

Allowed values ["refer","invite"]

contact_tagsobject | nulloptional

Tags for the directory member

1 options

{key}string[]optional

Item schema

itemsstringrequired

commentsstring | nulloptional

The comments for the most recent edit to the directory member

Request example

{
  "name": "string",
  "type": "string",
  "extensions": "string",
  "contact_tags": "string",
  "comments": "string"
}

Responses

200Successful Response

application/json

response DirectoryMember required

11 fields

namestringrequired

Name of the directory member

typestringrequired

Type of the directory member

extensionsDirectoryExtension[] | nulloptional

List of extensions for the directory member

Item schema

itemsDirectoryExtensionrequired

2 fields

namestringrequired

Directory extension name

numbersDirectoryExtensionNumber[] | nulloptional

Directory extension numbers.

Item schema

itemsDirectoryExtensionNumberrequired

3 fields

numberstringrequired

Phone number or SIP URI

rulesobject[] | nulloptional

Directory extension number rules. To include a language rule, use key "language" with a language code value.

Item schema

itemsobjectrequired

1 field

{key}stringoptional

sip_transfer_modeenum<string> | nulloptional

How to perform the SIP transfer, INVITE or REFER.

Allowed values ["refer","invite"]

contact_tagsobject | nulloptional

Tags for the directory member

1 options

{key}string[]optional

Item schema

itemsstringrequired

commentsstring | nulloptional

The comments for the most recent edit to the directory member

idintegerrequired

Internal ID of the directory member

created_atstring (date-time)required

When the contact was created

updated_atstring (date-time)required

Timestamp of most recent update

deleted_atstring (date-time) | nulloptional

When the contact was deleted, if deleted

last_updated_bystring | nulloptional

Email of the user who last updated the directory member

created_bystring | nulloptional

Email of the user who created the directory member

Response example

{
  "name": "string",
  "type": "string",
  "extensions": "string",
  "contact_tags": "string",
  "comments": "string",
  "id": 0,
  "created_at": "string",
  "updated_at": "string",
  "deleted_at": "string",
  "last_updated_by": "string",
  "created_by": "string"
}

422Validation Error

application/json

response HTTPValidationError required

1 field

detailValidationError[]optional

Item schema

itemsValidationErrorrequired

3 fields

locstring | integer[]required

Item schema

itemsstring | integerrequired

2 options

Option 1stringrequired

Option 2integerrequired

msgstringrequired

typestringrequired

Response example

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

Code examples

import { SyllableSDK } from "syllable-sdk";

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

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",
        ],
      },
      comments: "Updated to add new extension",
    },
  });

  console.log(result);
}

run();

import os
from syllable_sdk import SyllableSDK


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

    res = ss_client.directory.create(directory_member_create={
        "name": "Jane Doe",
        "type": "contact",
        "extensions": [
            {
                "name": "work",
                "numbers": [
                    {
                        "number": "+1234567890",
                        "rules": [
                            {
                                "language": "en",
                            },
                        ],
                    },
                ],
            },
        ],
        "contact_tags": {
            "tag1": [
                "value1",
            ],
            "tag2": [
                "value2",
            ],
        },
        "comments": "Updated to add new extension",
    })

    # Handle response
    print(res)

curl --request POST \
  --url 'https://api.syllable.cloud/api/v1/directory_members/?response_format=normalized' \
  --header 'content-type: application/json' \
  --data '{
  "name": "string",
  "type": "string",
  "extensions": "string",
  "contact_tags": "string",
  "comments": "string"
}'