Platforms

displayStoryByIssue

boolean · required

Whether story lists are displayed by issue for this platform.

id

integer · int64 · required

Platform ID.

name

string · minLength: 0 · maxLength: 100 · required

Platform name.

position

integer · int32 · required

Ordinal number in the list.

typeCode

integer · enum · int32 · required

Platform type code.

Enum values:

Default: null

version

integer · int32 · required

Platform version.

externalId

string · minLength: 0 · maxLength: 50

Platform ID in the external system.

Manually entered publication dates for this platform.

printingTimeInDays

integer · int32 · min: 0 · max: 99

How many days before the publication is printed.

Available publication time slots for this platform.

upscoreDomain

string · minLength: 0 · maxLength: 50

Domain in the Upscore system.

Regular publication days for this platform.

POST/api/v2/platforms

curl https://api.kordiam.app/api/v2/platforms \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer <token>' \
  --data '{
  "displayStoryByIssue": true,
  "externalId": "externalId",
  "manualSchedule": [
    {
      "date": "2024-08-25",
      "externalId": "externalId",
      "id": 0,
      "note": "note"
    }
  ],
  "name": "name",
  "printingTimeInDays": 0,
  "typeCode": null,
  "upscoreDomain": "upscoreDomain",
  "weeklySchedule": {
    "fri": true,
    "mon": true,
    "sat": true,
    "sun": true,
    "thu": true,
    "tue": true,
    "wed": true
  }
}'

Example Request Body

{
  "displayStoryByIssue": true,
  "externalId": "externalId",
  "manualSchedule": [
    {
      "date": "2024-08-25",
      "externalId": "externalId",
      "id": 0,
      "note": "note"
    }
  ],
  "name": "name",
  "printingTimeInDays": 0,
  "typeCode": null,
  "upscoreDomain": "upscoreDomain",
  "weeklySchedule": {
    "fri": true,
    "mon": true,
    "sat": true,
    "sun": true,
    "thu": true,
    "tue": true,
    "wed": true
  }
}

json

Example Responses

{
  "displayStoryByIssue": true,
  "externalId": "ext-daily-news",
  "id": 101,
  "name": "Daily News",
  "position": 2,
  "printingTimeInDays": 2,
  "timeSlots": [
    {
      "end": "11:00",
      "id": 3001,
      "name": "Morning",
      "start": "09:00"
    }
  ],
  "typeCode": 1,
  "version": 5,
  "weeklySchedule": {
    "fri": true,
    "mon": true,
    "sat": false,
    "sun": false,
    "thu": true,
    "tue": true,
    "wed": true
  }
}

json

application/json

Get platform by external ID

GET

https://api.kordiam.app

/api/v2/platforms/external-id/{externalId}

Bearer (JWT)

Get platform by external ID › path Parameters

externalId

string · required

Get platform by external ID › query Parameters

includeDeleted

boolean

Get platform by external ID › Responses

displayStoryByIssue

boolean · required

Whether story lists are displayed by issue for this platform.

id

integer · int64 · required

Platform ID.

name

string · minLength: 0 · maxLength: 100 · required

Platform name.

position

integer · int32 · required

Ordinal number in the list.

typeCode

integer · enum · int32 · required

Platform type code.

Enum values:

Default: null

version

integer · int32 · required

Platform version.

externalId

string · minLength: 0 · maxLength: 50

Platform ID in the external system.

Manually entered publication dates for this platform.

printingTimeInDays

integer · int32 · min: 0 · max: 99

How many days before the publication is printed.

Available publication time slots for this platform.

upscoreDomain

string · minLength: 0 · maxLength: 50

Domain in the Upscore system.

Regular publication days for this platform.

Get platform by ID

GET

https://api.kordiam.app

/api/v2/platforms/{id}

Bearer (JWT)

Get platform by ID › path Parameters

id

integer · int64 · min: 1 · required

Get platform by ID › query Parameters

includeDeleted

boolean

Get platform by ID › Responses

