Schemas
AbsenceApiModel
Absence period.
Absence type.
User associated with the absence.
externalIdExternal ID.
idAbsence ID.
noteAbsence note.
AbsenceCreateRequest
Absence period.
Absence type.
User associated with the absence.
externalIdExternal ID.
Omit or set null to leave it unset on create.
noteAbsence note.
Omit or set null to leave it unset on create.
AbsenceEventRef
fromDateStart date field (yyyy-MM-dd).
toDateEnd date field (yyyy-MM-dd).
fromTimeStart time field (HH:mm).
toTimeEnd time field (HH:mm).
AbsenceEventRequest
fromDateStart date of the absence period (yyyy-MM-dd).
toDateEnd date of the absence period (yyyy-MM-dd).
fromTimeStart time of the absence period (HH:mm).
Omit or set null to leave the start boundary date-only.
toTimeEnd time of the absence period (HH:mm).
Omit or set null to leave the end boundary date-only.
AbsenceEventUpdateRequest
fromDateStart date of the absence period (yyyy-MM-dd).
null is invalid.
toDateEnd date of the absence period (yyyy-MM-dd).
null is invalid.
fromTimeStart time of the absence period (HH:mm).
Omit or set null to clear it.
toTimeEnd time of the absence period (HH:mm).
Omit or set null to clear it.
AbsenceListResponse
Items returned in this response.
hasMoreWhether more results are available.
nextCursorCursor for the next page of results.
Page-based pagination metadata.
sizeRequested page size.
AbsencePatchRequest
externalIdExternal ID.
Omit to leave it unchanged. Set null to clear it.
noteAbsence note.
Omit to leave it unchanged. Set null to clear it.
Absence period.
Omit to leave it unchanged. null is invalid.
Absence type.
Omit to leave it unchanged. null is invalid.
AbsencePeriodPatchRequest
fromDateStart date field (yyyy-MM-dd).
Omit to leave it unchanged. null is invalid.
fromTimeStart time field (HH:mm).
Omit to leave it unchanged. Set null to clear it.
toDateEnd date field (yyyy-MM-dd).
Omit to leave it unchanged. null is invalid.
toTimeEnd time field (HH:mm).
Omit to leave it unchanged. Set null to clear it.
AbsenceTypeCode
Absence type code.
Known values:
0Other2Business trip3Vacation4Day off6Short work
AbsenceTypeInputCode
Absence type code accepted by write and filter operations.
Known values:
0Other2Business trip3Vacation4Day off6Short work
AbsenceTypePatchRequest
codeAbsence type code.
Omit to leave it unchanged. null is invalid.
AbsenceTypeRef
codeAbsence type code.
nameAbsence type name.
AbsenceTypeRequest
codeAbsence type code.
AbsenceTypeUpdateRequest
codeAbsence type code.
null is invalid.
AbsenceUpdateRequest
Absence period.
null is invalid.
Absence type.
null is invalid.
externalIdExternal ID.
Omit or set null to clear it.
noteAbsence note.
Omit or set null to clear it.
AbsenceUserRef
emailUser email.
externalIdExternal ID.
firstNameUser first name.
idUser ID.
lastNameUser last name.
supplierIdSupplier ID.
ApiProblem
detailHuman-readable explanation specific to this problem occurrence.
instanceURI reference identifying this specific problem occurrence.
statusHTTP status code generated for this problem occurrence.
titleShort human-readable summary of the problem type.
traceIdTrace identifier that helps support locate the failing request.
typeURI reference identifying the problem type.
BadRequestProblem
Decision Table
| Variant | Matching Criteria |
|---|---|
| type = object | |
| type = object · requires: errors |
detailHuman-readable explanation specific to this problem occurrence.
instanceURI reference identifying this specific problem occurrence.
statusHTTP status code generated for this problem occurrence.
titleShort human-readable summary of the problem type.
traceIdTrace identifier that helps support locate the failing request.
typeURI reference identifying the problem type.
CategoryApiModel
externalIdCategory ID in the external system.
idCategory ID.
nameCategory name.
Parent category.
Category platform.
positionCategory ordinal number in the list.
versionCategory version.
CategoryCreateRequest
nameCategory name.
externalIdCategory ID in the external system.
Omit or set null to leave it unset on create.
parentCategoryIdParent category ID for subcategory creation.
See Categories for available categories. Only top-level categories can be used as parents.
Omit or set null to create a top-level category.
CategoryListResponse
Items returned in this response.
hasMoreWhether more results are available.
nextCursorCursor for the next page of results.
Page-based pagination metadata.
sizeRequested page size.
CategoryPatchRequest
externalIdCategory ID in the external system.
Omit to leave it unchanged. Set null to clear it.
nameCategory name.
Omit to leave it unchanged. null is invalid.
parentCategoryIdParent category ID.
See Categories for available categories. Only top-level categories can be used as parents.
Omit to leave it unchanged. Set null to make or keep the category top-level. Positive IDs move subcategories only; top-level categories reject positive parentCategoryId.
CategoryRef
externalIdCategory ID in the external system.
idCategory ID.
nameCategory name.
CategoryUpdateRequest
nameCategory name.
null is invalid.
parentCategoryIdParent category ID.
See Categories for available categories. Only top-level categories can be used as parents.
Use null to keep or promote top-level placement.
Use a positive ID to move an existing subcategory under another top-level category; top-level categories reject positive parentCategoryId.
externalIdCategory ID in the external system.
Omit or set null to clear it.
CustomFieldListResponseElementCustomFieldApiModel
Items in the current response slice.
hasMoreWhether more items are available after this slice.
nextCursorCursor to request the next slice when cursor pagination is used.
Offset-based pagination metadata when page mode is used.
sizeRequested page size or cursor batch size.
CustomFieldListResponsePublicationCustomFieldApiModel
Items in the current response slice.
hasMoreWhether more items are available after this slice.
nextCursorCursor to request the next slice when cursor pagination is used.
Offset-based pagination metadata when page mode is used.
sizeRequested page size or cursor batch size.
CustomFieldListResponseTaskCustomFieldApiModel
Items in the current response slice.
hasMoreWhether more items are available after this slice.
nextCursorCursor to request the next slice when cursor pagination is used.
Offset-based pagination metadata when page mode is used.
sizeRequested page size or cursor batch size.
CustomFieldOptionApiModel
externalIdChoice option ID in the external system.
idChoice option ID.
nameChoice option name.
CustomFieldOptionCreateRequest
nameChoice option name.
Required on create. null is invalid.
externalIdChoice option ID in the external system.
Omit or set null to leave it unset on create.
CustomFieldOptionPatchRequest
externalIdOption ID in the external system.
Omit to leave it unchanged. Set null to clear it.
nameOption name.
Omit to leave it unchanged. null is invalid.
CustomFieldOptionUpdateRequest
nameChoice option name.
null is invalid.
externalIdChoice option ID in the external system.
Omit or set null to clear it.
ElementApiModel
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.
ElementAssignee
emailEmail of the assigned user.
externalIdExternal ID.
idAssigned user ID if the user belongs to your organization.
nameAssigned user name.
supplierIdSupplier ID.
ElementAttachment
idAttachment ID.
fileNameFile name with extension.
ElementCategoryRef
externalIdCategory ID in the external system.
idCategory ID.
nameCategory name.
ElementConfirmationStatusRef
codeTask confirmation status code.
nameConfirmation status name.
ElementCreateRequest
confidentialIndicates whether the element is confidential.
Required on create. null is invalid.
Story or event attachments.
Omit, set null, or send [] to create without attachments.
Element custom field values.
Omit, set null, or send [] to create without element custom field values.
elementStatusIdElement status ID.
See Element Statuses for allowed values.
Omit or set null to use the default active element status, or No Status when the status feature is disabled or no default is configured.
Event start and end date/time.
Omit or set null to create without event dates.
Representation of the element in the external system.
Omit or set null to create without an external-system binding.
groupIdsElement group IDs.
See Groups for available groups.
Omit, set null, or send [] to create without group assignments.
Element location.
Omit or set null to create without location.
noteStory or event note.
Omit, set null, or send an empty string to leave it unset on create.
Element publications.
Omit, set null, or send [] to create without publications.
slugStory or event slug / short title.
Omit, set null, or send an empty string to leave it unset on create.
Element tasks.
Omit, set null, or send [] to create without tasks.
titleElement title.
Omit, set null, or send a blank value to apply the default title fallback.
When no source title is available, the API may store the no-title placeholder: [no title].
ElementCustomFieldApiModel
activeActive custom field state.
allowEmptyValueWhether the field accepts an empty value. Returned for selection and date fields only. When false, writing an empty value stores a default instead: the field's first option for selection fields, the current date for date fields.
idCustom field ID.
nameCustom field name.
Possible options for selection in multiple-choice or single-choice fields.
typeType of custom field.
ElementCustomFieldModel
dateValue of the date custom field.
idCustom field ID for the current organization.
nameCustom field name.
numberValue of the number custom field.
selectedOptionIdsSelected option IDs for single-choice or multiple-choice fields.
Selected custom field options as lightweight references.
valueValue of the text custom field.
ElementCustomFieldPatchRequest
idCustom field ID for the current organization.
dateValue of the date custom field. Omitting the date clears the stored value; when the field disallows empty values (allowEmptyValue=false), the current date in the requesting user's time zone is stored instead.
numberValue of the number custom field.
selectedOptionIdsSelected option IDs for single-choice or multiple-choice fields. [] clears the stored selection; when the field disallows empty values (allowEmptyValue=false), the field's first option is selected instead.
valueValue of the text custom field.
ElementCustomFieldsPatchRequest
Custom field patch instructions.
Send [] as an empty instruction list. null is invalid.
ElementDateAndTime
dateDate field (yyyy-MM-dd).
Required when this payload is provided.
timeTime field (HH:mm).
Omit or set null to leave this payload without an exact time.
ElementEditor
emailEmail address.
externalIdExternal ID.
supplierIdSupplier ID.
usernameFirst name and last name.
ElementEventRef
fromDateEvent start date field (yyyy-MM-dd).
fromTimeEvent start time field (HH:mm).
toDateEvent end date field (yyyy-MM-dd).
toTimeEvent end time field (HH:mm).
ElementExternalBindingModel
Representation of the element in the external system.
systemUrlURL of the external system this binding belongs to. Null means the historical row is not currently bound to organization REST settings.
ElementExternalRef
externalIdExternal ID of the element in the external system.
linkLink of the element in the external system.
ElementGroupRef
externalIdGroup ID in the external system.
idGroup ID.
nameGroup name.
ElementListResponse
Items returned in this response.
hasMoreWhether more results are available.
nextCursorCursor for the next page of results.
Always omitted for the element list endpoint. Exact totalElements and totalPages are unavailable; use hasMore and nextCursor.
sizeRequested cursor window size.
ElementLocation
cityLocation city.
countryCountry ISO-3166 alpha-2 code.
directionsLocation directions.
nameLocation name.
postalCodeLocation postal code.
stateShortCodeLocation state short code.
streetLocation street.
ElementOptionRef
idChoice option ID.
nameChoice option name.
ElementPatchRequest
Story or event attachments.
Omit to leave it unchanged. Send [] to clear the collection. null is invalid.
confidentialIndicates whether the story or event is confidential.
Omit to leave it unchanged. null is invalid.
Custom field patch instructions attached directly to this story or event.
Omit to leave it unchanged. Send [] as an empty instruction list. null is invalid.
elementStatusIdStory or event status ID.
See Element Statuses for allowed values.
Omit to leave it unchanged. null is invalid; send No Status to clear it.
Story or event start and end date/time.
Omit to leave it unchanged. Set null to clear it.
Representation of the story or event in the external system.
Omit to leave it unchanged. Set null to clear it.
groupIdsGroups assigned to this story or event.
See Groups for available groups.
Omit to leave it unchanged. Send [] to clear the collection. null is invalid.
Story or event location.
Omit to leave it unchanged. Set null to clear it.
noteStory or event note.
Omit to leave it unchanged. Set null or send an empty string to clear it.
Publication patch instructions attached to this story or event.
Omit to leave it unchanged. Send [] as an empty instruction list. null is invalid.
slugStory or event slug / short title.
Omit to leave it unchanged. Set null or send an empty string to clear it.
Task patch instructions attached to this story or event.
Omit to leave it unchanged. Send [] as an empty instruction list. null is invalid.
titleStory or event title.
Omit to leave it unchanged. Set null or send a blank value to apply the default title fallback.
When no source title is available, the API may store the no-title placeholder: [no title].
ElementPlatformRef
externalIdPlatform ID in the external system.
idPlatform ID.
namePlatform name.
ElementPublicationModel
assignedTaskIdsTask IDs assigned to this publication.
Category.
CMS-related publication metadata and links.
Publication custom field values.
externalIdPublication ID in the external system.
idPublication ID.
mainPublicationIndicates whether this publication is the main one for the element.
Platform.
Actual published state.
Publication schedule.
scopeScope value.
Source publication.
Publication status.
Type.
upscoreIdPublication id in Upscore.
versionPublication version.
ElementPublicationStatusRef
idPublication status ID.
namePublication status name.
ElementRootPublicationCreateRequest
Tasks assigned to this publication. Use taskId for persisted tasks or localId to reference tasks[].localId declared in the same element request.
categoryIdCategory ID.
See Categories for available categories.
CMS-related publication metadata and links.
Publication custom field values.
externalIdPublication ID in the external system.
platformIdPlatform ID.
See Platforms for available publication platforms.
Publication schedule.
scopeScope value.
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.
upscoreIdPublication ID in Upscore.
ElementRootPublicationPatchRequest
Tasks assigned to this publication. Use taskId for persisted tasks or localId to reference tasks[].localId declared in the same element request.
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.
idExisting publication ID.
Provide it when referencing a nested publication already stored under the story or event.
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.
typeIdupscoreIdIdentifier of the publication in Upscore.
Omit to leave it unchanged. Set null to clear it.
ElementRootPublicationRequest
Tasks assigned to this publication. Use taskId for persisted tasks or localId to reference tasks[].localId declared in the same element request.
categoryIdCategory ID.
See Categories for available categories.
CMS-related publication metadata and links.
Publication custom field values.
externalIdPublication ID in the external system.
idExisting publication ID. Provide it when referencing a nested publication already stored under the element.
platformIdPlatform ID.
See Platforms for available publication platforms.
scopeScope value.
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.
upscoreIdPublication ID in Upscore.
ElementRootTaskPatchRequest
confirmationStatusCodeTask confirmation status code.
Omit to leave it unchanged. null is invalid. Cannot be changed while the task is done.
Task content.
Omit to leave it unchanged. Set null or send an empty object to clear it.
Cost for this task.
Omit to leave it unchanged. Set null to clear it.
Task custom field patch instructions.
Omit to leave it unchanged. Send [] as an empty instruction list. null is invalid.
customUploadLinkCustom upload link for this task.
Omit to leave it unchanged. Set null to clear it.
Task deadline date and optional time.
Omit to leave it unchanged. Set null to clear it.
Changing the deadline date on a done task reopens the task and clears current assignee markers.
Task separate event.
Omit to leave it unchanged. Set null to clear it.
Link to assets connected to this task, also called Asset Link.
Omit to leave it unchanged. Set null to clear it.
formatIdidExisting task ID.
Provide it when referencing a nested task already stored under the story or event.
localIdRequest-scoped temporary task identifier used to connect publications to tasks declared in the same element request. It is not persisted as the task ID.
noteSpecial note for the task.
Omit to leave it unchanged. Set null to clear it.
statusIdTask status ID.
See Task Statuses for allowed values.
Omit to leave it unchanged. Set null to clear it. Non-null values must be active for the organization.
Task text max length selection.
Omit to leave it unchanged. Set null to clear it.
Assigned user.
Omit to leave it unchanged. Set null to clear it.
Changing the assignee on a done task reopens the task and clears production date/time metadata.
When the current assignee is a registered user inaccessible to the caller (cross-organization), the GET response exposes only the display name (firstName + " " + lastName) without id; treat that name as display-only metadata. Echoing it back via user.name byte-for-byte preserves the existing assignee; any difference replaces it with a non-registered user. To preserve such an assignee safely, omit user from the request.
ElementRootTaskRequest
confirmationStatusCodeTask confirmation status code.
Cannot be changed while the task is done.
formatIdTask format ID.
See Task Formats for allowed values.
Writable task content payload. Content version is server-managed and returned only in read models.
Cost for this task.
Task custom field values.
customUploadLinkCustom upload link for this task.
Task deadline date and optional time.
Changing the deadline date on a done task reopens the task and clears current assignee markers.
Task separate event.
Link to assets connected to this task, also called Asset Link.
idExisting task ID. Provide it when referencing a nested task already stored under the element.
localIdRequest-scoped temporary task identifier used to connect publications to tasks declared in the same element request. It is not persisted as the task ID.
noteSpecial note for the task.
statusIdTask status ID.
See Task Statuses for allowed values.
Omit or set null to store no task status. Non-null values must be active for the organization.
Task text max length selection.
Assigned user. Provide a registered user ID or an unregistered assignee name and email.
Changing the assignee on a done task reopens the task and clears production date/time metadata.
ElementTaskContentDocument
idDocument ID.
captionCaption for image documents.
fileNameAttached document file name with extension.
sourceSource of an image.
ElementTaskContentModel
Array of non-text contents for the task.
headlineOptional headline field.
kickerOptional kicker field.
leadOptional lead field.
placemarkOptional placemark field.
textTask text content.
versionVersion of the task content.
ElementTaskModel
Task confirmation status.
Task content.
Cost for this task.
Task custom field values.
customUploadLinkCustom upload link for this task.
Task deadline date.
doneMarks a task as done/completed.
Task separate event.
Link to assets connected to this task, also called Asset Link.
Task format.
idTask ID.
noteSpecial note for the task.
Task status.
Task text max length.
Assigned user.
ElementTextLength
labelLabel of the max length option.
maxValueMax length of the text content.
optionIdSelected text-length option ID.
Text length counting type.
ElementTextLengthTypeRef
codeText length counting type code.
nameText length counting type name.
ElementTypeRef
externalIdType ID in the external system.
idType ID.
nameType name.
ElementUpdateRequest
confidentialIndicates whether the story or event is confidential.
null is invalid.
Story or event attachments.
Omit or send [] to clear the collection. null is invalid.
Custom field values for the story or event.
Omit or send [] to clear them. null is invalid.
elementStatusIdStory or event status ID.
See Element Statuses for allowed values.
Omit or set null to use the default active element status, or No Status when the status feature is disabled or no default is configured.
Event start and end date/time.
Omit or set null to clear it.
Representation of the story or event in the external system.
Omit or set null to clear it.
groupIdsGroup IDs for the story or event.
See Groups for available groups.
Omit or send [] to clear the collection. null is invalid.
Story or event location.
Omit or set null to clear it.
noteStory or event note.
Omit, set null, or send an empty string to clear it.
Publication assignments for the story or event.
Omit or send [] to delete all publication assignments. null is invalid.
slugStory or event slug / short title.
Omit, set null, or send an empty string to clear it.
Tasks assigned to the story or event.
Omit or send [] to delete all tasks. null is invalid.
titleStory or event title.
Omit, set null, or send a blank value to apply the default title fallback.
When no source title is available, the API may store the no-title placeholder: [no title].
ElementWeeklySchedule
friWhether the recurring schedule includes Friday.
monWhether the recurring schedule includes Monday.
satWhether the recurring schedule includes Saturday.
sunWhether the recurring schedule includes Sunday.
thuWhether the recurring schedule includes Thursday.
tueWhether the recurring schedule includes Tuesday.
wedWhether the recurring schedule includes Wednesday.
EventPatchRequest
fromDateEvent start date field (yyyy-MM-dd).
Omit to leave it unchanged. null is invalid.
fromTimeEvent start time field (HH:mm).
Omit to leave it unchanged. Set null to clear it.
toDateEvent end date field (yyyy-MM-dd).
Omit to leave it unchanged. null is invalid.
toTimeEvent end time field (HH:mm).
Omit to leave it unchanged. Set null to clear it.
ExternalElementLinkRequest
Element representation in the external system.
Provide at least one of externalId or link.
systemUrlExternal system URL selector.
Omit systemUrl to resolve the target binding from the current organization settings.
ExternalElementPatchRequest
externalIdExternal ID of the element in the external system.
Omit to leave it unchanged. Set null to clear it.
linkLink of the element in the external system.
Omit to leave it unchanged. Set null to clear it.
ExternalElementPayload
externalIdExternal-system identifier for the addressed story or event.
Provide externalId, link, or both.
linkExternal-system link for the addressed story or event.
Provide link, externalId, or both.
ExternalElementUnlinkRequest
systemUrlExternal system URL selector.
Omit systemUrl to resolve the target binding from the current organization settings.
GroupApiModel
deletedWhether the group is soft-deleted.
externalIdGroup ID in the external system.
idGroup ID.
nameGroup name.
Parent group.
positionPosition of the group within its parent group.
versionGroup version.
GroupCreateRequest
nameGroup name.
externalIdGroup ID in the external system.
Omit or set null to leave it unset on create.
parentGroupIdParent group ID.
Omit or set null to create a top-level group.
GroupDeleteBadRequestProblem
Decision Table
| Variant | Matching Criteria |
|---|---|
| type = object | |
| type = object · requires: errors | |
| type = object · requires: blockingChildren, blockingChildrenCount, blockingChildrenTruncated +1 more |
detailHuman-readable explanation specific to this problem occurrence.
instanceURI reference identifying this specific problem occurrence.
statusHTTP status code generated for this problem occurrence.
titleShort human-readable summary of the problem type.
traceIdTrace identifier that helps support locate the failing request.
typeURI reference identifying the problem type.
GroupDeleteBlockedProblem
Validation issues that must be fixed before retrying the request.
blockingChildrenCountTotal number of child groups blocking the delete operation.
blockingChildrenTruncatedWhether the blocking child list was truncated in the response.
detailHuman-readable explanation specific to this problem occurrence.
instanceURI reference identifying this specific problem occurrence.
statusHTTP status code generated for this problem occurrence.
titleShort human-readable summary of the problem type.
traceIdTrace identifier that helps support locate the failing request.
typeURI reference identifying the problem type.
GroupDeleteBlockingChild
externalIdExternal identifier of the blocking child group when present.
idIdentifier of the blocking child group.
nameDisplay name of the blocking child group.
GroupListResponse
Items returned in this response.
hasMoreWhether more results are available.
nextCursorCursor for the next page of results.
Page-based pagination metadata.
sizeRequested page size.
GroupPatchRequest
externalIdGroup ID in the external system.
Omit to leave it unchanged. Set null to clear it.
nameGroup name.
Omit to leave it unchanged. null is invalid.
GroupRef
externalIdGroup ID in the external system.
idGroup ID.
nameGroup name.
GroupUpdateRequest
nameGroup name.
null is invalid.
externalIdGroup ID in the external system.
Omit or set null to clear it.
LocationPatchRequest
cityLocation city.
Omit to leave it unchanged. Set null to clear it.
countryCountry ISO-3166 alpha-2 code.
Omit to leave it unchanged. Set null to clear it.
directionsLocation directions.
Omit to leave it unchanged. Set null to clear it.
nameLocation name.
Omit to leave it unchanged. Set null to clear it.
postalCodeLocation postal code.
Omit to leave it unchanged. Set null to clear it.
stateShortCodeLocation state short code.
Omit to leave it unchanged. Set null to clear it.
streetLocation street.
Omit to leave it unchanged. Set null to clear it.
ManualScheduleApiModel
datePublication date.
externalIdManual schedule ID in the external system.
idManual schedule ID.
noteA note that accompanies a manually set publication date, for example "September issue".
ManualScheduleCreateRequest
datePublication date.
externalIdManual schedule ID in the external system.
Omit or set null to leave it unset on create.
idManual schedule ID.
Omit or set null on create.
noteA note that accompanies a manually set publication date, for example "September issue".
Omit or set null to leave it unset on create.
ManualSchedulePatchRequest
datePublication date.
externalIdManual schedule ID in the external system.
idManual schedule ID.
noteA note that accompanies a manually set publication date, for example "September issue".
ManualScheduleUpdateRequest
datePublication date.
externalIdManual schedule ID in the external system.
idManual schedule ID.
noteA note that accompanies a manually set publication date, for example "September issue".
PageMetadata
numberCurrent page number, starting from 0.
totalElementsTotal number of matching items.
totalPagesTotal number of available pages.
PlatformApiModel
displayStoryByIssueWhether story lists are displayed by issue for this platform.
idPlatform ID.
namePlatform name.
positionOrdinal number in the list.
typeCodePlatform type code.
versionPlatform version.
externalIdPlatform ID in the external system.
Manually entered publication dates for this platform.
printingTimeInDaysHow many days before the publication is printed.
Available publication time slots for this platform.
upscoreDomainDomain in the Upscore system.
Regular publication days for this platform.
PlatformCreateRequest
displayStoryByIssueWhether story lists are displayed by issue for this platform.
Required on create. null is invalid.
namePublication platform name.
externalIdPlatform ID in the external system.
Omit or set null to leave it unset on create.
Manually entered publication dates for this platform.
If both schedule fields are omitted or set to null, the default weekly schedule is created.
printingTimeInDaysHow many days before the publication is printed.
Omit or set null to use 0.
typeCodePlatform type code.
Omit or set null to use the default other type.
upscoreDomainDomain 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.
PlatformListResponse
Items returned in this response.
hasMoreWhether more results are available.
nextCursorCursor for the next page of results.
Page-based pagination metadata.
sizeRequested page size.
PlatformPatchRequest
displayStoryByIssueWhether story lists are displayed by issue for this publication platform.
Omit to leave it unchanged. null is invalid.
externalIdPublication platform ID in the external system.
Omit to leave it unchanged. Set null to clear it.
Manually entered publication dates for this publication platform.
Omit to leave it unchanged. Send [] as an empty instruction list. null is invalid.
namePublication platform name.
Omit to leave it unchanged. null is invalid.
printingTimeInDaysHow many days before the publication is printed.
Omit to leave it unchanged. Use 0 when no delay should be applied.
typeCodePublication platform type code.
Omit to leave it unchanged. null is invalid.
upscoreDomainDomain in the Upscore system.
Omit to leave it unchanged. Set null to clear it.
Regular publication days for this publication platform.
Omit to leave it unchanged. null is invalid.
PlatformRef
externalIdPlatform ID in the external system.
idPlatform ID.
namePlatform name.
PlatformStatusApiModel
activePublication status state.
idPublication status ID.
namePublication status name.
triggersExportIndicates if the status triggers the export to the connected external system.
PlatformStatusListResponse
Items returned in this response.
hasMoreWhether more results are available.
nextCursorCursor for the next page of results.
Page-based pagination metadata.
sizeRequested page size.
PlatformTypeCode
Platform type code.
Known values:
0Digital/broadcast1Print2Other
PlatformUpdateRequest
displayStoryByIssueWhether story lists are displayed by issue for this publication platform.
null is invalid. Digital publication platforms must use true.
namePublication platform name.
null is invalid.
printingTimeInDaysPrinting delay in days.
Use 0 for digital publication platforms. null is invalid.
typeCodePublication platform type code.
null is invalid.
externalIdPublication platform ID in the external system.
Omit or set null to clear it.
Manually entered publication dates for this publication platform.
Provide this list when replacing a manual schedule.
upscoreDomainUpscore domain.
Omit or set null to clear it.
Regular publication days for this publication platform.
Provide this payload when replacing a weekly schedule.
ProblemDetail
detailHuman-readable explanation specific to this problem occurrence.
instanceURI reference identifying this specific problem occurrence.
Additional problem attributes supplied by the server.
statusHTTP status code generated for this problem occurrence.
titleShort human-readable summary of the problem type.
typeURI reference identifying the problem type.
PublicationCmsModel
articleIdIdentifier of the publication in the connected CMS.
Link used to open the publication in the CMS for editing.
Link to the published content visible online.
PublicationCmsPatchRequest
articleIdCMS article ID.
Omit to leave it unchanged. Set null to clear it.
Link used to open the publication in the CMS for editing.
Omit to leave it unchanged. Set null to clear it.
Link to the published content visible online.
Omit to leave it unchanged. Set null to clear it.
PublicationCmsRequest
articleIdIdentifier of the publication in the connected CMS.
Omit or set null to leave it unset within the CMS metadata payload.
Link used to open the publication in the CMS for editing.
Omit or set null to leave it unset within the CMS metadata payload.
Link to the published content visible online.
Omit or set null to leave it unset within the CMS metadata payload.
PublicationCreateRequest
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.
PublicationCustomFieldApiModel
activeActive custom field state.
allowEmptyValueWhether the field accepts an empty value. Returned for selection and date fields only. When false, writing an empty value stores a default instead: the field's first option for selection fields, the current date for date fields.
Platforms to which this custom field is assigned.
idCustom field ID.
nameCustom field name.
Possible options for selection in multiple-choice or single-choice fields.
typeType of custom field.
PublicationDailyRecurringSchedule
kindSchedule kind.
startRecurring schedule start date (yyyy-MM-dd).
typeRecurring schedule type.
Recurring weekday mask for daily schedules.
endRecurring schedule end date (yyyy-MM-dd).
excludedRecurring excluded issue dates.
occurrenceCountRecurring occurrence count.
Optional exact time or time-slot selection.
PublicationDailyRecurringScheduleRequest
kindSchedule kind.
startRecurring schedule start date (yyyy-MM-dd).
typeRecurring schedule type.
Recurring weekday mask for daily schedules.
endRecurring schedule end date (yyyy-MM-dd).
Omit or set null to keep the recurrence open-ended unless occurrenceCount limits it.
excludedRecurring excluded issue dates.
Omit, set null, or send [] to keep the recurrence without excluded issue dates.
occurrenceCountRecurring occurrence count.
Omit or set null to control the recurrence by end instead.
Exact time or time-slot selection.
Omit or set null to leave recurring issues without a specific timing.
PublicationExactTimeTiming
timeExact publication time (HH:mm).
typeTiming kind.
PublicationLinkModel
titleOptional human-readable publication link title.
urlPublication link URL.
PublicationLinkPatchRequest
titlePublication link title.
urlPublication link URL.
PublicationLinkRequest
titleHuman-readable publication link title.
Omit or set null to leave it unset within the publication-link payload.
urlPublication link URL.
Omit or set null to leave it unset within the publication-link payload.
PublicationManualRecurringSchedule
kindSchedule kind.
startRecurring schedule start date (yyyy-MM-dd).
typeRecurring schedule type.
endRecurring schedule end date (yyyy-MM-dd).
excludedRecurring excluded issue dates.
occurrenceCountRecurring occurrence count.
Optional exact time or time-slot selection.
PublicationManualRecurringScheduleRequest
kindSchedule kind.
startRecurring schedule start date (yyyy-MM-dd).
typeRecurring schedule type.
endRecurring schedule end date (yyyy-MM-dd).
Omit or set null to keep the recurrence open-ended unless occurrenceCount limits it.
excludedRecurring excluded issue dates.
Omit, set null, or send [] to keep the recurrence without excluded issue dates.
occurrenceCountRecurring occurrence count.
Omit or set null to control the recurrence by end instead.
Exact time or time-slot selection.
Omit or set null to leave recurring issues without a specific timing.
PublicationPatchRequest
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.
PublicationPublishedModel
dateActual publication date (yyyy-MM-dd).
timeActual publication time (HH:mm).
PublicationRecurringSchedule
Decision Table
| Variant | Matching Criteria |
|---|---|
| type = object · type="daily" · requires: kind, start, weeklySchedule | |
| type = object · type="manual" · requires: kind, start |
kindSchedule kind.
startRecurring schedule start date (yyyy-MM-dd).
typeRecurring schedule type.
Recurring weekday mask for daily schedules.
endRecurring schedule end date (yyyy-MM-dd).
excludedRecurring excluded issue dates.
occurrenceCountRecurring occurrence count.
Optional exact time or time-slot selection.
PublicationRecurringScheduleRequest
Decision Table
| Variant | Matching Criteria |
|---|---|
| type = object · type="daily" · requires: kind, start, weeklySchedule | |
| type = object · type="manual" · requires: kind, start |
kindSchedule kind.
startRecurring schedule start date (yyyy-MM-dd).
typeRecurring schedule type.
Recurring weekday mask for daily schedules.
endRecurring schedule end date (yyyy-MM-dd).
Omit or set null to keep the recurrence open-ended unless occurrenceCount limits it.
excludedRecurring excluded issue dates.
Omit, set null, or send [] to keep the recurrence without excluded issue dates.
occurrenceCountRecurring occurrence count.
Omit or set null to control the recurrence by end instead.
Exact time or time-slot selection.
Omit or set null to leave recurring issues without a specific timing.
PublicationSchedule
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.
PublicationScheduleRequest
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.
PublicationSingleSchedule
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.
PublicationSingleScheduleRequest
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.
PublicationTaskAssignmentRefRequest
localIdRequest-scoped temporary task identifier referencing tasks[].localId within the same element request. It is not persisted as the task ID.
taskIdTask ID assigned to this publication.
PublicationTimeSlotTiming
timeSlotIdPublication time slot ID.
typeTiming kind.
PublicationTiming
Decision Table
| Variant | Matching Criteria |
|---|---|
| type = object · type="exactTime" · requires: time | |
| type = object · type="timeSlot" · requires: timeSlotId |
timeExact publication time (HH:mm).
typeTiming kind.
RefreshTokenRequest
refresh_tokenRefresh token used to rotate the current token pair.
ScheduleApiModel
friWhether the shift is scheduled on Friday.
monWhether the shift is scheduled on Monday.
satWhether the shift is scheduled on Saturday.
sunWhether the shift is scheduled on Sunday.
thuWhether the shift is scheduled on Thursday.
tueWhether the shift is scheduled on Tuesday.
wedWhether the shift is scheduled on Wednesday.
ShiftApiModel
availabilityShift availability code.
endTimeShift end time.
externalIdShift ID in the external system.
idShift ID.
nameShift label.
Shift weekly schedule.
startTimeShift start time.
Shift time zone.
ShiftAvailabilityCode
Shift availability code.
Known values:
0Available1Busy2Absent
ShiftDayNoteApiModel
dateThe date this note is set for (yyyy-MM-dd).
noteContent of this note.
Shift reference.
ShiftDayNoteCreateRequest
dateThe date this note is set for (yyyy-MM-dd).
noteDaily shift note text.
ShiftDayNoteUpdateRequest
dateDate of the daily shift note (yyyy-MM-dd).
It must match the path date. null is invalid.
noteDaily shift note text.
null is invalid.
ShiftListResponse
Items returned in this response.
hasMoreWhether more results are available.
nextCursorCursor for the next page of results.
Page-based pagination metadata.
sizeRequested page size.
ShiftPatchRequest
externalIdShift ID in the external system.
Omit to leave it unchanged. Set null to clear it.
nameShift label.
Omit to leave it unchanged. null is invalid.
ShiftRef
externalIdShift ID in the external system.
idShift ID.
nameShift label.
ShiftUpdateRequest
nameShift label.
null is invalid.
externalIdShift ID in the external system.
Omit or set null to clear it.
SourcePublicationRef
externalIdSource publication ID in the external system.
idSource publication ID.
StatusListResponse
Items returned in this response.
hasMoreWhether more results are available.
nextCursorCursor for the next page of results.
Page-based pagination metadata.
sizeRequested page size.
TaskAssigneeRequest
emailAssignee email. If it matches an accessible registered user, the task is assigned to that user; otherwise the API uses or creates an unregistered assignee.
idAssigned user ID if the user belongs to your organization. When id is provided, it takes precedence over name and email.
nameUnregistered user name. Used when id is omitted and email does not resolve to a registered user in the organization.
TaskConfirmationStatusCode
Task confirmation status code.
Known values:
-2Not requested-1Rejected0Requested1Confirmed
TaskContentDocumentRequest
idFile ID.
captionCaption for image documents.
sourceSource of an image.
TaskContentRequest
Array of non-text contents for the task.
Omit, set null, or send [] to leave the task content payload without document blocks.
headlineHeadline field.
Omit or set null to leave it unset within the task content payload.
kickerKicker field.
Omit or set null to leave it unset within the task content payload.
leadLead field.
Omit or set null to leave it unset within the task content payload.
placemarkPlacemark field.
Omit or set null to leave it unset within the task content payload.
textTask text content.
Omit or set null to leave it unset within the task content payload.
TaskCreateRequest
confirmationStatusCodeTask confirmation status code.
Required on create. null is invalid.
formatIdWritable task content payload.
Omit or set null to create without task content.
Cost for this task.
Omit or set null to create without cost.
Task custom field values.
Omit, set null, or send [] to create without task custom field values.
customUploadLinkCustom upload link for this task.
Omit or set null to leave it unset on create.
Task deadline date and optional time.
Omit or set null to create without a deadline.
Task separate event.
Omit or set null to create without a separate event.
Link to assets connected to this task, also called Asset Link.
Omit or set null to create without an Asset Link.
noteSpecial note for the task.
Omit or set null to leave it unset on create.
statusIdTask status ID.
See Task Statuses for allowed values.
Omit or set null to create without a task status. Non-null values must be active for the organization.
Task text max length.
Omit or set null to create without an explicit text-length override.
Assigned user.
Omit or set null to create an unassigned task.
TaskCustomFieldApiModel
activeActive custom field state.
allowEmptyValueWhether the field accepts an empty value. Returned for selection and date fields only. When false, writing an empty value stores a default instead: the field's first option for selection fields, the current date for date fields.
Formats to which this custom field is assigned.
idCustom field ID.
nameCustom field name.
Possible options for selection in multiple-choice or single-choice fields.
typeType of custom field.
TaskDoneStateChangeItem
doneDone state to apply to the addressed task.
taskIdPersisted task ID within the addressed story or event.
TaskDoneStateChangeRequest
Task done-state changes.
Provide at least one item.
TaskExternalLinkModel
titleTitle of the Asset Link.
urlAsset Link URL.
TaskExternalLinkPatchRequest
titleAsset Link title.
Omit to leave it unchanged. Set null to clear it.
urlAsset Link URL.
Omit to leave it unchanged. Set null to clear it.
TaskExternalLinkRequest
titleTitle of the Asset Link.
Omit or set null to leave it unset within the Asset Link payload.
urlAsset Link URL.
Omit or set null to leave it unset within the Asset Link payload.
TaskFormatApiModel
activeWhether the format is active.
Default task status for the format.
idFormat ID.
nameFormat name.
Available task statuses for the format.
Text length metadata. Available only for text formats.
typeCodeTask format type code.
TaskFormatListResponse
Items returned in this response.
hasMoreWhether more results are available.
nextCursorCursor for the next page of results.
Page-based pagination metadata.
sizeRequested page size.
TaskFormatTextLengthOption
idID of the max length option.
labelLabel of the max length option.
maxValueMax length of the text content.
TaskFormatTextLengthSettings
countingTypeCodeText length counting type code.
emptyValueAllowedWhether an empty value is allowed for the text length selection.
Text format length options.
TaskFormatTypeCode
Task format type code.
Known values:
1Text2Picture3Video4Audio5Other
TaskPatchRequest
confirmationStatusCodeTask confirmation status code.
Omit to leave it unchanged. null is invalid. Cannot be changed while the task is done.
Task content.
Omit to leave it unchanged. Set null or send an empty object to clear it.
Cost for this task.
Omit to leave it unchanged. Set null to clear it.
Task custom field patch instructions.
Omit to leave it unchanged. Send [] as an empty instruction list. null is invalid.
customUploadLinkCustom upload link for this task.
Omit to leave it unchanged. Set null to clear it.
Task deadline date and optional time.
Omit to leave it unchanged. Set null to clear it.
Changing the deadline date on a done task reopens the task and clears current assignee markers.
Task separate event.
Omit to leave it unchanged. Set null to clear it.
Link to assets connected to this task, also called Asset Link.
Omit to leave it unchanged. Set null to clear it.
formatIdnoteSpecial note for the task.
Omit to leave it unchanged. Set null to clear it.
statusIdTask status ID.
See Task Statuses for allowed values.
Omit to leave it unchanged. Set null to clear it. Non-null values must be active for the organization.
Task text max length.
Omit to leave it unchanged. Set null to clear it.
Assigned user.
Omit to leave it unchanged. Set null to clear it.
Changing the assignee on a done task reopens the task and clears production date/time metadata.
When the current assignee is a registered user inaccessible to the caller (cross-organization), the GET response exposes only the display name (firstName + " " + lastName) without id; treat that name as display-only metadata. Echoing it back via user.name byte-for-byte preserves the existing assignee; any difference replaces it with a non-registered user. To preserve such an assignee safely, omit user from the request.
TextLengthTypeCode
Text length counting type code.
Known values:
1By words2By characters
TimeSlotApiModel
endTime slot end time (HH:mm).
idTime slot ID.
nameTime slot name.
startTime slot start time (HH:mm).
TokenRequest
client_idOAuth client ID used for authentication.
client_secretOAuth client secret used for authentication.
grant_typeclient_credentials · requiredOAuth grant type.
Must be client_credentials.
TokenResponse
access_tokenAccess token.
expires_inAccess token lifetime in seconds.
refresh_tokenRefresh token.
scopeGranted scopes.
token_typeToken type.
TypeApiModel
externalIdType ID in the external system.
idType ID.
nameType name.
Type platform.
TypeCreateRequest
nameType name.
externalIdType ID in the external system.
Omit or set null to leave it unset on create.
TypeListResponse
Items returned in this response.
hasMoreWhether more results are available.
nextCursorCursor for the next page of results.
Page-based pagination metadata.
sizeRequested page size.
TypePatchRequest
externalIdType ID in the external system.
Omit to leave it unchanged. Set null to clear it.
nameType name.
Omit to leave it unchanged. null is invalid.
TypeUpdateRequest
nameType name.
null is invalid.
externalIdType ID in the external system.
Omit or set null to clear it.
UserApiModel
deletionDateUser deletion date.
emailUser email address.
externalIdExternal ID.
firstNameUser first name.
Groups that the user works for.
idUser ID.
internalReturns true for internal users and false for freelancers.
lastNameUser last name.
screenNameUser screen name. This is the name that appears in Kordiam on story pages, calendars etc. right next to a format icon.
supplierIdSupplier ID.
versionUser version.
UserListResponse
Items returned in this response.
hasMoreWhether more results are available.
nextCursorCursor for the next page of results.
Page-based pagination metadata.
sizeRequested page size.
ValidationIssue
codeMachine-readable validation error code.
messageHuman-readable validation message.
pathField or parameter path identifying the invalid input.
scopeLocation of the invalid input.
ValidationProblem
Validation issues that must be fixed before retrying the request.
detailHuman-readable explanation specific to this problem occurrence.
instanceURI reference identifying this specific problem occurrence.
statusHTTP status code generated for this problem occurrence.
titleShort human-readable summary of the problem type.
traceIdTrace identifier that helps support locate the failing request.
typeURI reference identifying the problem type.
WeeklyScheduleApiModel
friFriday.
monMonday.
satSaturday.
sunSunday.
thuThursday.
tueTuesday.
wedWednesday.
WeeklyScheduleCreateRequest
friFriday.
monMonday.
satSaturday.
sunSunday.
thuThursday.
tueTuesday.
wedWednesday.
WeeklySchedulePatchRequest
friFriday.
Required when weeklySchedule is provided. null is invalid.
monMonday.
Required when weeklySchedule is provided. null is invalid.
satSaturday.
Required when weeklySchedule is provided. null is invalid.
sunSunday.
Required when weeklySchedule is provided. null is invalid.
thuThursday.
Required when weeklySchedule is provided. null is invalid.
tueTuesday.
Required when weeklySchedule is provided. null is invalid.
wedWednesday.
Required when weeklySchedule is provided. null is invalid.