api:pbx:phonebook:deleteall
Table of Contents
API : PBX : Phonebook Delete All
Introduction
This request will delete all the users contacts or all the customers shared contacts.
Personal contacts can only be deleted by the user they belongs to.
Request
| URL | https://api.telecomx.dk/pbx/phonebook | ||
|---|---|---|---|
| Method | DELETE | ||
| Access level | PERSONAL, MANAGER, OWNER, RESELLER or ADMIN. | ||
| Query | shared | Boolean | True to delete all shared contacts on the customer, requires MANAGER or higher access level. |
Response
| JSON object | ||
|---|---|---|
| success | Boolean | true on success. |
Example
{ success: true }
Errors
| Error code | Message | Description |
|---|---|---|
| 403 | access_denied | Insufficient access level |
| 403 | shared | Minimum access level required is manager to delete shared contacts |
| 500 | internal_error | <Unspecified> |
api/pbx/phonebook/deleteall.txt · Last modified: 2024/03/14 10:43 by Per Møller