Represents a set of CustomerQuery
filters used to limit the set of Customers
returned by SearchCustomers
.
Name | Type | Description | Notes |
---|---|---|---|
creation_source | CustomerCreationSourceFilter | A filter to select customers based on their creation source. | [optional] |
created_at | TimeRange | A filter to select customers based on when they were created. | [optional] |
updated_at | TimeRange | A filter to select customers based on when they were updated. | [optional] |
group_ids | FilterValue | A filter to select customers based on their group membership. The `group_ids` is a JSON object of the following general format: ``` "group_ids": { "any": ["{group_a_id}", "{group_b_id}", ...], "all": ["{group_1_id}", "{group_2_id}", ...], 'none": ["{group_i_id}", "{group_ii_id}", ...] } ``` You can use any combination of the above `group_ids` fields (also known as `FilterValue` properties) to specify how customers are selected based on their group membership. With the `any` option, the search returns customers in Groups `A` or `B` or ... of the list. With the `all` option, the search returns customers in Groups `1` and `2` and ... of the list With the `none` option, the search returns customers not in Groups `i` and not in `ii` and not in ... of the list. If any of the search conditions is not met, including when an invalid or non-existent group ID is provided, the result is an empty list. You can use the `group_ids` search filter with other available filters. You cannot use the `group_ids` filter to select customers based on segment membership. | [optional] |