Skip to main content
POST
/
api
/
v1
/
directory_members
/
Python (SDK)
import os
from syllable_sdk import SyllableSDK


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

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

    # Handle response
    print(res)
{
  "name": "Jane Doe",
  "type": "contact",
  "extensions": [
    {
      "name": "work",
      "numbers": [
        {
          "number": "+1234567890",
          "rules": [
            {
              "language": "en"
            }
          ]
        }
      ]
    }
  ],
  "contact_tags": {
    "tag1": [
      "value1"
    ],
    "tag2": [
      "value2"
    ]
  },
  "id": 1,
  "updated_at": "2024-01-01T00:00:00Z",
  "last_updated_by": "user@email.com"
}

Authorizations

​
Syllable-API-Key
string
header
required

Body

application/json

Request model to create a directory member.

​
name
string
required

Name of the directory member

Examples:

"Jane Doe"

​
type
string
required

Type of the directory member

Examples:

"contact"

​
extensions
DirectoryExtension · object[] | null

List of extensions for the directory member

Examples:
[
  {
    "name": "work",
    "numbers": [
      {
        "number": "+1234567890",
        "rules": [{ "language": "en" }]
      }
    ]
  }
]
​
contact_tags
object | null

Tags for the directory member

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

Response

Successful Response

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

​
name
string
required

Name of the directory member

Examples:

"Jane Doe"

​
type
string
required

Type of the directory member

Examples:

"contact"

​
id
integer
required

Internal ID of the directory member

Examples:

1

​
updated_at
string<date-time>
required

Timestamp of most recent update

Examples:

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

​
extensions
DirectoryExtension · object[] | null

List of extensions for the directory member

Examples:
[
  {
    "name": "work",
    "numbers": [
      {
        "number": "+1234567890",
        "rules": [{ "language": "en" }]
      }
    ]
  }
]
​
contact_tags
object | null

Tags for the directory member

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

Email of the user who last updated the directory member

Examples:

"user@email.com"