API : PBX : Phonebook group update
- Introduction
- Request
  - Body example
- Response
  - Errors

API : PBX : Phonebook group update

Introduction

A phonebook group is a named group of phonebook contacts. Other features point at a group by its id, e.g. to route a call depending on whether the caller is in the group.

There are two kinds of groups:

Customer groups hold the customers shared contacts. Every user of the customer can see them. Access level MANAGER or above is required to create, rename and delete them.
Personal groups belong to one employee and hold that employees personal contacts. The employee manages them, and so does another employee who has the group right readPhonebook (to see them) or writePhonebook (to change them) on the employee.

A contact selects its groups through its groups property when it is created or updated. A shared contact can only be in customer groups, a personal contact only in the personal groups of its own employee.

This request renames a group or changes its notes. The contacts in the group are not touched - they reference the group by its id.

Request

URL	https://api.telecomx.dk/pbx/phonebookgroup/GROUP_ID
Method	POST
Access level	Customer group: MANAGER or OWNER if user belongs to the customer, RESELLER if customer belongs to the reseller, ADMIN. Personal group: the employee self, or an employee with the group right `writePhonebook` on the employee.
Param	GROUP_ID	Id of the group (24 hex-char string)
Body	name	`[optional]` New name of the group, 1-50 characters.
Body	notes	`[optional]` New notes, max 1000 characters. null removes them.

Body example

{
  name: 'VIP customers'
}

Response

The updated group, in the same format as Get.

Errors

Error code	Message	Description
403	access_denied	Insufficient access level
404	id	Phonebook group not found
409	name	A phonebook group with that name already exists
422	id	Not a valid id
422	name	Name is empty or longer than 50 characters
500	internal_error	<Unspecified>