provider Filters PUT /filters/{id}
@utdk/pipedrive /filters/{id}
Update filter
Updates an existing filter.
id path required
The ID of the filter
integer
include_field_code query
If set to `true`, each condition in the response includes a `field_code` field identifying the field by its code name
boolean

Try it

Authentication
Configure credentials for Pipedrive API v1
updatefilter
PUT/filters/{id}
Updates an existing filter.

Parameters

required

The ID of the filter

If set to `true`, each condition in the response includes a `field_code` field identifying the field by its code name

Input

The name of the filter

required

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: `{"glue":"and","conditions":[{"glue":"and","conditions": [CONDITION_OBJECTS]},{"glue":"or","conditions":[CONDITION_OBJECTS]}]}`. Replace `CONDITION_OBJECTS` with JSON objects of the following structure: `{"object":"","field_id":"", "operator":"","value":"", "extra_value":""}` 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: `"person"`, `"deal"`, `"organization"`, `"product"`, `"activity"` and you can use these types of operators depending on what type of a field you have: `"IS NOT NULL"`, `"IS NULL"`, `"<="`, `">="`, `"<"`, `">"`, `"!="`, `"="`, `"LIKE '$%'"`, `"LIKE '%$%'"`, `"NOT LIKE '$%'"`. To get a better understanding of how filters work try creating them directly from the Pipedrive application.

Configure credentials above to enable sending.

Code snippet
Updates live as you fill in the form above.

TypeScript

import pipedrive from '@utdk/pipedrive';

await pipedrive.updatefilter()