Filters

Update a filter

Change a filter's action, condition, field or stages.

type, scope and target cannot change - delete the filter and create it again. Values are changed through their own endpoint.

patch/v2/filters/{filter}

Request

  • Base URL: https://api.leadprosper.io/public
  • URL: https://api.leadprosper.io/public/v2/filters/{filter}
  • Auth: one of:
    • HTTP bearer
    • API key in query parameter api_token

Path parameters

filterinteger required

Filter id. Globally unique.

Request body

action'ALLOW' | 'BLOCK'
condition'MATCHES_ANY' | 'REGEX' | 'MD5' | 'DOMAINS_LIST' | 'ONE_OF' | 'EQUAL_TO' | 'NOT_EQUAL_TO' | 'GREATER_THAN' | 'LESS_THAN' | 'GREATER_OR_EQUAL_TO' | 'LESS_OR_EQUAL_TO' | 'BETWEEN' | 'AGE_GREATER_THAN' | 'AGE_LESS_THAN' | 'AGE_EQUAL_TO' | 'AGE_NOT_EQUAL_TO' | 'AGE_GREATER_OR_EQUAL_TO' | 'AGE_LESS_OR_EQUAL_TO' | 'AGE_BETWEEN'

How values are compared. Which ones a field takes depends on its type:

Field typeConditions
text, phone, postal-code, ip, urlMATCHES_ANY, REGEX
emailMATCHES_ANY, MD5, DOMAINS_LIST, REGEX
stateMATCHES_ANY
enumEQUAL_TO, ONE_OF
numericGREATER_THAN, LESS_THAN, EQUAL_TO, NOT_EQUAL_TO, GREATER_OR_EQUAL_TO, LESS_OR_EQUAL_TO, BETWEEN, ONE_OF
date-timethe numeric ones except ONE_OF, and every AGE_*
dobevery AGE_*
a computed field, lp_subid1, lp_subid2MATCHES_ANY, REGEX
lp_supplier_idEQUAL_TO, NOT_EQUAL_TO, ONE_OF

Must be one the field takes. MATCHES_ANY, REGEX, MD5 and DOMAINS_LIST can be swapped for one another and keep the values; a change to or from any other condition needs values, and answers 409 without them.

fieldstring

A field name, for FIELD and COMPUTED_FIELD filters. Changing it needs values, and answers 409 without them.

run_onstring[]

COMPUTED_FIELD filters only. At least one stage the campaign offers: POST always, PING with a ping-post exchange, PREPING with the pre-ping dupe checker.

valuesstring[]

The complete new value set. Required alongside a field change, or a condition change that cannot keep the values.

At least one, each at most 150 characters. What a value is depends on the filter:

FilterValues
a state fieldthe codes of the field's country, such as CA
an enum fieldthe field's own allowed_values
lp_supplier_idsupplier ids, from suppliers[].id
BETWEEN, AGE_BETWEENexactly two: ["18", "65"]
any other comparison (EQUAL_TO, GREATER_THAN, AGE_LESS_THAN, ...)exactly one
MATCHES_ANY, REGEX, MD5, DOMAINS_LIST, ONE_OFone or more
DAY_HOURwindows: mon|09:00 AM|05:00 PM|America/New_York
BLOCK_DATESdates as MM/DD
MIN_ONE_FIELDfield names
timezone'America/New_York' | 'America/Chicago' | 'America/Denver' | 'America/Phoenix' | 'America/Los_Angeles' | 'America/Anchorage' | 'America/Rio_Branco' | 'America/Manaus' | 'America/Sao_Paulo' | 'America/Noronha' | 'UTC' | 'Europe/London' | 'Europe/Berlin' | 'Europe/Bucharest' | 'Australia/Sydney' | 'Australia/Perth' | 'Pacific/Auckland'

BLOCK_DATES filters only.

Response

Success

statusstring

Changes

No recorded changes to this operation across all 1 revision of this API.