v1

latestOpenAPI 3.1.02026-07-241765501.1 MB

Redirect rules

Replace redirect rule

🔐 This endpoint requires HTTP authentication (either Basic or Bearer). For authenticating with Bearer token, required scopes are: redirects(w).

Replace a redirect rule

put/v1/redirect_rules/{redirect_rule_id}

Path parameters

redirect_rule_idinteger required

Query parameters

keystring required

The key of the index to use.

Example:key_K2pX7vBnU0bgA5xp

cstring

The ID of the client and version that the request is coming from, such as cio-js-2.90.

Example:cio-js-2.90

Request body

urlstring required

The target URL for the redirect rule.

start_timestring date-time

The start time for the redirect rule.

end_timestring date-time

The end time for redirect rule.

user_segmentsstring[]

A list of user segments for the redirect rule.

metadataobject

The metadata for the redirect rule.

Example request

{
  "url": "/landing-page",
  "matches": [
    {
      "pattern": "take me here",
      "match_type": "EXACT"
    }
  ],
  "start_time": "2025-01-01T00:00:00",
  "end_time": "2025-12-31T23:59:59",
  "user_segments": [
    "premium"
  ],
  "metadata": {
    "campaign": "summer"
  }
}

Response

idinteger required

The identifier for the redirect rule match.

start_timestring date-time

The start time for the redirect rule.

end_timestring date-time

The end time for the redirect rule.

urlstring required

The target URL for redirect the rule.

metadataobject

The metadata for the redirect rule.

last_updatedstring date-time

The last updated time for the redirect rule.

user_segmentsstring[]

A list of user segments for the redirect rule.

Example response

{
  "matches": [
    {
      "pattern": "take me here",
      "match_type": "EXACT"
    }
  ]
}