displayStoryByIssue

boolean · required

Whether story lists are displayed by issue for this platform.

id

integer · int64 · required

Platform ID.

name

string · minLength: 0 · maxLength: 100 · required

Platform name.

position

integer · int32 · required

Ordinal number in the list.

typeCode

integer · enum · int32 · required

Platform type code.

Enum values:

Default: null

version

integer · int32 · required

Platform version.

externalId

string · minLength: 0 · maxLength: 50

Platform ID in the external system.

Manually entered publication dates for this platform.

printingTimeInDays

integer · int32 · min: 0 · max: 99

How many days before the publication is printed.

Available publication time slots for this platform.

upscoreDomain

string · minLength: 0 · maxLength: 50

Domain in the Upscore system.

WeeklyScheduleUpdateRequest

Regular publication days for this platform.

Replace platform by ID

PUT

https://api.kordiam.app

/api/v2/platforms/{id}

Bearer (JWT)

Replaces the writable state of the addressed publication platform.

Replace platform by ID › path Parameters

id

integer · int64 · min: 1 · required

Replace platform by ID › Request Body

PlatformUpdateRequest

displayStoryByIssue

boolean · required

Whether story lists are displayed by issue for this publication platform.

null is invalid. Digital publication platforms must use true.

name

string · minLength: 0 · maxLength: 100 · required

Publication platform name.

null is invalid.

printingTimeInDays

integer · int32 · min: 0 · max: 99 · required

Printing delay in days.

Use 0 for digital publication platforms. null is invalid.

typeCode

integer · enum · int32 · required

Publication platform type code.

null is invalid.

Enum values:

Default: null

externalId

string

Publication platform ID in the external system.

Omit or set null to clear it.

ManualScheduleUpdateRequest[] · minItems: 1 · maxItems: 2147483647

Manually entered publication dates for this publication platform.

Provide this list when replacing a manual schedule.

upscoreDomain

string · minLength: 0 · maxLength: 50

Upscore domain.

Omit or set null to clear it.

Regular publication days for this publication platform.

Provide this payload when replacing a weekly schedule.

Replace platform by ID › Responses

displayStoryByIssue

boolean · required

Whether story lists are displayed by issue for this platform.

id

integer · int64 · required

Platform ID.

name

string · minLength: 0 · maxLength: 100 · required

Platform name.

position

integer · int32 · required

Ordinal number in the list.

typeCode

integer · enum · int32 · required

Platform type code.

Enum values:

Default: null

version

integer · int32 · required

Platform version.

externalId

string · minLength: 0 · maxLength: 50

Platform ID in the external system.

Manually entered publication dates for this platform.

printingTimeInDays

integer · int32 · min: 0 · max: 99

How many days before the publication is printed.

Available publication time slots for this platform.

upscoreDomain

string · minLength: 0 · maxLength: 50

Domain in the Upscore system.

PlatformDeleteAcceptedResponse

Regular publication days for this platform.

PUT/api/v2/platforms/{id}

curl https://api.kordiam.app/api/v2/platforms/:id \
  --request PUT \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer <token>' \
  --data '{
  "displayStoryByIssue": true,
  "externalId": "externalId",
  "manualSchedule": [
    {
      "date": "2024-08-25",
      "externalId": "externalId",
      "id": 0,
      "note": "note"
    }
  ],
  "name": "name",
  "printingTimeInDays": 0,
  "typeCode": null,
  "upscoreDomain": "upscoreDomain",
  "weeklySchedule": {
    "fri": true,
    "mon": true,
    "sat": true,
    "sun": true,
    "thu": true,
    "tue": true,
    "wed": true
  }
}'

Example Request Body

{
  "displayStoryByIssue": true,
  "externalId": "externalId",
  "manualSchedule": [
    {
      "date": "2024-08-25",
      "externalId": "externalId",
      "id": 0,
      "note": "note"
    }
  ],
  "name": "name",
  "printingTimeInDays": 0,
  "typeCode": null,
  "upscoreDomain": "upscoreDomain",
  "weeklySchedule": {
    "fri": true,
    "mon": true,
    "sat": true,
    "sun": true,
    "thu": true,
    "tue": true,
    "wed": true
  }
}

