Sign in

v1

latestOpenAPI 3.1.02026-07-241765501.1 MB
Searchandising campaigns

Update campaign

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

Update a campaign. It will update only the fields that are present in the request.

patch/v1/campaigns/{campaign_id}

Path parameters

campaign_idinteger required

Query parameters

keystring required

The key of the index to use.

Example:key_K2pX7vBnU0bgA5xp
sectionstring

The section of the index to use. Defaults to Products.

Example:Products
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

request_tag_name'client_ip' | 'client_version' | 'geo_city' | 'geo_country' | 'geo_country_iso_code' | 'geo_region' | 'dt_weekday' | 'dt_timeofday' | 'user_segment' | 'autogenerated_user_segment' | 'dynamic_segment'
request_tag_valuestring

Request tag value to be used to activate this entity for, used only with request_tag_name.

start_timestring date-time

The start time of the campaign.

end_timestring date-time

The end time of the campaign.

namestring

The name of the campaign.

descriptionstring

The description of the campaign.

Example request

{
  "request_tag_value": "premium",
  "start_time": "2024-03-01T00:00:00",
  "end_time": "2024-03-31T23:59:59",
  "name": "Spring Sale",
  "description": "Seasonal promotion campaign",
  "refined_queries": [
    {
      "query": "shoes"
    }
  ],
  "refined_filters": [
    {
      "filter_name": "brand",
      "filter_value": "Nike"
    }
  ],
  "refined_recommendation_contexts": [
    {
      "pod_id": "homepage-recs",
      "condition": {
        "item_id": "nike-shoes"
      }
    }
  ],
  "boost_rules": [
    {
      "request_tag_value": "premium",
      "active": true,
      "start_time": "2024-03-06T16:05:19",
      "end_time": "2024-03-06T17:05:19",
      "campaign_id": 1,
      "rule": {
        "item_ids": [
          "nike-shoes"
        ],
        "boost": -5
      }
    }
  ],
  "blacklist_rules": [
    {
      "request_tag_value": "premium",
      "active": true,
      "start_time": "2024-03-06T16:05:19",
      "end_time": "2024-03-06T17:05:19",
      "campaign_id": 1,
      "rule": {
        "item_ids": [
          "nike-shoes"
        ]
      }
    }
  ],
  "slot_rules": [
    {
      "request_tag_value": "premium",
      "active": true,
      "start_time": "2024-03-06T16:05:19",
      "end_time": "2024-03-06T17:05:19",
      "campaign_id": 1,
      "rule": {
        "item_id": "nike-shoes",
        "variation_slice": {
          "color": [
            "red"
          ]
        },
        "position": 1,
        "labels": {
          "promoted": true
        }
      }
    }
  ],
  "content_rules": [
    {
      "request_tag_value": "premium",
      "active": true,
      "start_time": "2024-03-06T16:05:19",
      "end_time": "2024-03-06T17:05:19",
      "campaign_id": 1,
      "rule": {
        "data": {
          "banner_url": "https://example.com/banner.jpg"
        }
      }
    }
  ],
  "filters_slot_rules": [
    {
      "request_tag_value": "premium",
      "active": true,
      "start_time": "2024-03-06T16:05:19",
      "end_time": "2024-03-06T17:05:19",
      "campaign_id": 1,
      "rule": {
        "position_ranges": [
          {
            "start": 1,
            "end": 3
          }
        ]
      }
    }
  ],
  "whitelist_rule": {
    "request_tag_value": "premium",
    "active": true,
    "start_time": "2024-03-06T16:05:19",
    "end_time": "2024-03-06T17:05:19",
    "campaign_id": 1
  },
  "variation_slicing_rule": {
    "request_tag_value": "premium",
    "active": true,
    "start_time": "2024-03-06T16:05:19",
    "end_time": "2024-03-06T17:05:19",
    "campaign_id": 1,
    "rule": {
      "facet_names": [
        "color"
      ]
    }
  },
  "metadata_json": {
    "goal": "increase_conversions",
    "goal_description": "Boost spring sales"
  }
}

