API Reference
API Reference

Restore Directory Member

Restore a soft-deleted directory member.

PUT/api/v1/directory_members/{member_id}/restore

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

Path parameters

member_id integer path required

Query parameters

response_format enum<string> query optional

Directory response format for the restored member.

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

Request body

application/json

body DirectoryMemberRestore required
1 field
commentsstringoptional

Comment stored in version history for this restore

Default Restored
Request example
{
  "comments": "Restored"
}

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"
}
404Not Found

No response body is declared.

409Conflict

No response body is declared.

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"
    }
  ]
}
500Internal Server Error

No response body is declared.