API reference/Kits

Save sponsor rate card

Replace station prices for existing catalog sponsor tiers. Deliverables stay catalog-defined; an empty array resets to suggestions.

PATCH/api/v1/kits/{slug}/rates

Authentication

Send your workspace key as xi-api-key or Authorization: Bearer.

kits:writewrite

Parameters

Named placeholders belong in the path. Other arguments use a JSON body.

slugRequired: string
tiersRequired: array

Response

JSON response with status 200.

Requests and errors →

Illustrative arguments

{
  "slug": "YOUR_VALUE",
  "tiers": [
    {
      "name": "YOUR_VALUE",
      "price": 0,
      "min": 0,
      "max": 0
    }
  ]
}

Input schema

{
  "type": "object",
  "properties": {
    "slug": {
      "type": "string",
      "minLength": 1,
      "maxLength": 64,
      "pattern": "^[a-z0-9][a-z0-9-]*$"
    },
    "tiers": {
      "maxItems": 20,
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "name": {
            "type": "string",
            "minLength": 1,
            "maxLength": 60
          },
          "price": {
            "type": "integer",
            "minimum": 0,
            "maximum": 10000000
          },
          "min": {
            "type": "integer",
            "minimum": 0,
            "maximum": 10000
          },
          "max": {
            "type": "integer",
            "minimum": 0,
            "maximum": 10000
          }
        },
        "required": [
          "name",
          "price",
          "min",
          "max"
        ],
        "additionalProperties": false
      }
    }
  },
  "required": [
    "slug",
    "tiers"
  ],
  "additionalProperties": false
}

Response schema

{
  "type": "object",
  "properties": {
    "kit": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "slug": {
          "type": "string"
        },
        "state": {
          "type": "string",
          "enum": [
            "idea",
            "pitched",
            "sold",
            "running",
            "recapped",
            "lost"
          ]
        },
        "advertiser": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ]
        },
        "price": {
          "anyOf": [
            {
              "type": "number"
            },
            {
              "type": "null"
            }
          ]
        },
        "closedOn": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ]
        },
        "updatedAt": {
          "type": "string"
        },
        "rateCard": {}
      },
      "required": [
        "id",
        "slug",
        "state",
        "advertiser",
        "price",
        "closedOn",
        "updatedAt",
        "rateCard"
      ],
      "additionalProperties": false
    }
  },
  "required": [
    "kit"
  ],
  "additionalProperties": false
}