json

Example Responses

{
  "displayStoryByIssue": true,
  "externalId": "ext-daily-news",
  "id": 101,
  "name": "Daily News",
  "position": 2,
  "printingTimeInDays": 2,
  "timeSlots": [
    {
      "end": "11:00",
      "id": 3001,
      "name": "Morning",
      "start": "09:00"
    }
  ],
  "typeCode": 1,
  "version": 5,
  "weeklySchedule": {
    "fri": true,
    "mon": true,
    "sat": false,
    "sun": false,
    "thu": true,
    "tue": true,
    "wed": true
  }
}

json

application/json

Delete platform by ID

DELETE

https://api.kordiam.app

/api/v2/platforms/{id}

Bearer (JWT)

Deletes the addressed publication platform.

Delete platform by ID › path Parameters

id

integer · int64 · min: 1 · required

Delete platform by ID › Responses

Deletion deferred - the platform is currently in use and will be deleted once all references are removed

message

string

Deletion accepted message.

Update platform by ID

PATCH

https://api.kordiam.app

/api/v2/platforms/{id}

Bearer (JWT)

Partially updates the writable state of the addressed publication platform.

Update platform by ID › path Parameters

id

integer · int64 · min: 1 · required

Update platform by ID › Request Body

PlatformPatchRequest

displayStoryByIssue

boolean

Whether story lists are displayed by issue for this publication platform.

Omit to leave it unchanged. null is invalid.

externalId

string

Publication platform ID in the external system.

Omit to leave it unchanged. Set null to clear it.

ManualSchedulePatchRequest[]

Manually entered publication dates for this publication platform.

Omit to leave it unchanged. Send [] as an empty instruction list. null is invalid.

name

string

Publication platform name.

Omit to leave it unchanged. null is invalid.

printingTimeInDays

integer · int32

How many days before the publication is printed.

Omit to leave it unchanged. Use 0 when no delay should be applied.

typeCode

integer · enum · int32

Publication platform type code.

Omit to leave it unchanged. null is invalid.

Enum values:

Default: null

upscoreDomain

string

Domain in the Upscore system.

Omit to leave it unchanged. Set null to clear it.

WeeklySchedulePatchRequest

Regular publication days for this publication platform.

Omit to leave it unchanged. null is invalid.

Update platform by ID › Responses

displayStoryByIssue

boolean · required

Whether story lists are displayed by issue for this platform.

id

integer · int64 · required

Platform ID.

name

string · minLength: 0 · maxLength: 100 · required

Platform name.

position

integer · int32 · required

Ordinal number in the list.

typeCode

integer · enum · int32 · required

Platform type code.

Enum values:

Default: null

version

integer · int32 · required

Platform version.

externalId

string · minLength: 0 · maxLength: 50

Platform ID in the external system.

Manually entered publication dates for this platform.

printingTimeInDays

integer · int32 · min: 0 · max: 99

How many days before the publication is printed.

Available publication time slots for this platform.

upscoreDomain

string · minLength: 0 · maxLength: 50

Domain in the Upscore system.

WeeklyScheduleCreateRequest

Regular publication days for this platform.

PATCH/api/v2/platforms/{id}

curl https://api.kordiam.app/api/v2/platforms/:id \
  --request PATCH \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer <token>' \
  --data '{
  "displayStoryByIssue": true,
  "externalId": "externalId",
  "manualSchedule": [
    {
      "date": "2024-08-25",
      "externalId": "externalId",
      "id": 0,
      "note": "note"
    }
  ],
  "name": "name",
  "printingTimeInDays": 0,
  "typeCode": null,
  "upscoreDomain": "upscoreDomain",
  "weeklySchedule": {
    "fri": true,
    "mon": true,
    "sat": true,
    "sun": true,
    "thu": true,
    "tue": true,
    "wed": true
  }
}'