Response

OK

request_tag_name'client_ip' | 'client_version' | 'geo_city' | 'geo_country' | 'geo_country_iso_code' | 'geo_region' | 'dt_weekday' | 'dt_timeofday' | 'user_segment' | 'autogenerated_user_segment' | 'dynamic_segment'
request_tag_valuestring

Request tag value to be used to activate this entity for, used only with request_tag_name.

start_timestring date-time

The start time of the campaign.

end_timestring date-time

The end time of the campaign.

namestring

The name of the campaign.

descriptionstring

The description of the campaign.

idinteger required

The ID of the campaign.

created_atstring date-time required

The creation time of the campaign.

updated_atstring date-time required

The last updated time of the campaign.

Example response

{
  "request_tag_value": "premium",
  "start_time": "2024-03-01T00:00:00",
  "end_time": "2024-03-31T23:59:59",
  "name": "Spring Sale",
  "description": "Seasonal promotion campaign",
  "refined_queries": [
    {
      "query": "shoes"
    }
  ],
  "refined_filters": [
    {
      "filter_name": "brand",
      "filter_value": "Nike"
    }
  ],
  "refined_recommendation_contexts": [
    {
      "pod_id": "homepage-recs",
      "condition": {
        "item_id": "nike-shoes"
      }
    }
  ],
  "boost_rules": [
    {
      "request_tag_value": "premium",
      "active": true,
      "start_time": "2024-03-06T16:05:19",
      "end_time": "2024-03-06T17:05:19",
      "campaign_id": 1,
      "rule": {
        "item_ids": [
          "nike-shoes"
        ],
        "boost": -5
      }
    }
  ],
  "blacklist_rules": [
    {
      "request_tag_value": "premium",
      "active": true,
      "start_time": "2024-03-06T16:05:19",
      "end_time": "2024-03-06T17:05:19",
      "campaign_id": 1,
      "rule": {
        "item_ids": [
          "nike-shoes"
        ]
      }
    }
  ],
  "slot_rules": [
    {
      "request_tag_value": "premium",
      "active": true,
      "start_time": "2024-03-06T16:05:19",
      "end_time": "2024-03-06T17:05:19",
      "campaign_id": 1,
      "rule": {
        "item_id": "nike-shoes",
        "variation_slice": {
          "color": [
            "red"
          ]
        },
        "position": 1,
        "labels": {
          "promoted": true
        }
      }
    }
  ],
  "content_rules": [
    {
      "request_tag_value": "premium",
      "active": true,
      "start_time": "2024-03-06T16:05:19",
      "end_time": "2024-03-06T17:05:19",
      "campaign_id": 1,
      "rule": {
        "data": {
          "banner_url": "https://example.com/banner.jpg"
        }
      }
    }
  ],
  "filters_slot_rules": [
    {
      "request_tag_value": "premium",
      "active": true,
      "start_time": "2024-03-06T16:05:19",
      "end_time": "2024-03-06T17:05:19",
      "campaign_id": 1,
      "rule": {
        "position_ranges": [
          {
            "start": 1,
            "end": 3
          }
        ]
      }
    }
  ],
  "whitelist_rule": {
    "request_tag_value": "premium",
    "active": true,
    "start_time": "2024-03-06T16:05:19",
    "end_time": "2024-03-06T17:05:19",
    "campaign_id": 1
  },
  "variation_slicing_rule": {
    "request_tag_value": "premium",
    "active": true,
    "start_time": "2024-03-06T16:05:19",
    "end_time": "2024-03-06T17:05:19",
    "campaign_id": 1,
    "rule": {
      "facet_names": [
        "color"
      ]
    }
  },
  "metadata_json": {
    "goal": "increase_conversions",
    "goal_description": "Boost spring sales"
  }
}