Skip to content

Deletes one or more contacts from the address book

Method delete.contacts
Description Deletes one or more contacts from 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
id number yes, unless ids is provided ID of the contact to delete
ids array yes, unless id is provided IDs of the contacts to delete
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".

Example request

{
  "jsonrpc":"2.0",
  "id":"number",
  "method":"delete.contacts",
  "params":{
    "access_token":"string",
    "id":"number",
    "user_id":"number"
  }
}

Example response

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

List of returned errors

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