Module filters_api

Source

Enums§

AddFilterError
struct for typed errors of method add_filter
DeleteFilterError
struct for typed errors of method delete_filter
DeleteFiltersError
struct for typed errors of method delete_filters
GetFilterError
struct for typed errors of method get_filter
GetFilterHelpersError
struct for typed errors of method get_filter_helpers
GetFiltersError
struct for typed errors of method get_filters
UpdateFilterError
struct for typed errors of method update_filter

Functions§

add_filter
Adds a new filter, returns the ID upon success. Note that in the conditions JSON object only one first-level condition group is supported, and it must be glued with ‘AND’, and only two second level condition groups are supported of which one must be glued with ‘AND’ and the second with ‘OR’. Other combinations do not work (yet) but the syntax supports introducing them in future. For more information, see the tutorial for <a href="https://pipedrive.readme.io/docs/adding-a-filter" target="_blank" rel="noopener noreferrer">adding a filter.
delete_filter
Marks a filter as deleted.
delete_filters
Marks multiple filters as deleted.
get_filter
Returns data about a specific filter. Note that this also returns the condition lines of the filter.
get_filter_helpers
Returns all supported filter helpers. It helps to know what conditions and helpers are available when you want to <a href="/docs/api/v1/Filters#addFilter">add or <a href="/docs/api/v1/Filters#updateFilter">update filters. For more information, see the tutorial for <a href="https://pipedrive.readme.io/docs/adding-a-filter" target="_blank" rel="noopener noreferrer">adding a filter.
get_filters
Returns data about all filters.
update_filter
Updates an existing filter.