Example Request Body

{
  "displayStoryByIssue": true,
  "externalId": "externalId",
  "manualSchedule": [
    {
      "date": "2024-08-25",
      "externalId": "externalId",
      "id": 0,
      "note": "note"
    }
  ],
  "name": "name",
  "printingTimeInDays": 0,
  "typeCode": null,
  "upscoreDomain": "upscoreDomain",
  "weeklySchedule": {
    "fri": true,
    "mon": true,
    "sat": true,
    "sun": true,
    "thu": true,
    "tue": true,
    "wed": true
  }
}

json

Example Responses

{
  "displayStoryByIssue": true,
  "externalId": "ext-daily-news",
  "id": 101,
  "name": "Daily News",
  "position": 2,
  "printingTimeInDays": 2,
  "timeSlots": [
    {
      "end": "11:00",
      "id": 3001,
      "name": "Morning",
      "start": "09:00"
    }
  ],
  "typeCode": 1,
  "version": 5,
  "weeklySchedule": {
    "fri": true,
    "mon": true,
    "sat": false,
    "sun": false,
    "thu": true,
    "tue": true,
    "wed": true
  }
}

json

application/json

Delete platform manual schedule date

DELETE

https://api.kordiam.app

/api/v2/platforms/{platformId}/manual-schedule/{manualScheduleId}

Bearer (JWT)

Deletes one manual schedule date from the addressed publication platform.

Delete platform manual schedule date › path Parameters

platformId

integer · int64 · min: 1 · required

manualScheduleId

integer · int64 · min: 1 · required

Delete platform manual schedule date › Responses

Manual schedule date deleted

No data returned

Types Task Formats

Kordiam API

Platforms

Read and manage publication platforms.

List platforms

GET

https://api.kordiam.app

/api/v2/platforms

Bearer (JWT)

List platforms › query Parameters

page

integer · int32 · min: 0

0-based page number for offset pagination. Mutually exclusive with cursor.

cursor

string · maxLength: 2048 · pattern: ^[A-Za-z0-9._~\-]*$

size

integer · int32 · min: 1 · max: 100

Requested page size. Defaults to 20 and must not exceed 100.

includeDeleted

boolean

Include soft-deleted resources when true.

List platforms › Responses

PlatformListResponse

PlatformApiModel[]

Items returned in this response.

hasMore

boolean

Whether more results are available.

nextCursor

string

Cursor for the next page of results.

PageMetadata

Page-based pagination metadata.

size

integer · int32

Requested page size.

GET/api/v2/platforms

curl https://api.kordiam.app/api/v2/platforms \
  --header 'Authorization: Bearer <token>'

Example Responses

{
  "content": [
    {
      "displayStoryByIssue": true,
      "externalId": "ext-daily-news",
      "id": 101,
      "name": "Daily News",
      "position": 2,
      "printingTimeInDays": 2,
      "timeSlots": [
        {
          "end": "11:00",
          "id": 3001,
          "name": "Morning",
          "start": "09:00"
        }
      ],
      "typeCode": 1,
      "version": 5,
      "weeklySchedule": {
        "fri": true,
        "mon": true,
        "sat": false,
        "sun": false,
        "thu": true,
        "tue": true,
        "wed": true
      }
    }
  ],
  "hasMore": false,
  "page": {
    "number": 0,
    "totalElements": 1,
    "totalPages": 1
  },
  "size": 1
}

json

application/json

Create platform

POST

https://api.kordiam.app

/api/v2/platforms

Bearer (JWT)

Creates a new publication platform.

Create platform › Request Body

PlatformCreateRequest

displayStoryByIssue

boolean · required

Whether story lists are displayed by issue for this platform.

Required on create. null is invalid.

name

string · minLength: 0 · maxLength: 100 · required

Publication platform name.

externalId

string

Platform ID in the external system.

Omit or set null to leave it unset on create.

