Skip to main content
PATCH
cURL
Updates a rule’s type, values, conditional, or metadata key. Visit the conditional operators reference for more information on how to use them. See the create rules endpoint for more examples.

Authorizations

public-api-key
string
header
required
private-secret-key
string
header
required

Path Parameters

campaign_id
string
required

The campaign identifier (UUID).

rule_id
string
required

The rule identifier (UUID).

Body

application/json
rule_type
string

New rule type (see Rule Types Reference)

values
string[]

New values array. Not required for UNIQUE_BY_USER.

conditional
string

New comparison operator. Not required for USER_COMMS_PER_DAY or UNIQUE_BY_USER. See Conditional Operators Reference.

metadata_key
string

New metadata key. Required when rule_type is METADATA. The metadata field name to evaluate.

Response

200 - application/json