API reference/Kits

Claim market exclusivity

Reserve a visible promotion in this workspace's own market for one year, subject to the plan's claim limit. Other stations in that market lose catalog visibility.

POST/api/v1/claims/{slug}

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

Response

JSON response with status 200.

Requests and errors →

Illustrative arguments

{
  "slug": "YOUR_VALUE"
}

Input schema

{
  "type": "object",
  "properties": {
    "slug": {
      "type": "string",
      "minLength": 1,
      "maxLength": 64,
      "pattern": "^[a-z0-9][a-z0-9-]*$"
    }
  },
  "required": [
    "slug"
  ],
  "additionalProperties": false
}

Response schema

{
  "type": "object",
  "properties": {
    "ok": {
      "type": "boolean",
      "const": true
    }
  },
  "required": [
    "ok"
  ],
  "additionalProperties": false
}