Add a tracking preset
Description
You can use this API to create a tracking preset.
OAuth Scope:
trackingpresets.CREATE
Requested Payload:
- or_criteria: Specifies a set of criteria containing the comparator, values, and field name 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.
- name (Mandatory): Name of the preset
- description: A brief description of the preset
- applied: Preset is to be applied right away or not
- enabled: Preset is to be enabled or in the disabled state
- ring_four (Mandatory): Criteria to filter out a set of visitors for the ring 4.
- ring_three (Mandatory): Criteria to filter out a set of visitors for the ring 3.
- ring_two (Mandatory): Criteria to filter out a set of visitors for the ring 2.
- ring_one (Mandatory): Criteria to filter out a set of visitors for the ring 1.
You can use the Field name, Comparator and values to populate the criteria of the tracking preset. You can also find the data type of these keys in the criteria of the fields section.
URL:
Copiedhttps://{zohosalesiq_server_uri}/api/v2/{screenname}/trackingpresets
Example
Copiedhttps://salesiq.zoho.com/api/v2/zylkerionc/trackingpresets
Payload
Copied{
"applied": "false",
"ring_four": [
{
"or_criteria": [
{
"comparator": "is_equal_to",
"values": [
"vintage"
],
"field_name": "campaign_content"
},
{
"comparator": "is_equal_to",
"sub_field": "No of Open Deals",
"values": [
"12"
],
"field_name": "crm_deal",
"integ_name": "zohocrm"
}
]
}
],
"ring_one": [
{
"or_criteria": [
{
"comparator": "is_equal_to",
"values": [
"USA"
],
"field_name": "country"
}
]
}
],
"ring_three": [
{
"or_criteria": [
{
"comparator": "contains",
"values": [
"EOSS"
],
"field_name": "landing_page_title"
}
]
}
],
"name": "Vintage sale",
"description": "Prospects of vinatge campaign",
"ring_two": [
{
"or_criteria": [
{
"comparator": "contains",
"values": [
"home"
],
"field_name": "landing_page_url"
}
]
}
],
"enabled": "false"
}
Success Response
Copied{
"url": "/api/v2/test121/trackingpresets",
"object": "tracking_preset_config",
"data": {
"enabled": false,
"name": "Vintage sale",
"applied": false,
"description": "Prospects of vinatge campaign",
"rule": {
"ring_three": [
{
"or_criteria": [
{
"comparator": "contains",
"values": [
"EOSS"
],
"field_name": "landing_page_title"
},
{
"comparator": "is_equal_to",
"sub_field": "No of Open Deals",
"values": [
"12"
],
"field_name": "crm_deal",
"integ_name": "zohocrm"
}
]
}
],
"ring_two": [
{
"or_criteria": [
{
"comparator": "contains",
"values": [
"home"
],
"field_name": "landing_page_url"
}
]
}
],
"ring_four": [
{
"or_criteria": [
{
"comparator": "is_equal_to",
"values": [
"vintage"
],
"field_name": "campaign_content"
}
]
}
],
"ring_one": [
{
"or_criteria": [
{
"comparator": "is_equal_to",
"values": [
"USA"
],
"field_name": "country"
}
]
}
]
},
"modified_time": "1560934907865",
"id": "40526000001469001"
}
}