Skip to main content
PUT
/
api
/
v1
/
directory_members
/
{member_id}
/
restore
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.directoryMemberRestore({
    memberId: 507482,
  });

  console.log(result);
}

run();
{
  "name": "<string>",
  "type": "<string>",
  "id": 123,
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "extensions": [
    {
      "name": "work",
      "numbers": [
        {
          "number": "+1234567890",
          "rules": [
            {
              "language": "en"
            }
          ]
        }
      ]
    }
  ],
  "contact_tags": {
    "tag1": [
      "value1"
    ],
    "tag2": [
      "value2"
    ]
  },
  "comments": "Updated phone number",
  "deleted_at": null,
  "last_updated_by": "user@email.com"
}

Authorizations

​
Syllable-API-Key
string
header
required

Path Parameters

​
member_id
integer
required

Query Parameters

​
response_format
enum<string>
default:normalized

Directory response format for the restored member.

Available options:
normalized,
raw

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:

"Operator"

​
id
integer
required

Internal ID of the directory member

Example:

1

​
created_at
string<date-time>
required

When the contact was created

Example:

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

​
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"] }
​
comments
string | null

Optional comment stored in version history for this edit

Example:

"Updated phone number"

​
deleted_at
string<date-time> | null

When the contact was deleted, if deleted

Example:

null

​
last_updated_by
string | null

Email of the user who last updated the directory member

Example:

"user@email.com"