Create a rule

Add a new routing rule to a redirect

Endpoint

POST /rules/redirect/:redirectId

Creates a new rule for the specified redirect. The rule will be created with the lowest priority (highest number) by default.

Path parameters

redirectId · string · required

The ID of the redirect to add the rule to

Request body

name · string · required

Human-readable name for the rule

description · string

Optional description explaining the rule’s purpose

type · RuleType · required

Rule type: force, percentage, or ab_experiment

conditions · RuleCondition[] · required

Array of conditions to evaluate. At least one condition is required.

Show RuleCondition properties

attribute · AttributeKey · required

The user attribute to evaluate (e.g., country, device_type, browser_name)

operator · OperatorKey · required

Comparison operator (e.g., equals, contains, in, greater_than)

value · string | number | string[] | number[] | [number, number]

Value to compare against. Type depends on operator:

• Single value for equals, contains, etc.
• Array for in, not_in
• Range tuple for between
• Omit for exists, not_exists

param · string

Required when attribute is query_param. Specifies which query parameter to check.

conditionLogic · ConditionLogic · required

How to combine multiple conditions: AND (all must match) or OR (any must match)

action · RuleAction · required

Action to perform when rule matches

Show RedirectAction (for type: force)

type · string · required

Must be redirect

url · string · required

Destination URL for redirect

Show PercentageRedirectAction (for type: percentage)

type · string · required

Must be percentage_redirect

url · string · required

Destination URL for redirected percentage

percentage · number · required

Percentage of traffic to redirect (0-100)

Show ABTestAction (for type: ab_experiment)

type · string · required

Must be ab_test

variants · ABTestVariant[] · required

Array of test variants. Percentages must sum to 100.

name · string · required

Variant name

percentage · number · required

Traffic percentage for this variant (0-100)

url · string · required

Destination URL for variant

startDate · string

ISO 8601 date when rule becomes active

endDate · string

ISO 8601 date when rule expires

metadata · Record<string, string | number | boolean>

Optional metadata key-value pairs

Response

message · string

Success message

rule · Rule

The created rule object

Show Rule properties

id · number

Rule ID

redirectId · number

Parent redirect ID

name · string

Rule name

description · string

Rule description

type · RuleType

Rule type

priority · number

Evaluation priority (lower = higher priority)

status · RuleStatus

Current status: active, inactive, or draft

conditions · RuleCondition[]

Array of conditions

conditionLogic · ConditionLogic

Condition combination logic

action · RuleAction

Rule action

startDate · string

Start date (ISO 8601)

endDate · string

End date (ISO 8601)

hitCount · number

Number of times rule has matched

createdBy · string

User who created the rule

metadata · Record<string, string | number | boolean>

Custom metadata

createdAt · string

Creation timestamp (ISO 8601)

updatedAt · string

Last update timestamp (ISO 8601)

Examples

Force redirect for mobile users

import { createRule } from '@quickleap/sdk';

const response = await createRule('redirect_123', {
  name: 'Mobile users to app',
  description: 'Redirect mobile traffic to mobile app',
  type: 'force',
  conditions: [
    {
      attribute: 'device_type',
      operator: 'equals',
      value: 'mobile'
    }
  ],
  conditionLogic: 'AND',
  action: {
    type: 'redirect',
    url: 'https://app.example.com'
  }
});

console.log(response.data.rule);

New rules are created with status draft by default. Use the toggle status endpoint to activate them.