Skip to content

Updates a contact group in the address book

Method update.group_contacts
Description Updates a contact group in the address book
Who has access Agents and clients

Partial updates are supported. When an array field is updated, the new array replaces the existing array in full.

Request parameters

Name Type Required Description
access_token string yes Session key used to authenticate the request
id number yes Unique ID of the contact group to update
user_id number no Unique ID of the client user on whose behalf the request is made. Required when an agent makes the request. To retrieve a list of client users, call "get.customer_users".
name string yes Contact group name
members array no IDs of contacts to include in the group. To retrieve contacts, call "get.contacts".

Example request

{
  "jsonrpc":"2.0",
  "method":"update.group_contacts",
  "id":"number",
  "params":{
    "access_token":"string",
    "id":"number",
    "user_id":"number",
    "name":"string",
    "members":[
      "contact_id"
    ]
  }
}

Example response

{
  "jsonrpc":"2.0",
  "id":"number",
  "result":{
  }
}

List of returned errors

See the "List of errors for update methods" section.