Skip to content

Creates a contact group in the address book

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

Request parameters

Name Type Required Description
access_token string yes Session key used to authenticate the request
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 add to the group. To retrieve contacts, call "get.contacts".

Response parameters

Name Type Required Description
id number yes Unique contact group ID

Example request

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

Example response

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

List of returned errors

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