Skip to content

Deletes a site.

Method delete.sites
Description Deletes a site.
Who has access Agents and clients

Request parameters

Name Type Required Description
access_token string yes Access token used to authenticate the request.
id number yes Unique site ID.
user_id number no Unique ID of the client user on whose behalf the agent is making the request. Required for agents. To retrieve a list of client users, use "get.customer_users".

Example request

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

Example response

{
  "jsonrpc": "2.0",
  "id": "number",
  "result": {
    "data": {},
    "metadata": "object"
  }
}

Possible errors

See the "Errors for delete methods" section.