v66

latestOpenAPI 3.1.0raw.githubusercontent.com2026-08-04176310979.2 KB

Create Directory Member

Create a new member in the directory

post/api/v1/directory_members/

Query parameters

response_format'normalized' | 'raw'

Response shape selector for directory member APIs.

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

Request body

namestring required

Name of the directory member

typestring required

Type of the directory member

contact_tagsobject nullable

Tags for the directory member

commentsstring nullable

The comments for the most recent edit to the directory member

Example request

{
  "name": "Jane Doe",
  "type": "Operator",
  "extensions": [
    {
      "name": "work",
      "numbers": [
        {
          "number": "+1234567890",
          "rules": [
            {
              "language": "en"
            }
          ]
        }
      ]
    }
  ],
  "contact_tags": {
    "tag1": [
      "value1"
    ],
    "tag2": [
      "value2"
    ]
  },
  "comments": "Updated to add new extension"
}

Response

Successful Response

namestring required

Name of the directory member

typestring required

Type of the directory member

contact_tagsobject nullable

Tags for the directory member

commentsstring nullable

The comments for the most recent edit to the directory member

idinteger required

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 nullable

When the contact was deleted, if deleted

last_updated_bystring nullable

Email of the user who last updated the directory member

created_bystring nullable

Email of the user who created the directory member

Example response

{
  "name": "Jane Doe",
  "type": "Operator",
  "extensions": [
    {
      "name": "work",
      "numbers": [
        {
          "number": "+1234567890",
          "rules": [
            {
              "language": "en"
            }
          ]
        }
      ]
    }
  ],
  "contact_tags": {
    "tag1": [
      "value1"
    ],
    "tag2": [
      "value2"
    ]
  },
  "comments": "Updated to add new extension",
  "id": 1,
  "created_at": "2024-01-01T00:00:00Z",
  "updated_at": "2024-01-01T00:00:00Z",
  "last_updated_by": "user@email.com",
  "created_by": "user@email.com"
}