v1

latestOpenAPI 3.1.0MIT2026-07-243952451019.0 KB

RefineFilter

Update Refine Filter

Update an existing RefineFilter. All fields are optional — only provided fields are updated. When criteria is supplied it replaces the entire criteria set (must contain at least one entry). 422 covers shape errors and safe-condition policy violations.

patch/refine_filters/{id}

Path parameters

idstring required

Public id of the RefineFilter to update.

Request body

Example request

{
  "refine_filter": {
    "conjunction": "and",
    "criteria": [
      {
        "attribute": "tags.id",
        "clause": "in",
        "value": [
          "tag-pub-id-1"
        ]
      },
      {
        "attribute": "created_at",
        "clause": "gte",
        "value": "2026-01-01"
      }
    ]
  }
}

Response

idinteger

Refine Filter ID

public_idstring

Obfuscated Refine Filter ID

workspace_idinteger

ID of the workspace this filter belongs to

namestring nullable

Optional human-readable name for the filter. Must be unique within the workspace when set.

filter_classstring

The filter class. Currently always ContactsFilter.

conjunction'and' | 'or'

How the criteria are joined — and (all must match) or or (any must match).

created_atstring date-time

Created at

updated_atstring date-time

Updated at

Example response

{
  "id": 42,
  "public_id": "AbCdEf",
  "workspace_id": 5,
  "name": "VIP newsletter audience",
  "filter_class": "ContactsFilter",
  "conjunction": "and",
  "criteria": [
    {
      "attribute": "tags.id",
      "clause": "in",
      "value": [
        "tag-pub-id-1"
      ]
    },
    {
      "attribute": "created_at",
      "clause": "gte",
      "value": "2026-01-01"
    }
  ],
  "created_at": "2026-04-01T12:00:00.000Z",
  "updated_at": "2026-04-01T12:00:00.000Z"
}