Update group contacts
Method |
update.group_contacts |
Description |
Updating contact groups in address book |
Who has access |
Agent, Customer |
You can update partially. If you update a bulk of data the bulk will replace an existing one.
Parameters of a request
Title |
Type |
Required |
Description |
access_token |
string |
yes |
Authentication session key |
id |
number |
yes |
Unique ID of a contacts group in address book |
user_id |
number |
no |
Authentication session key |
user_id |
number |
no |
Unique user ID of a customer or an agent who makes request. Is mandatory for the agent To access a list of customer users you need to use the method "get.customer_users" |
name |
string |
yes |
Name of contact groups |
members |
array |
no |
List of unique contact IDs that belong to a group. You can access contact list via the method "get.contacts" . |
JSON request structure
{
"jsonrpc":"2.0",
"method":"update.group_contacts",
"id":"number",
"params":{
"access_token":"string",
"id":"number",
"user_id":"number",
"name":"string",
"members":[
"contact_id"
]
}
}
JSON reply structure
{
"jsonrpc":"2.0",
"id":"number",
"result":{
}
}
List of returning errors
Refer to "List of errors for methoda with the verb update"