Add a Visitor Routing Rule

Description

You can use this API to add a visitor routing rule.

Requested Payload:

and_criteria (Mandatory): To add an additional condition and criteria to the visitor routing rule. You can specify a group of or_criteria within the and_criteria.
- or_criteria : Specifies a set of criteria containing the comparator, values and fieldname ie.,you can provide more than one criteria and the rule will execute if the visitor matches any of the given criteria.
- field_name : Fields that you set to filter the visitor who matches the rule.
- sub_fields: The sub field that you set to filter the visitor who matches the rule.
- comparator : The comparator strings for that specific rule you have set is used to match the values (eg: Contains, Equals to, etc.)
- values : The values that you have defined for each field that the visitor should obtain to match the rule.
- integ_name : The name of the integration.
userset : To notify the list of users who matches the rule to a specific operator.
- department_ids : To list the department IDs
- operator_ids : To list the operator IDs
- dynamic_users : To specify the details of the user ( whether the user is a CRM attender / Last available attender / All available users.)
app_id (Mandatory) : To embed the id of the website.
routing_type : The type of routing rule you have set to route your website visitors.
id: Unique Id that specifies the visitor routing rule.

OAuth Scope:

visitorroutingrules.CREATE

You can use the Field name, Comparator and values to populate the criteria of the visitor routing rule. You can also find the data type of these keys in the criteria of the fields section.

Field Name	Comparators	Values
landing_page_url	is, is_not, begins_with, ends_with, contains, not_contains
region	is_equal_to, not_equals	south_america, canada, asia_pacific, united_kingdom, europe_middle_east_and_africa
triggered_status	is, is_not
referer	is_equal_to, begins_with, ends_with, contains, not_equals, not_contains, matches, not_matches
landing_page_title	is_equal_to, begins_with, ends_with, contains, not_equals, not_contains, matches, not_matches
campaign_source	is_equal_to, begins_with, ends_with, contains, not_equals, not_contains, matches, not_matches
campaign_term	is_equal_to, begins_with, ends_with, contains, not_equals, not_contains, matches, not_matches
campaign_medium	is_equal_to, begins_with, ends_with, contains, not_equals, not_contains, matches, not_matches
campaign_content	is_equal_to, begins_with, ends_with, contains, not_equals, not_contains, matches, not_matches
utm_campaign_name	is_equal_to, begins_with, ends_with, contains, not_equals, not_contains, matches, not_matches
email	is_equal_to, begins_with, ends_with, contains, not_equals, not_contains, matches, not_matches
country	is_equal_to, not_equals	Papua New Guinea, Combodia, Paraguay, Kazakhstan, Solomon Islands, Bahamas, Montserrat, Mali, Marshall Islands, Guadeloupe, Panama, Argentina, Isle Of Man, Seychelles, Zambia, Belize, South Georgia And The South Sandwich islands, Bahrain, Congo, Namibia, Comoros, Faroe Islands, Finland, Netherlands Antilles, Georgia, Yemen, Puerto Rico, Eritrea, Viet Nam, Madagascar, Aruba, Sweden, Malawi, Andorra, Liechtenstein, Poland, Bulgaria, Jordan, Tunisia, Tuvalu, United Arab Emirates, Kenya, French Polynesia, Lebanon, Djibouti, Azerbaijan, Cuba, Czech Republic, Saint Lucia, Mauritania, Guernsey, Timor-leste, Mayotte, Israel, San Marino, Australia, Tajikistan, Myanmar, Cameroon, Gibraltar, Cyprus, Northern Mariana Islands, Malaysia, Iceland, Oman, Bosnia And Herzegovina, Armenia, Gabon, Luxembourg, Brazil, Algeria, Jersey, Slovenia, Ecuador, Colombia, Moldova, Lao People's Democratic Republic, Cocos (keeling) Islands, Vanuatu, United States Minor Outlying Islands, Honduras, Italy, Antarctica, Nauru, Guinea-bissau, Haiti, Afghanistan, Russian Federation, Burundi, Singapore, French Guiana, American Samoa, Netherlands, China, Martinique, The Democratic Republic Of Congo, Kyrgyzstan, Wallis And Futuna, Saint Pierre And Miquelon, Reunion, Bhutan, Romania, Togo, Philippines, Uzbekistan, Pitcairn, British Virgin Islands, Zimbabwe, British Indian Ocean Territory, Montenegro, Indonesia, Dominica, Benin, Angola, Sudan, Brunei Darussalam, Portugal, New Caledonia, North Korea, Grenada, Greece, Cayman Islands, Mongolia, Latvia, Iran, Morocco, Guatemala, Guyana, Iraq, Cote D'ivoire, Chile, Holy See (vatican City State), Nepal, Ukraine, Tanzania, Ghana, Saint Vincent And The Grenadines, Anguilla, India, Canada, Maldives, Turkey, Belgium, Taiwan, South Africa, Bermuda, Aland Islands, Jamaica, Peru, Turkmenistan, Germany, Fiji, Tokelau, Hong Kong, United States, Guinea, Somalia, Chad, Thailand, Equatorial Guinea, Kiribati, Costa Rica, Falkland Islands (malvinas), Kuwait, Nigeria, Croatia, Sao Tome And Principe, Syrian Arab Republic, Uruguay, Sri Lanka, Cook Islands, United Kingdom, Switzerland, Samoa, Palestine, Spain, Venezuela, Liberia, Burkina Faso, Swaziland, Palau, Turks And Caicos Islands, Estonia, Christmas island, Libyan Arab Jamahiriya, Niue, Svalbard And Jan Mayen, South Korea, Austria, Mozambique, El Salvador, Monaco, Guam, Central african republic, Lesotho, Tonga, Heard Island And Mcdonald Islands, Western Sahara, Hungary, Europe, Japan, Curacao, Belarus, Mauritius, Bouvet Island, Norfolk Island, Trinidad And Tobago, Albania, New Zealand, Senegal, Macedonia, Ethiopia, Egypt, Sierra Leone, Bolivia, Malta, Saudi Arabia, Cape Verde, Pakistan, Gambia, Qatar, Ireland, U.S. Virgin Islands, Slovakia, Lithuania, Serbia, France, Niger, Rwanda, Saint Kitts And Nevis, French Southern Territories, Bangladesh, Barbados, Nicaragua, Norway, Botswana, Macao, Dominican Republic, Denmark, Mexico, Uganda, Suriname, Micronesia, Saint Helena, Greenland, Antigua And Barbuda)
visitor_info	is_equal_to, between, greater_than, begins_with, ends_with, contains, not_equals
visitor_type	is_equal_to, not_equals	all, new, returning
number_of_past_chats	is_equal_to, between, greater_than, less_than, not_equals
leadscore	is_equal_to, between, greater_than, less_than, not_equals
operating_system	is_equal_to, not_equals	nokia, apple_ipad, sun_solaris, microsoft_windows, web_os, nintendo, apple_macintosh, apple_iphone, android, symbian, playstation, blackberry, linux, motorola, kindle
ip_address	is_equal_to, between
browser	is_equal_to, not_equals	opera, google_chrome, apple_safari, mozilla_firefox, microsoft_internet_explorer, unknown
search_engine	is_equal_to, not_equals	teoma, inktomi, yahoo, webcrawler, baidu, google, bing
current_visit_source	is_equal_to, not_equals	referral, adwords, direct, campaign, search_engine, social_media
first_visit_source	is_equal_to, not_equals	referral, adwords, direct, campaign, search_engine, social_media