ManualScheduleCreateRequest[] · minItems: 1 · maxItems: 2147483647

Manually entered publication dates for this platform.

If both schedule fields are omitted or set to null, the default weekly schedule is created.

printingTimeInDays

integer · int32 · min: 0 · max: 99

How many days before the publication is printed.

Omit or set null to use 0.

typeCode

integer · enum · int32

Platform type code.

Omit or set null to use the default other type.

Enum values:

Default: null

upscoreDomain

string · minLength: 0 · maxLength: 50

Domain in the Upscore system.

Omit or set null to leave it unset on create.

Regular publication days for this publication platform.

Omit or set null to use the default weekly schedule unless manualSchedule is provided.

Create platform › Responses

Platform created

displayStoryByIssue

boolean · required

Whether story lists are displayed by issue for this platform.

id

integer · int64 · required

Platform ID.

name

string · minLength: 0 · maxLength: 100 · required

Platform name.

position

integer · int32 · required

Ordinal number in the list.

typeCode

integer · enum · int32 · required

Platform type code.

Enum values:

Default: null

version

integer · int32 · required

Platform version.

externalId

string · minLength: 0 · maxLength: 50

Platform ID in the external system.

Manually entered publication dates for this platform.

printingTimeInDays

integer · int32 · min: 0 · max: 99

How many days before the publication is printed.

Available publication time slots for this platform.

upscoreDomain

string · minLength: 0 · maxLength: 50

Domain in the Upscore system.

Regular publication days for this platform.

POST/api/v2/platforms

curl https://api.kordiam.app/api/v2/platforms \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer <token>' \
  --data '{
  "displayStoryByIssue": true,
  "externalId": "externalId",
  "manualSchedule": [
    {
      "date": "2024-08-25",
      "externalId": "externalId",
      "id": 0,
      "note": "note"
    }
  ],
  "name": "name",
  "printingTimeInDays": 0,
  "typeCode": null,
  "upscoreDomain": "upscoreDomain",
  "weeklySchedule": {
    "fri": true,
    "mon": true,
    "sat": true,
    "sun": true,
    "thu": true,
    "tue": true,
    "wed": true
  }
}'

Example Request Body

{
  "displayStoryByIssue": true,
  "externalId": "externalId",
  "manualSchedule": [
    {
      "date": "2024-08-25",
      "externalId": "externalId",
      "id": 0,
      "note": "note"
    }
  ],
  "name": "name",
  "printingTimeInDays": 0,
  "typeCode": null,
  "upscoreDomain": "upscoreDomain",
  "weeklySchedule": {
    "fri": true,
    "mon": true,
    "sat": true,
    "sun": true,
    "thu": true,
    "tue": true,
    "wed": true
  }
}

json

Example Responses

{
  "displayStoryByIssue": true,
  "externalId": "ext-daily-news",
  "id": 101,
  "name": "Daily News",
  "position": 2,
  "printingTimeInDays": 2,
  "timeSlots": [
    {
      "end": "11:00",
      "id": 3001,
      "name": "Morning",
      "start": "09:00"
    }
  ],
  "typeCode": 1,
  "version": 5,
  "weeklySchedule": {
    "fri": true,
    "mon": true,
    "sat": false,
    "sun": false,
    "thu": true,
    "tue": true,
    "wed": true
  }
}

json

application/json

Get platform by external ID

GET

https://api.kordiam.app

/api/v2/platforms/external-id/{externalId}

Bearer (JWT)

Get platform by external ID › path Parameters

externalId

string · required

Get platform by external ID › query Parameters

includeDeleted

boolean

Get platform by external ID › Responses

displayStoryByIssue

boolean · required

Whether story lists are displayed by issue for this platform.

id

integer · int64 · required

Platform ID.

name

string · minLength: 0 · maxLength: 100 · required

Platform name.

position

integer · int32 · required

Ordinal number in the list.

typeCode

integer · enum · int32 · required

Platform type code.

Enum values:

Default: null

version

integer · int32 · required

