Update List Filter Definition

PUT {{baseUrl}}/crm/v3/lists/:listId/update-list-filters?enrollObjectsInWorkflows=false

Update the filter branch definition of a DYNAMIC list. Once updated, the list memberships will be re-evaluated and updated to match the new definition.

Request Params

KeyDatatypeRequiredDescription
enrollObjectsInWorkflowsbooleanA flag indicating whether or not the memberships added to the list as a result of the filter change should be enrolled in workflows that are relevant to this list.

Request Body

{"filterBranch"=>{"filterBranchOperator"=>"<string>", "filterBranchType"=>"OR", "filterBranches"=>[{"value"=>"<Circular reference to #/components/schemas/PublicOrFilterBranch detected>"}, {"value"=>"<Circular reference to #/components/schemas/PublicOrFilterBranch detected>"}], "filters"=>[{"filterType"=>"PROPERTY", "operation"=>{"includeObjectsWithNoValueSet"=>"<boolean>", "operationType"=>"BOOL", "operator"=>"<string>", "value"=>"<boolean>"}, "property"=>"<string>"}, {"filterType"=>"PROPERTY", "operation"=>{"includeObjectsWithNoValueSet"=>"<boolean>", "operationType"=>"BOOL", "operator"=>"<string>", "value"=>"<boolean>"}, "property"=>"<string>"}]}}

HEADERS

KeyDatatypeRequiredDescription
Content-Typestring
Acceptstring

RESPONSES

status: OK

{&quot;updatedList&quot;:{&quot;listId&quot;:&quot;\u003cinteger\u003e&quot;,&quot;listVersion&quot;:&quot;\u003cinteger\u003e&quot;,&quot;name&quot;:&quot;\u003cstring\u003e&quot;,&quot;objectTypeId&quot;:&quot;\u003cstring\u003e&quot;,&quot;processingStatus&quot;:&quot;\u003cstring\u003e&quot;,&quot;processingType&quot;:&quot;\u003cstring\u003e&quot;,&quot;createdAt&quot;:&quot;\u003cdateTime\u003e&quot;,&quot;updatedAt&quot;:&quot;\u003cdateTime\u003e&quot;,&quot;filtersUpdatedAt&quot;:&quot;\u003cdateTime\u003e&quot;,&quot;deletedAt&quot;:&quot;\u003cdateTime\u003e&quot;,&quot;createdById&quot;:&quot;\u003cinteger\u003e&quot;,&quot;updatedById&quot;:&quot;\u003cinteger\u003e&quot;,&quot;filterBranch&quot;:{&quot;filterBranchOperator&quot;:&quot;\u003cstring\u003e&quot;,&quot;filterBranchType&quot;:&quot;OR&quot;,&quot;filterBranches&quot;:[{&quot;value&quot;:&quot;\u003cCircular reference to #/components/schemas/PublicOrFilterBranch detected\u003e&quot;},{&quot;value&quot;:&quot;\u003cCircular reference to #/components/schemas/PublicOrFilterBranch detected\u003e&quot;}],&quot;filters&quot;:[{&quot;filterType&quot;:&quot;PROPERTY&quot;,&quot;operation&quot;:{&quot;includeObjectsWithNoValueSet&quot;:&quot;\u003cboolean\u003e&quot;,&quot;operationType&quot;:&quot;BOOL&quot;,&quot;operator&quot;:&quot;\u003cstring\u003e&quot;,&quot;value&quot;:&quot;\u003cboolean\u003e&quot;},&quot;property&quot;:&quot;\u003cstring\u003e&quot;},{&quot;filterType&quot;:&quot;PROPERTY&quot;,&quot;operation&quot;:{&quot;includeObjectsWithNoValueSet&quot;:&quot;\u003cboolean\u003e&quot;,&quot;operationType&quot;:&quot;BOOL&quot;,&quot;operator&quot;:&quot;\u003cstring\u003e&quot;,&quot;value&quot;:&quot;\u003cboolean\u003e&quot;},&quot;property&quot;:&quot;\u003cstring\u003e&quot;}]}}}