Skip to content

Create group contacts

Creating contact groups in address book

Method create.group_contacts
Description Creating contact groups in address book
Who has access Agent, Customer

Parameters of request

Title Type Required Description
access_token string yes 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 a contact group
members array no List of unique contacts IDs that belong to a group. You can get a list of contacts via the method "get.contacts"

Parameters of reply

Title Type Required Description
id number yes Unique ID of a contact group in address book

JSON request structure

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

JSON reply structure

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

List of returning errors

Refer to "List of errors for methods with the verb create"