Skip to main content

Update User Preference

Description

You can use this API to update the user preference on tracking presets.

OAuth Scope: 

SalesIQ.userpreferences.UPDATE

Requested Payload:

  • view (Mandatory): To choose between the ring and the list view.
  •  hide_other_agent_connected_visitors (Mandatory): Decide whether or not to hide the agents who are already engaged in assisting other visitors.

URL:

Copiedhttps://{zohosalesiq_server_uri}/api/v2/{screenname}/userpreferences/tracking

Example

Copiedhttps://salesiq.zoho.com/api/v2/zylkerinc/userpreferences/tracking

Payload

Copied{
  "view": "ring",
  "hide_other_agent_connected_visitors": "enabled"
}

Success Response

Copied{
  "url": "/api/v2/test121/userpreferences/tracking",
  "object": "userpreference_config",
  "data": {
    "tracking": {
      "applied_preset": {
        "enabled": true,
        "name": "Chats",
        "applied": false,
        "description": "Filters prospects based on chat count",
        "rule": {
          "ring_three": [
            {
              "or_criteria": [
                {
                  "comparator": "greater_than",
                  "values": [
                    "3"
                  ],
                  "field_name": "number_of_past_chats"
                }
              ]
            }
          ],
          "ring_two": [
            {
              "or_criteria": [
                {
                  "comparator": "greater_than",
                  "values": [
                    "5"
                  ],
                  "field_name": "number_of_past_chats"
                }
              ]
            }
          ],
          "ring_four": [
            {
              "or_criteria": [
                {
                  "comparator": "greater_than",
                  "values": [
                    "1"
                  ],
                  "field_name": "number_of_past_chats"
                }
              ]
            }
          ],
          "ring_one": [
            {
              "or_criteria": [
                {
                  "comparator": "greater_than",
                  "values": [
                    "7"
                  ],
                  "field_name": "number_of_past_chats"
                }
              ]
            }
          ]
        },
        "modified_time": "1560935162552",
        "system_generated": true,
        "id": "40526000000002071"
      },
      "view": "ring",
      "hide_other_agent_connected_visitors": "enabled"
    }
  }
}