URL:

Copiedhttps://{[zohosalesiq_server_uri](https://www.zoho.com/salesiq/help/developer-section/rest-api-v2.html)}/api/v2/{screenname}/visitorroutingrule

Example

Copiedhttps://salesiq.zoho.com/api/v2/zylker/visitorroutingrules

Payload:

Copied{
  "app_id": "44000000000047",
  "title": "first",
  "and_criteria": [
    {
      "or_criteria": [
        {
          "field_name": "browser",
          "values": [
            "google_chrome"
          ],
          "comparator": "is_equal_to"
        },
        {
          "field_name": "campaign_medium",
          "values": [
            "orset 1"
          ],
          "comparator": "contains"
        },
{
              "comparator": "is_equal_to",
              "sub_field": "No of Open Deals",
              "values": [
                  "12"
              ],
              "field_name": "crm_deal",
              "integ_name": "zohocrm"
          }
      ]
    }
  ],
  "routing_type": "route_to_selected_users",
  "userset": [
    {
      "operator_ids": [
        "44000000018001"
      ],
      "department_ids": [ 0003445678345 ],
      "dynamic_users": [ last_attender ]
    }
  ]
}

Sample Response:

Copied{
  "url": "/api/v2/revamp07/visitorroutingrules",
  "object": "visitor_routing_rules",
  "data": {
    "modified_time": 1546845430168,
    "id": 44000000014017,
     "stats": {
            "routed_count": "5",
            "replied_count": "4",
            "last_routed_time": "1546846597340",
            "triggered_count": "1"
     },        
     "app": {
            "name": "restapi",
            "id": "34139000000002043"
     },
    "enabled": true,
    "position": 29,
    "creator": {
      "id": 44000000000005
    },
    "title": "Zylker-campaigns",
    "created_time": 1546688046412,
    "and_criteria": [
      {
        "or_criteria": [
          {
            "field_name": "browser",
            "values": [
              "google_chrome"
            ],
            "comparator": "is_equal_to"
          },
          {
            "field_name": "campaign_medium",
            "values": [
              "orset 1"
            ],
            "comparator": "contains"
          },
{
              "comparator": "is_equal_to",
              "sub_field": "No of Open Deals",
              "values": [
                  "12"
              ],
              "field_name": "crm_deal",
              "integ_name": "zohocrm"
          }
        ]
      }
    ],
    "routing_type": "route_to_selected_users",
    "userset": [
      {
        "operator_ids": [
          "44000000018001"
        ],
        "department_ids": [],
        "dynamic_users": []
      }
    ],
    "condition": "at_least_one_user_online"
  }
}