Platform version.

externalId

string · minLength: 0 · maxLength: 50

Platform ID in the external system.

Manually entered publication dates for this platform.

printingTimeInDays

integer · int32 · min: 0 · max: 99

How many days before the publication is printed.

Available publication time slots for this platform.

upscoreDomain

string · minLength: 0 · maxLength: 50

Domain in the Upscore system.

Regular publication days for this platform.

Get platform by ID

GET

https://api.kordiam.app

/api/v2/platforms/{id}

Bearer (JWT)

Get platform by ID › path Parameters

id

integer · int64 · min: 1 · required

Get platform by ID › query Parameters

includeDeleted

boolean

Get platform by ID › Responses

displayStoryByIssue

boolean · required

Whether story lists are displayed by issue for this platform.

id

integer · int64 · required

Platform ID.

name

string · minLength: 0 · maxLength: 100 · required

Platform name.

position

integer · int32 · required

Ordinal number in the list.

typeCode

integer · enum · int32 · required

Platform type code.

Enum values:

Default: null

version

integer · int32 · required

Platform version.

externalId

string · minLength: 0 · maxLength: 50

Platform ID in the external system.

Manually entered publication dates for this platform.

printingTimeInDays

integer · int32 · min: 0 · max: 99

How many days before the publication is printed.

Available publication time slots for this platform.

upscoreDomain

string · minLength: 0 · maxLength: 50

Domain in the Upscore system.

WeeklyScheduleUpdateRequest

Regular publication days for this platform.

Replace platform by ID

PUT

https://api.kordiam.app

/api/v2/platforms/{id}

Bearer (JWT)

Replaces the writable state of the addressed publication platform.

Replace platform by ID › path Parameters

id

integer · int64 · min: 1 · required

Replace platform by ID › Request Body

PlatformUpdateRequest

displayStoryByIssue

boolean · required

Whether story lists are displayed by issue for this publication platform.

null is invalid. Digital publication platforms must use true.

name

string · minLength: 0 · maxLength: 100 · required

Publication platform name.

null is invalid.

printingTimeInDays

integer · int32 · min: 0 · max: 99 · required

Printing delay in days.

Use 0 for digital publication platforms. null is invalid.

typeCode

integer · enum · int32 · required

Publication platform type code.

null is invalid.

Enum values:

Default: null

externalId

string

Publication platform ID in the external system.

Omit or set null to clear it.

ManualScheduleUpdateRequest[] · minItems: 1 · maxItems: 2147483647

Manually entered publication dates for this publication platform.

Provide this list when replacing a manual schedule.

upscoreDomain

string · minLength: 0 · maxLength: 50

Upscore domain.

Omit or set null to clear it.

Regular publication days for this publication platform.

Provide this payload when replacing a weekly schedule.

Replace platform by ID › Responses

displayStoryByIssue

boolean · required

Whether story lists are displayed by issue for this platform.

id

integer · int64 · required

Platform ID.

name

string · minLength: 0 · maxLength: 100 · required

Platform name.

position

integer · int32 · required

Ordinal number in the list.

typeCode

integer · enum · int32 · required

Platform type code.

Enum values:

Default: null

version

integer · int32 · required

Platform version.

externalId

string · minLength: 0 · maxLength: 50

Platform ID in the external system.

Manually entered publication dates for this platform.

printingTimeInDays

integer · int32 · min: 0 · max: 99

How many days before the publication is printed.

Available publication time slots for this platform.

upscoreDomain

string · minLength: 0 · maxLength: 50

Domain in the Upscore system.

PlatformDeleteAcceptedResponse

Regular publication days for this platform.

PUT/api/v2/platforms/{id}

