Patch catalog filter rule

project_id required	integer Project ID. You can find this parameter in your Publisher Account next to the name of the project. Example: 44056
rule_id required	number Rule ID. Example: 1

Request Body schema: application/json

name

string [ 1 .. 255 ] characters ^\S

Readable name of a rule. Used to display a rule in Publisher Account.

is_enabled

boolean

If rule is enabled.

is_satisfied_for_unauth

boolean

Whether the item is displayed to unauthorized users. If true, the item is displayed to the unauthorized user regardless of catalog display rules. false by default.

Array of type = string (object) or type = number (object) or type = date (object) [ 1 .. 100 ] items

Conditions for validating user attributes. Determine item availability in the catalog based on whether user attributes match all specified conditions.

Array ([ 1 .. 100 ] items)

One of:

attribute

required

string [ 1 .. 255 ] characters ^[-_.\d\w]+$

User attribute code.

operator

required

string

Type of operation performed by condition. For string attribute type.

Enum:	Description
eq	Equals
ne	Not equals

value

required

string <= 255 characters

Condition value which user attribute value will be compared to. Type depends on attribute type.

type

required

string

User attribute type.

Value: "string"

can_be_missing

boolean

Indicates that the condition is met even if attribute is missing from user attributes. Pass true to show the item to users who don't have this attribute. Users who have the attribute, but the value does not match that specified in the condition, will not see the item. false — users who have the attribute, but the value does not match that specified in the condition, or the attribute is missing, will not see the item.

Array of objects or objects [ 1 .. 100 ] items

Array ([ 1 .. 100 ] items)

One of:

Items which are shown to a user if their attribute values meet conditions.

item_id

required

number

Item ID.

Responses

204

Update was successful.

401

Authentication not passed or wrong. Make sure you used authentication or correct credentials.

422

Request validation error.

Request samples

application/json

{"is_enabled": false
}

Response samples

application/json

{"statusCode": 401,
"errorCode": 1501,
"errorMessage": "[0401-1501]: Authorization failed: Authorization header not sent",
"transactionId": "x-x-x-x-transactionId-mock-x-x-x"
}