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
| Key | Datatype | Required | Description |
|---|---|---|---|
enrollObjectsInWorkflows | boolean | A 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
| Key | Datatype | Required | Description |
|---|---|---|---|
Content-Type | string | ||
Accept | string |
RESPONSES
status: OK
{"updatedList":{"listId":"\u003cinteger\u003e","listVersion":"\u003cinteger\u003e","name":"\u003cstring\u003e","objectTypeId":"\u003cstring\u003e","processingStatus":"\u003cstring\u003e","processingType":"\u003cstring\u003e","createdAt":"\u003cdateTime\u003e","updatedAt":"\u003cdateTime\u003e","filtersUpdatedAt":"\u003cdateTime\u003e","deletedAt":"\u003cdateTime\u003e","createdById":"\u003cinteger\u003e","updatedById":"\u003cinteger\u003e","filterBranch":{"filterBranchOperator":"\u003cstring\u003e","filterBranchType":"OR","filterBranches":[{"value":"\u003cCircular reference to #/components/schemas/PublicOrFilterBranch detected\u003e"},{"value":"\u003cCircular reference to #/components/schemas/PublicOrFilterBranch detected\u003e"}],"filters":[{"filterType":"PROPERTY","operation":{"includeObjectsWithNoValueSet":"\u003cboolean\u003e","operationType":"BOOL","operator":"\u003cstring\u003e","value":"\u003cboolean\u003e"},"property":"\u003cstring\u003e"},{"filterType":"PROPERTY","operation":{"includeObjectsWithNoValueSet":"\u003cboolean\u003e","operationType":"BOOL","operator":"\u003cstring\u003e","value":"\u003cboolean\u003e"},"property":"\u003cstring\u003e"}]}}}