curl https://api.kordiam.app/api/v2/platforms/:id \
  --request PUT \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer <token>' \
  --data '{
  "displayStoryByIssue": true,
  "externalId": "externalId",
  "manualSchedule": [
    {
      "date": "2024-08-25",
      "externalId": "externalId",
      "id": 0,
      "note": "note"
    }
  ],
  "name": "name",
  "printingTimeInDays": 0,
  "typeCode": null,
  "upscoreDomain": "upscoreDomain",
  "weeklySchedule": {
    "fri": true,
    "mon": true,
    "sat": true,
    "sun": true,
    "thu": true,
    "tue": true,
    "wed": true
  }
}'

Example Request Body

{
  "displayStoryByIssue": true,
  "externalId": "externalId",
  "manualSchedule": [
    {
      "date": "2024-08-25",
      "externalId": "externalId",
      "id": 0,
      "note": "note"
    }
  ],
  "name": "name",
  "printingTimeInDays": 0,
  "typeCode": null,
  "upscoreDomain": "upscoreDomain",
  "weeklySchedule": {
    "fri": true,
    "mon": true,
    "sat": true,
    "sun": true,
    "thu": true,
    "tue": true,
    "wed": true
  }
}

json

Example Responses

{
  "displayStoryByIssue": true,
  "externalId": "ext-daily-news",
  "id": 101,
  "name": "Daily News",
  "position": 2,
  "printingTimeInDays": 2,
  "timeSlots": [
    {
      "end": "11:00",
      "id": 3001,
      "name": "Morning",
      "start": "09:00"
    }
  ],
  "typeCode": 1,
  "version": 5,
  "weeklySchedule": {
    "fri": true,
    "mon": true,
    "sat": false,
    "sun": false,
    "thu": true,
    "tue": true,
    "wed": true
  }
}

json

application/json

Delete platform by ID

DELETE

https://api.kordiam.app

/api/v2/platforms/{id}

Bearer (JWT)

Deletes the addressed publication platform.

Delete platform by ID › path Parameters

id

integer · int64 · min: 1 · required

Delete platform by ID › Responses

Deletion deferred - the platform is currently in use and will be deleted once all references are removed

message

string

Deletion accepted message.

Update platform by ID

PATCH

https://api.kordiam.app

/api/v2/platforms/{id}

Bearer (JWT)

Partially updates the writable state of the addressed publication platform.

Update platform by ID › path Parameters

id

integer · int64 · min: 1 · required

Update platform by ID › Request Body

PlatformPatchRequest

displayStoryByIssue

boolean

Whether story lists are displayed by issue for this publication platform.

Omit to leave it unchanged. null is invalid.

externalId

string

Publication platform ID in the external system.

Omit to leave it unchanged. Set null to clear it.

ManualSchedulePatchRequest[]

Manually entered publication dates for this publication platform.

Omit to leave it unchanged. Send [] as an empty instruction list. null is invalid.

name

string

Publication platform name.

Omit to leave it unchanged. null is invalid.

printingTimeInDays

integer · int32

How many days before the publication is printed.

Omit to leave it unchanged. Use 0 when no delay should be applied.

typeCode

integer · enum · int32

Publication platform type code.

Omit to leave it unchanged. null is invalid.

Enum values:

Default: null

upscoreDomain

string

Domain in the Upscore system.

Omit to leave it unchanged. Set null to clear it.

WeeklySchedulePatchRequest

Regular publication days for this publication platform.

Omit to leave it unchanged. null is invalid.

Update platform by ID › Responses

displayStoryByIssue

boolean · required

Whether story lists are displayed by issue for this platform.

id

integer · int64 · required

Platform ID.

name

string · minLength: 0 · maxLength: 100 · required

Platform name.

position

integer · int32 · required

Ordinal number in the list.

typeCode

integer · enum · int32 · required

Platform type code.

Enum values:

Default: null

version

integer · int32 · required

Platform version.

externalId

string · minLength: 0 · maxLength: 50

Platform ID in the external system.

Manually entered publication dates for this platform.

printingTimeInDays

integer · int32 · min: 0 · max: 99

How many days before the publication is printed.

Available publication time slots for this platform.

upscoreDomain

string · minLength: 0 · maxLength: 50

Domain in the Upscore system.