Create Refine Filter

Create a new RefineFilter in the workspace. The criteria array must contain at least one entry. Criteria are validated against the safe-condition whitelist — unsupported attributes/clauses return 422 with a pointer to the dev community. See the Refine Filters Skill for the full reference (attributes, clauses, worked examples).

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
integer
required
Body Params

BETA — RefineFilters are currently in beta. You can request access via the Funnel Coders community but keep in mind that BETA endpoints are subject to change.

Parameters for creating a new RefineFilter. The criteria array must contain at least one entry. Each criterion requires attribute and clause; value may be omitted for set/not-set clauses.

Supported conditions (public API)

The public API restricts criteria to the safe whitelist below. Requests outside this set return 422 with a pointer to the dev community for new-condition requests.

ConditionAllowed clausesNotes
email_address, first_name, last_nameeq, swText — equals & starts_with only.
anonymouseq, dneBoolean-style option.
created_at, unsubscribed_at, last_activityAll standard date clausesIndexed datetime columns.
tags.ideq, dne, in, ninTag membership — must reference workspace-owned tag ids.
has_affiliate_attribution, has_active_affiliate_attribution, referred_by_affiliateAll standard clausesAffiliate attribution lookups.
email_suppressionst, nst, eq, inEmail suppression set/not-set or membership.
received_broadcast, opened_broadcast, clicked_broadcasteq, inMust include a specific broadcast id.
opted_in_funnel_step, opted_in_funnel_at, opted_in_on_standalone_pageeq, inMust include a specific funnel/step/page id.

Conjunction is restricted to and. See the full reference at the Refine Filters Skill.

refine_filter
object
required
Responses

Language
Credentials
Bearer
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json