Element Publications
Standalone publication operations nested under elements, including scheduling and publishing.
Delete publication
Deletes the addressed publication from the parent story or event. Returns 204 with an empty body. Deleting the last publication keeps the parent story or event active.
path Parameters
elementIdPositive identifier of the parent element.
publicationIdPositive identifier of the publication.
Delete publication › Responses
Publication deleted
Create publication
Creates a publication under the addressed story or event. Publication creation may include an initial schedule, while later schedule changes use the dedicated schedule subresource.
path Parameters
idPositive identifier of the parent element.
Create publication › Request Body
assignedTaskIdsTask IDs assigned to this publication. Use persisted task IDs in standalone publication writes.
Omit, set null, or send [] to create without assigned task links.
categoryIdCategory ID.
See Categories for available categories.
Provide categoryId or platformId to resolve publication placement.
CMS-related publication metadata and links.
Omit or set null to create without CMS metadata.
Publication custom field values.
Omit, set null, or send [] to create without publication custom field values.
externalIdPublication ID in the external system.
Omit or set null to leave it unset on create.
platformIdPlatform ID.
See Platforms for available publication platforms.
Provide platformId or categoryId to resolve publication placement.
Publication schedule.
Omit or set null to create without a schedule unless the selected platform configuration requires one.
scopeScope value.
Omit or set null to leave it unset on create.
statusIdPublication status ID.
See Publication Statuses for allowed values.
Omit or set null to use No Status. PUBLISHED is not accepted here; use the publish endpoint.
typeIdType ID.
See Types for available types.
Omit or set null to create without an explicit publication type.
upscoreIdPublication ID in Upscore.
Omit or set null to leave it unset on create.
Create publication › Responses
Publication created; current element snapshot returned
Element attachments.
confidentialIndicates whether the element is confidential.
creationTimeCreation date in UTC using ISO-8601 format (yyyy-MM-dd'T'HH:mm:ss'Z').
Creator of the element.
Element custom field values.
Last editor of the element.
Status for the entire element.
Event start and end date/time.
Convenience projection of the first active external binding in the current organization scope.
Use GET /api/v2/elements/{id}/external-elements for the complete binding list.
Groups selected for the element.
idElement ID.
Element location.
Element master group.
modificationDateLast modification date in UTC using ISO-8601 format (yyyy-MM-dd'T'HH:mm:ss'Z').
noteElement note.
Element publications.
slugElement slug / short title.
Element tasks.
titleElement description.
urlURL to open the element in Kordiam.
versionElement version.
Update publication
Partially updates the addressed publication.
path Parameters
idPositive identifier of the parent element.
publicationIdPositive identifier of the publication.
Update publication › Request Body
assignedTaskIdsTask IDs assigned to this publication.
Omit to leave it unchanged. Send [] to clear assigned task links. null is invalid.
categoryIdCMS-related publication metadata and links.
Omit to leave it unchanged. Set null to clear CMS metadata.
Publication custom field patch instructions.
Omit to leave it unchanged. Send [] as an empty instruction list. null is invalid.
externalIdPublication ID in the external system.
Omit to leave it unchanged. Set null to clear it.
platformIdPublication platform ID.
See Platforms for available publication platforms.
Omit to leave it unchanged. null is invalid.
scopeScope value.
Omit to leave it unchanged. Set null to clear it.
statusIdPublication status ID.
See Publication Statuses for allowed values.
Omit to leave it unchanged. null is invalid; send No Status to clear it. PUBLISHED is not accepted here; use the publish endpoint.
typeIdupscoreIdPublication ID in Upscore.
Omit to leave it unchanged. Set null to clear it.
Update publication › Responses
Publication updated; current element snapshot returned
Element attachments.
confidentialIndicates whether the element is confidential.
creationTimeCreation date in UTC using ISO-8601 format (yyyy-MM-dd'T'HH:mm:ss'Z').
Creator of the element.
Element custom field values.
Last editor of the element.
Status for the entire element.
Event start and end date/time.
Convenience projection of the first active external binding in the current organization scope.
Use GET /api/v2/elements/{id}/external-elements for the complete binding list.
Groups selected for the element.
idElement ID.
Element location.
Element master group.
modificationDateLast modification date in UTC using ISO-8601 format (yyyy-MM-dd'T'HH:mm:ss'Z').
noteElement note.
Element publications.
slugElement slug / short title.
Element tasks.
titleElement description.
urlURL to open the element in Kordiam.
versionElement version.
Publish publication
Performs the dedicated lifecycle transition into the published state. The server manages actual publish timestamps and returns the refreshed parent element snapshot.
path Parameters
idPositive identifier of the parent element.
publicationIdPositive identifier of the publication.
Publish publication › Responses
Publication published; current element snapshot returned
Element attachments.
confidentialIndicates whether the element is confidential.
creationTimeCreation date in UTC using ISO-8601 format (yyyy-MM-dd'T'HH:mm:ss'Z').
Creator of the element.
Element custom field values.
Last editor of the element.
Status for the entire element.
Event start and end date/time.
Convenience projection of the first active external binding in the current organization scope.
Use GET /api/v2/elements/{id}/external-elements for the complete binding list.
Groups selected for the element.
idElement ID.
Element location.
Element master group.
modificationDateLast modification date in UTC using ISO-8601 format (yyyy-MM-dd'T'HH:mm:ss'Z').
noteElement note.
Element publications.
slugElement slug / short title.
Element tasks.
titleElement description.
urlURL to open the element in Kordiam.
versionElement version.
Get publication schedule
Reads the dedicated schedule subresource of one standalone publication. The response body is the schedule object itself, not a wrapper document.
path Parameters
idPositive identifier of the parent element.
publicationIdPositive identifier of the publication.
Get publication schedule › Responses
Publication schedule resource
Decision Table
| Variant | Matching Criteria |
|---|---|
| type = object · kind="single" · requires: date | |
| No specific criteria |
dateSingle publication issue date (yyyy-MM-dd).
kindSchedule kind.
dateExternalIdRead-only external id resolved for a matching manual-entered platform date.
Optional exact time or time-slot selection.
Replace publication schedule
Replaces the addressed publication schedule.
path Parameters
idPositive identifier of the parent element.
publicationIdPositive identifier of the publication.
Replace publication schedule › Request Body
Decision Table
| Variant | Matching Criteria |
|---|---|
| type = object · kind="single" · requires: date | |
| No specific criteria |
dateSingle publication issue date (yyyy-MM-dd).
kindSchedule kind.
Exact time or time-slot selection.
Omit or set null to leave the publication issue without a specific timing.
Replace publication schedule › Responses
Publication schedule updated; current element snapshot returned
Element attachments.
confidentialIndicates whether the element is confidential.
creationTimeCreation date in UTC using ISO-8601 format (yyyy-MM-dd'T'HH:mm:ss'Z').
Creator of the element.
Element custom field values.
Last editor of the element.
Status for the entire element.
Event start and end date/time.
Convenience projection of the first active external binding in the current organization scope.
Use GET /api/v2/elements/{id}/external-elements for the complete binding list.
Groups selected for the element.
idElement ID.
Element location.
Element master group.
modificationDateLast modification date in UTC using ISO-8601 format (yyyy-MM-dd'T'HH:mm:ss'Z').
noteElement note.
Element publications.
slugElement slug / short title.
Element tasks.
titleElement description.
urlURL to open the element in Kordiam.
versionElement version.
Delete publication schedule
Deletes the addressed publication schedule. The publication returns to the undated state.
path Parameters
idPositive identifier of the parent element.
publicationIdPositive identifier of the publication.
Delete publication schedule › Responses
Publication schedule deleted