Edit a Phonebook

Request URL

POST {base_url}/{api_path}/phonebook/update?access_token={access_token}

Request parameters

Table 1.
Parameter	Required	Type	Description
id	Yes	Integer	The unique ID of the phonebook. Note: You can query the phonebook's ID using Search Specific Phonebooks.
name	No	String	The name of the phonebook.
member_select	No	String	Member selection method. Valid value: `sel_all`: Select all company contacts. `sel_specific`: Select specific company contacts.
add_contacts_id_list	No	Array<Integer>	The unique ID(s) of the contact(s) to be added into the phonebook. Note: You can query the contact's ID using Search Specific Company Contacts. Use a comma to separate multiple IDs.
del_contacts_id_list	No	Array<Integer>	The unique ID(s) of the contact(s) to be removed from the phonebook. Note: You can query the contact's ID using Search Specific Company Contacts. Use a comma to separate multiple IDs.

Response parameters

Table 2.
Parameter	Type	Description
errcode	Integer	Returned error code. `0`: Succeed. Non-zero value: Failed. Note: You can check the error code and error message in Error Code and Error Message.
errmsg	String	Returned message. `SUCCESS`: Succeed. `FAILURE`: Failed.

Examples

Request example

POST /openapi/v1.0/phonebook/update?access_token=ZzB1UpneFiGbHm7saIpmF8GJ7jVIgu8T HTTP/1.1

Host: yeastardocs.example.yeastarcloud.com
Content-Type: application/json

{
    "id": 6,
    "add_contacts_id_list": [
        3,6,9
    ],
    "del_contacts_id_list": [
        10
    ]
    
}

Response example

HTTP/1.1 200 OK
{
    "errcode": 0,
    "errmsg": "SUCCESS"
}