POST
/
api
/
v1
/
directory_members
curl --request POST \
  --url https://api.syllable.cloud/api/v1/directory_members/ \
  --header 'Content-Type: application/json' \
  --header 'Syllable-API-Key: <api-key>' \
  --data '{
  "name": "Jane Doe",
  "type": "contact",
  "extensions": [
    {
      "name": "work",
      "numbers": [
        {
          "number": "+1234567890",
          "rules": [
            {
              "language": "en"
            }
          ]
        }
      ]
    }
  ],
  "contact_tags": {},
  "updated_at": "2023-11-07T05:31:56Z",
  "last_updated_by": "<string>"
}'
{
  "name": "Jane Doe",
  "type": "contact",
  "extensions": [
    {
      "name": "work",
      "numbers": [
        {
          "number": "+1234567890",
          "rules": [
            {
              "language": "en"
            }
          ]
        }
      ]
    }
  ],
  "contact_tags": {},
  "updated_at": "2023-11-07T05:31:56Z",
  "last_updated_by": "<string>",
  "id": 1
}

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

Example:

"Jane Doe"

​
type
string
required

Type of the directory member

Example:

"contact"

​
extensions
object[] | null

List of extensions for the directory member

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

Response

200
application/json
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"

​
extensions
object[] | null

List of extensions for the directory member

Example:
[
  {
    "name": "work",
    "numbers": [
      {
        "number": "+1234567890",
        "rules": [{ "language": "en" }]
      }
    ]
  }
]
​
contact_tags
object | null
​
updated_at
string | null
​
last_updated_by
string | null
​
id
integer | null

Internal ID of the directory member

Example:

1