BigCommerce · Schema

301RedirectUpsert

Data necessary to create or update a redirect. If there’s a conflict on the from_path and site_id, the redirect will be overwritten with new data.

E-CommerceRetailCatalogOrdersCheckoutPaymentsSaaS

Properties

Name	Type	Description
from_path	string
site_id	integer
to	object

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/301RedirectUpsert",
  "title": "301RedirectUpsert",
  "required": [
    "from_path",
    "site_id"
  ],
  "type": "object",
  "properties": {
    "from_path": {
      "type": "string",
      "example": "/old-url/"
    },
    "site_id": {
      "type": "integer"
    },
    "to": {
      "$ref": "#/components/schemas/RedirectTo"
    }
  },
  "description": "Data necessary to create or update a redirect. If there\u2019s a conflict on the from_path and site_id, the redirect will be overwritten with new data."
}