API reference/Stations

Update a station

Replace the call letters and format of an owned station.

PATCH/api/v1/stations/{stationId}

Authentication

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

stations:writewrite

Parameters

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

stationIdRequired: integerRange: any to 2147483647
callsRequired: string
formatRequired: string

Response

JSON response with status 200.

Requests and errors →

Illustrative arguments

{
  "stationId": 1,
  "calls": "YOUR_VALUE",
  "format": "YOUR_VALUE"
}

Input schema

{
  "type": "object",
  "properties": {
    "stationId": {
      "type": "integer",
      "exclusiveMinimum": 0,
      "maximum": 2147483647
    },
    "calls": {
      "type": "string",
      "minLength": 1,
      "maxLength": 16,
      "pattern": "^[A-Za-z0-9-]+$"
    },
    "format": {
      "type": "string",
      "maxLength": 64
    }
  },
  "required": [
    "stationId",
    "calls",
    "format"
  ],
  "additionalProperties": false
}

Response schema

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