Skip to content

Latest commit

 

History

History
11 lines (8 loc) · 2.11 KB

AddFilterRequest.md

File metadata and controls

11 lines (8 loc) · 2.11 KB

# AddFilterRequest

Properties

Name Type Description Notes
name string The name of the filter
conditions object The conditions of the filter as a JSON object. Please note that a maximum of 16 conditions is allowed per filter and `date` values must be supplied in the `YYYY-MM-DD` format. It requires a minimum structure as follows: `{&quot;glue&quot;:&quot;and&quot;,&quot;conditions&quot;:[{&quot;glue&quot;:&quot;and&quot;,&quot;conditions&quot;: [CONDITION_OBJECTS]},{&quot;glue&quot;:&quot;or&quot;,&quot;conditions&quot;:[CONDITION_OBJECTS]}]}`. Replace `CONDITION_OBJECTS` with JSON objects of the following structure: `{&quot;object&quot;:&quot;&quot;,&quot;field_id&quot;:&quot;&quot;, &quot;operator&quot;:&quot;&quot;,&quot;value&quot;:&quot;&quot;, &quot;extra_value&quot;:&quot;&quot;}` or leave the array empty. Depending on the object type you should use another API endpoint to get `field_id`. There are five types of objects you can choose from: `&quot;person&quot;`, `&quot;deal&quot;`, `&quot;organization&quot;`, `&quot;product&quot;`, `&quot;activity&quot;` and you can use these types of operators depending on what type of a field you have: `&quot;IS NOT NULL&quot;`, `&quot;IS NULL&quot;`, `&quot;<=&quot;`, `&quot;>=&quot;`, `&quot;<&quot;`, `&quot;>&quot;`, `&quot;!=&quot;`, `&quot;=&quot;`, `&quot;LIKE '$%'&quot;`, `&quot;LIKE '%$%'&quot;`, `&quot;NOT LIKE '$%'&quot;`. To get a better understanding of how filters work try creating them directly from the Pipedrive application.
type FilterType The type of filter to create

[Back to Model list] [Back to API list] [Back to README]