Summary: Updated APIs for Content Manager. Updated APIs for Content Properties. Updated APIs for Library. Updated APIs for Search. Updated APIs for Teamsites.
Content Manager
Content Manager (v 1.0)
What's Changed
POST /v1/contentAccessPermissions
POST /v1/contentAccessPermissionsRequest:
Array of TeamSite/content pairs to resolve. Each object identifies one target item. Use
teamSiteIdas either a TeamSite UUID or1for the default TeamSite. UsecontentIdas an item UUID orrootfor TeamSite home. Maximum 1000 request objects per call.
Request body samples[ { "teamSiteId": "1", "contentId": "root" }, { "teamSiteId": "fa71f245-d1be-41c7-bb51-129ca60f9e46", "contentId": "be802102-e3b0-40b7-a790-3d50c4c21649" } ]Changed content type :
application/json
Changed items (object):
Pair of identifiers used to resolve content access permissions for a single target item. Use teamSiteId to scope the TeamSite context and contentId to identify an item GUID or TeamSite home.
New required properties:
contentIdteamSiteId
- Changed property
teamSiteId(string)Identifier of the teamsite context for the request. Accepts a GUID value or the special value
1for the default TeamSite. - Changed property
contentId(string)Identifier of the content item targeted by the operation. Accepts a GUID value or the special value
rootfor TeamSite home.
Return Type:
New response : 401 Unauthorized
Unauthorized. The request is missing a valid authentication token or the token has expired. For backward compatibility, clients should also handle equivalent auth failures returned as
403in legacy environments.
Changed response : 400 Bad Request
Bad Request. The payload format is invalid, or the request exceeds operation constraints such as the maximum batch size.
- Changed content type :
application/json
Changed response : 403 ForbiddenForbidden. The caller does not have sufficient permissions to read content access settings for one or more requested items. In some legacy environments, expired or missing authentication may also surface as
403; clients should handle both401and403for auth-related failures. - Changed content type :
application/json
New required properties:
-Application
-Message
-Status
-Type
Added propertyStatus(string)
> HTTP status code represented as a string in legacy response format.
Added propertyApplication(string)
> Service identifier that produced the error.
Added propertyType(string)
> Service exception type.
Added propertyMessage(string)
> Human-readable summary of the failure.
Added propertyErrors(array)
> Optional structured error details when available.
Items (object):
Added propertyExtraInfo(object)
> Optional service-specific metadata.
Added propertyRemediation(string)
> Suggested next action callers should take.
Added propertyCorrelationId(string)
> Request correlation identifier used for diagnostics and support.
Changed response : 404 Not FoundNot Found. One or more provided TeamSite or content identifiers cannot be resolved.
- Changed content type :
application/json
Changed response : 500 Internal Server ErrorInternal Server Error. The service failed while resolving requested permission data.
- Changed content type :
application/json
Changed response : 200 OKSuccessfully resolved content access permissions for every requested TeamSite/content pair.
- Changed content type :
application/json
Changed items (object):
> Result object for one requested TeamSite/content pair, including all members currently granted explicit permissions on that target.
New required properties:contentAccessPermissionscontentIdteamSiteId
- Added property
teamSiteId(string)Identifier of the teamsite context for this result item.
- Added property
contentId(string)Identifier of the content item for this result item.
- Added property
contentAccessPermissions(array)Permission entries for users or groups that currently have explicit access to the target content.
Items (object):
Permission details for a single user or group on one content target, including assigned permission level and editability metadata.- Property
memberId(string)Explicit identifier for the permission holder (user or group).
- Property
name(string)Display name of the permission holder.
- Property
isGroup(boolean)Indicates whether the permission holder is a group.
- Property
permissionIds(array)Permission id list for the member. Values are
403(CanView),404(CanEdit), or405(CanManage). This list contains one value.
Items (string):
Enum values:403404405
- Property
isDeleted(boolean)Indicates whether the permission holder identity is deleted. Null means the state is not applicable.
- Property
userType(string)User type when the permission holder is a user; null when the permission holder is a group.
Enum values:PREMIUMBUSINESSPARTNERnull
- Property
isFullControl(boolean)Indicates whether the permission holder has full-control capability.
- Property
isTeamSiteAdmin(boolean)Indicates whether the permission holder is TeamSiteOwner or ProfileManager in the related TeamSite. Null means inapplicable.
- Property
isTeamSiteOwner(boolean)Indicates whether the permission holder holds the TeamSiteOwner administrative role on the parent TeamSite. Null when the role state is inapplicable (for example when the entry refers to a group whose role membership is not resolvable at response time).
- Property
isProfileManager(boolean)Indicates whether the permission holder holds the ProfileManager administrative role on the parent TeamSite. Null when the role state is inapplicable. ProfileManagers have elevated permissions and are excluded from removal operations on TeamSite root per the access-removal rules.
- Property
removable(boolean)Indicates whether this content access entry can be removed by the caller.
- Property
editable(boolean)Indicates whether this content access entry can be edited by the caller.
- Property
firstName(string)First (given) name of the permission holder when the holder is a user with a populated profile. Null for groups or when the user record does not have a first name set in the tenant identity directory.
- Property
lastName(string)Last (family) name of the permission holder when the holder is a user with a populated profile. Null for groups or when the user record does not have a last name set in the tenant identity directory.
- Property
email(string)Primary email address recorded for the permission holder when the holder is a user. Null for groups or when no email is recorded on the user profile. Useful for downstream notification flows when granting or revoking access.
- Property
displayName(string)Service-rendered display name for the permission holder. For users this is typically formatted as
<firstName> <lastName>; for groups it is the group display name. Use this value when surfacing the permission holder in agent-facing UI rather than concatenating name parts manually. - Property
deactivated(boolean)Indicates whether the permission holder's account has been deactivated in the tenant. When
true, agents should avoid surfacing the holder as an active recipient for new permission grants or notifications even though the existing entry persists. - Property
hasInherited(boolean)Indicates whether the permission holder also receives effective access through inheritance from an ancestor item (parent folder or TeamSite root), in addition to this explicit entry. Null when inheritance state is inapplicable.
- Property
inheritedFromParent(boolean)Indicates whether this entry itself originates from inheritance on an ancestor item rather than being directly assigned on the target content. Null when not applicable. Inherited entries are typically not directly removable on the target content; remove them on the ancestor instead.
- Property
reason(string)Optional service-supplied reason text explaining why this entry is in its current
removable/editablestate. Populated when the service needs to communicate a non-obvious constraint (such as "last group granting caller access") to the agent or end user. - Property
thumbnailRelativePathWithSignature(string)Relative URL (with signed query parameters) at which the permission holder's avatar or profile thumbnail can be downloaded from the tenant photo service. Null when no thumbnail is available. Combine with the tenant's photo CDN base URL to render a thumbnail in agent-facing UI.
- Property
permissionChain(array)Ordered list of upstream permission nodes that contributed to this member's effective access on the target content. Each node represents one ancestor item (parent folder or TeamSite root) along the inheritance chain. Empty or null when the entry is directly assigned on the target content with no inherited contribution.
Items (object):
Single node in the permission inheritance chain. Each node identifies one ancestor content item and the permission entries that flowed from that ancestor down to the target. The exact field set may evolve over service versions — treat unknown fields defensively.
- Property
- Deleted property
id(string)Id of member with permission granted
- Deleted property
name(string)Name of member
- Deleted property
isGroup(boolean)If the member type is user group
- Deleted property
permissionIds(array)Permission id list of the member. Definition of content access permission ids are "403"--CanView, "404"--CanEdit, "405"--CanManage. The permission id list only have one value, and the value would be one of ["403","404","405"]'
- Deleted property
isDeleted(boolean)Indicate if the member is deleted. Nullable. Null means inapplicable.
- Deleted property
userType(string)User type of the member when member type is not group, value is one of PREMIUM/BUSINESS/PARTNER
- Deleted property
isFullControl(boolean)Indicate if the member has full control permission
- Deleted property
isTeamSiteAdmin(boolean)Indicate if the member has TeamOwner or ProfileManager role on content belonged teamsite. Nullable. Null means inapplicable.
- Deleted property
removable(boolean)Indicate if the content access is removable
- Deleted property
editable(boolean)Indicate if the content access is editable
DELETE /v1/teamSites/{teamSiteId}/items/{itemId}/contentAccessPermissions/members
DELETE /v1/teamSites/{teamSiteId}/items/{itemId}/contentAccessPermissions/membersParameters:
Changed: teamSiteId in path
Identifier of the teamsite context for the request. Use a TeamSite GUID or the special value
1for the default TeamSite.
Changed:itemIdinpath
Identifier of the TeamSite item whose explicit content access entries should be removed. Use a GUID for a file or folder, orrootfor TeamSite home.
Request:
Array of members whose explicit content access should be removed from the target item. Each object identifies one user or group by
memberIdplus anisGroupflag.
Request body samples[ { "memberId": "125434a6-9733-bceb-f43b-803e003f0d6f", "isGroup": false }, { "memberId": "3079eb90-23b7-1c7e-30c7-ff2b2e79a7c6", "isGroup": true } ]Changed content type :
application/json
Changed items (object):
Request model that identifies a single user or group whose explicit content access should be removed from a TeamSite item.
New required properties:
isGroupmemberId
- Changed property
memberId(string)Unique member identifier for the access entry being removed. Use a user or group GUID returned by content access listing APIs.
- Changed property
isGroup(boolean)Boolean flag indicating whether
memberIdidentifies a group instead of an individual user.
Return Type:
New response : 401 Unauthorized
Unauthorized. The request is missing a valid authentication token or the token has expired. For backward compatibility, clients should also handle equivalent auth failures returned as
403in legacy environments.
Changed response : 204 No Content
Successfully removed the requested explicit content access entries.
Changed response : 400 Bad Request
Bad Request. The request is invalid or includes members whose access cannot be removed under current business rules.
- Changed content type :
application/json
New required properties:
-Application
-Message
-Status
-Type
Added propertyStatus(string)
> HTTP status code represented as a string in legacy response format.
Added propertyApplication(string)
> Service identifier that produced the error.
Added propertyType(string)
> Service exception type.
Added propertyMessage(string)
> Human-readable summary of the failure.
Added propertyErrors(array)
> Optional structured error details when available.
Added propertyExtraInfo(object)
> Optional service-specific metadata.
Added propertyRemediation(string)
> Suggested next action callers should take.
Added propertyCorrelationId(string)
> Request correlation identifier used for diagnostics and support.
Changed response : 403 ForbiddenForbidden. The caller lacks permission to manage content access for the requested item. In some legacy environments, expired or missing authentication may also surface as
403; clients should handle both401and403for auth-related failures. - Changed content type :
application/json
New required properties:
-Application
-Message
-Status
-Type
Added propertyStatus(string)
> HTTP status code represented as a string in legacy response format.
Added propertyApplication(string)
> Service identifier that produced the error.
Added propertyType(string)
> Service exception type.
Added propertyMessage(string)
> Human-readable summary of the failure.
Added propertyErrors(array)
> Optional structured error details when available.
Added propertyExtraInfo(object)
> Optional service-specific metadata.
Added propertyRemediation(string)
> Suggested next action callers should take.
Added propertyCorrelationId(string)
> Request correlation identifier used for diagnostics and support.
Changed response : 404 Not FoundNot Found. The TeamSite or target item could not be found for the provided identifiers.
- Changed content type :
application/json
New required properties:
-Application
-Message
-Status
-Type
Added propertyStatus(string)
> HTTP status code represented as a string in legacy response format.
Added propertyApplication(string)
> Service identifier that produced the error.
Added propertyType(string)
> Service exception type.
Added propertyMessage(string)
> Human-readable summary of the failure.
Added propertyErrors(array)
> Optional structured error details when available.
Added propertyExtraInfo(object)
> Optional service-specific metadata.
Added propertyRemediation(string)
> Suggested next action callers should take.
Added propertyCorrelationId(string)
> Request correlation identifier used for diagnostics and support.
Changed response : 500 Internal Server ErrorInternal Server Error. The service failed while removing content access from the requested item.
- Changed content type :
application/json
New required properties:ApplicationMessageStatusType
- Added property
Status(string)HTTP status code represented as a string in legacy response format.
- Added property
Application(string)Service identifier that produced the error.
- Added property
Type(string)Service exception type.
- Added property
Message(string)Human-readable summary of the failure.
- Added property
Errors(array)Optional structured error details when available.
- Added property
ExtraInfo(object)Optional service-specific metadata.
- Added property
Remediation(string)Suggested next action callers should take.
- Added property
CorrelationId(string)Request correlation identifier used for diagnostics and support.
POST /v1/teamSites/{teamSiteId}/external/contents
POST /v1/teamSites/{teamSiteId}/external/contentsParameters:
Changed: teamSiteId in path
Identifier of the teamsite context for the request. Depending on API behavior, it may be a GUID-formatted value or the documented special value
1for the default teamsite.
Request:
Request body specifying the external source file to import and where to place it in the Seismic Library.
Request body samples{ "externalSource": "GoogleDrive", "externalContentId": "1XK_AinrjCzyylNGaH6oX9MUfY5-G-Y54", "parentFolderId": "6604995b-65c8-460c-abf4-2c0512292aeb", "autoSync": true }Changed content type :
application/json
New optional properties:
autoSync
- Changed property
externalSource(string)The cloud storage platform that hosts the source file. The only currently supported value is
GoogleDrive. Additional sources may be added in future API versions.
Added enum value:GoogleDrive
- Changed property
externalContentId(string)The unique identifier of the file in the external source system. For Google Drive, this is the file ID visible in the shareable URL (e.g.,
1XK_AinrjCzyylNGaH6oX9MUfY5-G-Y54). - Changed property
parentFolderId(string)The identifier of the Seismic Library folder where the imported content will be placed. Use a folder GUID for a specific subfolder, or
rootfor the top-level Library folder of the teamsite. - Changed property
autoSync(boolean)When
true, the Seismic Library item will automatically re-sync whenever the linked source file is updated in the external system. Set tofalse(or omit the field) to import the file as a one-time snapshot without ongoing synchronization. The backend defaults this value tofalsewhen the field is omitted from the request body.
Return Type:
New response : 401 Unauthorized
Unauthorized. The request is missing a valid authentication token or the token has expired. For backward compatibility, clients should also handle equivalent auth failures returned as
403in legacy environments.
Changed response : 400 Bad Request
Bad Request. The request body is missing required fields, contains invalid values, or references an unsupported external source.
- Changed content type :
application/json
New required properties:
-Application
-Message
-Status
-Type
Added propertyStatus(string)
> HTTP status code represented as a string in legacy response format.
Added propertyApplication(string)
> Service identifier that produced the error.
Added propertyType(string)
> Service exception type.
Added propertyMessage(string)
> Human-readable summary of the failure.
Added propertyErrors(array)
> Optional structured error details when available.
Added propertyExtraInfo(object)
> Optional service-specific metadata.
Added propertyRemediation(string)
> Suggested next action callers should take.
Added propertyCorrelationId(string)
> Request correlation identifier used for diagnostics and support.
Changed response : 403 ForbiddenForbidden. The caller does not have the
seismic.library.managescope or lacks write permission on the target folder. In some legacy environments, expired or missing authentication may also surface as403; clients should handle both401and403for auth-related failures. - Changed content type :
application/json
New required properties:
-Application
-Message
-Status
-Type
Added propertyStatus(string)
> HTTP status code represented as a string in legacy response format.
Added propertyApplication(string)
> Service identifier that produced the error.
Added propertyType(string)
> Service exception type.
Added propertyMessage(string)
> Human-readable summary of the failure.
Added propertyErrors(array)
> Optional structured error details when available.
Added propertyExtraInfo(object)
> Optional service-specific metadata.
Added propertyRemediation(string)
> Suggested next action callers should take.
Added propertyCorrelationId(string)
> Request correlation identifier used for diagnostics and support.
Changed response : 404 Not FoundNot Found. The specified teamsite, parent folder, external Google Drive connection, or external file could not be resolved.
- Changed content type :
application/json
New required properties:
-Application
-Message
-Status
-Type
Added propertyStatus(string)
> HTTP status code represented as a string in legacy response format.
Added propertyApplication(string)
> Service identifier that produced the error.
Added propertyType(string)
> Service exception type.
Added propertyMessage(string)
> Human-readable summary of the failure.
Added propertyErrors(array)
> Optional structured error details when available.
Added propertyExtraInfo(object)
> Optional service-specific metadata.
Added propertyRemediation(string)
> Suggested next action callers should take.
Added propertyCorrelationId(string)
> Request correlation identifier used for diagnostics and support.
Changed response : 500 Internal Server ErrorInternal Server Error. An unexpected error occurred on the server while importing the external content.
- Changed content type :
application/json
New required properties:
-Application
-Message
-Status
-Type
Added propertyStatus(string)
> HTTP status code represented as a string in legacy response format.
Added propertyApplication(string)
> Service identifier that produced the error.
Added propertyType(string)
> Service exception type.
Added propertyMessage(string)
> Human-readable summary of the failure.
Added propertyErrors(array)
> Optional structured error details when available.
Added propertyExtraInfo(object)
> Optional service-specific metadata.
Added propertyRemediation(string)
> Suggested next action callers should take.
Added propertyCorrelationId(string)
> Request correlation identifier used for diagnostics and support.
Changed response : 200 OKThe external file was successfully imported into the Seismic Library. The response contains the new Seismic content identifier for the created item.
- Changed content type :
application/json- Changed property
contentId(string -> string)The unique identifier assigned to the newly created Seismic Library content item. Use this value to query sync status, manage access, or reference the item in other Library API operations.
- Changed property
GET /v1/teamSites/{teamSiteId}/external/contents/{contentId}/syncStatus
GET /v1/teamSites/{teamSiteId}/external/contents/{contentId}/syncStatusParameters:
Changed: teamSiteId in path
Identifier of the teamsite context for the request. Depending on API behavior, it may be a GUID-formatted value or a documented special value such as
1.
Changed:contentIdinpath
Identifier of the imported Seismic Library content item whose external synchronization status should be retrieved.
Return Type:
New response : 401 Unauthorized
Unauthorized. The request is missing a valid access token or the token has expired. For backward compatibility, clients should also handle equivalent auth failures returned as
403in legacy environments.
Changed response : 400 Bad Request
Bad Request. One or more path parameters are malformed or invalid.
- Changed content type :
application/json
New required properties:
-Application
-Message
-Status
-Type
Added propertyStatus(string)
> HTTP status code represented as a string in legacy response format.
Added propertyApplication(string)
> Service identifier that produced the error.
Added propertyType(string)
> Service exception type.
Added propertyMessage(string)
> Human-readable summary of the failure.
Added propertyErrors(array)
> Optional structured error details when available.
Added propertyExtraInfo(object)
> Optional service-specific metadata.
Added propertyRemediation(string)
> Suggested next action callers should take.
Added propertyCorrelationId(string)
> Request correlation identifier used for diagnostics and support.
Changed response : 403 ForbiddenForbidden. The caller lacks permission to view synchronization status for this content. In some legacy environments, expired or missing authentication may also surface as
403; clients should handle both401and403for auth-related failures. - Changed content type :
application/json
New required properties:
-Application
-Message
-Status
-Type
Added propertyStatus(string)
> HTTP status code represented as a string in legacy response format.
Added propertyApplication(string)
> Service identifier that produced the error.
Added propertyType(string)
> Service exception type.
Added propertyMessage(string)
> Human-readable summary of the failure.
Added propertyErrors(array)
> Optional structured error details when available.
Added propertyExtraInfo(object)
> Optional service-specific metadata.
Added propertyRemediation(string)
> Suggested next action callers should take.
Added propertyCorrelationId(string)
> Request correlation identifier used for diagnostics and support.
Changed response : 404 Not FoundNot Found. The specified teamsite, content item, or external connection could not be resolved.
- Changed content type :
application/json
New required properties:
-Application
-Message
-Status
-Type
Added propertyStatus(string)
> HTTP status code represented as a string in legacy response format.
Added propertyApplication(string)
> Service identifier that produced the error.
Added propertyType(string)
> Service exception type.
Added propertyMessage(string)
> Human-readable summary of the failure.
Added propertyErrors(array)
> Optional structured error details when available.
Added propertyExtraInfo(object)
> Optional service-specific metadata.
Added propertyRemediation(string)
> Suggested next action callers should take.
Added propertyCorrelationId(string)
> Request correlation identifier used for diagnostics and support.
Changed response : 500 Internal Server ErrorInternal Server Error. An unexpected server-side error occurred while retrieving synchronization status.
- Changed content type :
application/json
New required properties:
-Application
-Message
-Status
-Type
Added propertyStatus(string)
> HTTP status code represented as a string in legacy response format.
Added propertyApplication(string)
> Service identifier that produced the error.
Added propertyType(string)
> Service exception type.
Added propertyMessage(string)
> Human-readable summary of the failure.
Added propertyErrors(array)
> Optional structured error details when available.
Added propertyExtraInfo(object)
> Optional service-specific metadata.
Added propertyRemediation(string)
> Suggested next action callers should take.
Added propertyCorrelationId(string)
> Request correlation identifier used for diagnostics and support.
Changed response : 200 OKSynchronization status was retrieved successfully for the requested content item.
- Changed content type :
application/json
New required properties:contentIdsyncStatus
- Added property
contentId(string)The unique identifier of the Seismic Library content item whose synchronization status is being reported.
- Changed property
syncStatus(string)Current synchronization state for the content item.
Pendingmeans queued,InProgressmeans actively syncing,Successmeans the latest sync completed successfully, andFailedmeans the latest sync attempt failed.
Added enum values:PendingInProgressSuccessFailed
- Changed property
error(object)Details of the synchronization failure. This object is populated only when
syncStatusisFailed; otherwise it is omitted.- Changed property
action(string)The synchronization action attempted when the failure occurred, for example
CreateLocalItemAction,DeleteLocalItemAction, orUpdateLocalItemAction. - Changed property
errorType(string)Machine-readable failure category that can be used for programmatic retry or remediation decisions.
- Changed property
errorMessage(string)Human-readable diagnostic message describing why synchronization failed.
- Changed property
POST /v1/teamSites/{teamSiteId}/items/{itemId}/contentAccessPermissions
POST /v1/teamSites/{teamSiteId}/items/{itemId}/contentAccessPermissionsParameters:
Changed: teamSiteId in path
TeamSite identifier for the access update context. Accepts a GUID value or the special value
1for the default TeamSite.
Changed:itemIdinpath
Content item identifier to update. Accepts a GUID value or the special valuerootfor TeamSite home.
Request:
Members to add or modify, and optional notification preferences for this update.
Changed content type :application/json
- Changed property
modifyContentAccessPermissions(array)Existing members whose permissions should be updated.
- Changed property
contentAccessNotify(object -> object)Notification settings for content access changes.
- Changed property
addContentAccessPermissions(array)Members and permissions to add on the target content.
Changed items (object):
Permission assignment for one user or group on a specific content item.
New required properties:isGroupmemberIdpermissionIds
- Changed property
memberId(string)Member identifier for the permission change. Use the user/group GUID returned by member lookup APIs. Legacy tenants may return
1or2, but new integrations should use GUIDs for forward compatibility. - Changed property
isGroup(boolean)Indicates member type. Use
truefor groups andfalsefor individual users. - Changed property
permissionIds(array)Permission id list for the member. Allowed values are
403(CanView),404(CanEdit), or405(CanManage). This list must contain exactly one value.
Changed items (string):
Added enum values:403404405
Return Type:
New response : 401 Unauthorized
Unauthorized. The request is missing a valid authentication token or the token has expired. For backward compatibility, clients should also handle equivalent auth failures returned as
403in legacy environments.
Changed response : 400 Bad Request
Bad Request. The permission update request is invalid or violates business rules.
- Changed content type :
application/json
New required properties:
-Application
-Message
-Status
-Type
Added propertyStatus(string)
> HTTP status code represented as a string in legacy response format.
Added propertyApplication(string)
> Service identifier that produced the error.
Added propertyType(string)
> Service exception type.
Added propertyMessage(string)
> Human-readable summary of the failure.
Added propertyErrors(array)
> Optional structured error details when available.
Added propertyExtraInfo(object)
> Optional service-specific metadata.
Added propertyRemediation(string)
> Suggested next action callers should take.
Added propertyCorrelationId(string)
> Request correlation identifier used for diagnostics and support.
Changed response : 403 ForbiddenForbidden. Caller does not have required permission to manage content access. In some legacy environments, expired or missing authentication may also surface as
403; clients should handle both401and403for auth-related failures. - Changed content type :
application/json
New required properties:
-Application
-Message
-Status
-Type
Added propertyStatus(string)
> HTTP status code represented as a string in legacy response format.
Added propertyApplication(string)
> Service identifier that produced the error.
Added propertyType(string)
> Service exception type.
Added propertyMessage(string)
> Human-readable summary of the failure.
Added propertyErrors(array)
> Optional structured error details when available.
Added propertyExtraInfo(object)
> Optional service-specific metadata.
Added propertyRemediation(string)
> Suggested next action callers should take.
Added propertyCorrelationId(string)
> Request correlation identifier used for diagnostics and support.
Changed response : 404 Not FoundNot Found. The target TeamSite or content item does not exist.
- Changed content type :
application/json
New required properties:
-Application
-Message
-Status
-Type
Added propertyStatus(string)
> HTTP status code represented as a string in legacy response format.
Added propertyApplication(string)
> Service identifier that produced the error.
Added propertyType(string)
> Service exception type.
Added propertyMessage(string)
> Human-readable summary of the failure.
Added propertyErrors(array)
> Optional structured error details when available.
Added propertyExtraInfo(object)
> Optional service-specific metadata.
Added propertyRemediation(string)
> Suggested next action callers should take.
Added propertyCorrelationId(string)
> Request correlation identifier used for diagnostics and support.
Changed response : 500 Internal Server ErrorInternal Server Error. The service failed while saving content access permissions for the requested item.
- Changed content type :
application/json
New required properties:
-Application
-Message
-Status
-Type
Added propertyStatus(string)
> HTTP status code represented as a string in legacy response format.
Added propertyApplication(string)
> Service identifier that produced the error.
Added propertyType(string)
> Service exception type.
Added propertyMessage(string)
> Human-readable summary of the failure.
Added propertyErrors(array)
> Optional structured error details when available.
Added propertyExtraInfo(object)
> Optional service-specific metadata.
Added propertyRemediation(string)
> Suggested next action callers should take.
Added propertyCorrelationId(string)
> Request correlation identifier used for diagnostics and support.
Changed response : 201 CreatedContent access permissions were saved successfully.
- Changed content type :
application/json
New required properties:itemName
- Changed property
itemName(string)Display name of the content item.
- Changed property
itemType(string)Content type, or null for TeamSite root.
- Changed property
itemFormat(string)Content format when applicable.
POST /v1/teamSites/{teamSiteId}/items/referencedProfiles
POST /v1/teamSites/{teamSiteId}/items/referencedProfilesParameters:
Changed: teamSiteId in path
Identifier of the teamsite context for the request. Depending on API behavior, it may be a GUID-formatted value or a documented special value such as
1.
Request:
Changed content type : application/json
- Changed property
requestId(string -> string)Caller-supplied identifier echoed back in the response to correlate asynchronous results with the originating request.
- Changed property
shouldSendNotification(boolean)When
true, profile subscribers and followers are notified about the newly added content; whenfalseor omitted, no notification is sent. - Changed property
actionDetails(array)One entry per target profile, specifying the profile, target folders, and the content versions to publish into that profile.
Changed items (object):
One target profile in an add-to-profile request, including the profile version, the destination folders, and the content versions to publish into it.- Changed property
profileId(string -> string)Identifier of the target Sales Enablement profile that will receive the content.
- Changed property
profileVersionId(string -> string)Identifier of the specific profile version that will reference the added content.
- Changed property
folderIds(array)Profile folders that should receive the content reference. Use
rootfor the top-level folder of the profile, or a folder GUID for a nested folder.
Changed items (string):
Profile folder identifier. Userootfor the top-level folder, or a UUID for a specific subfolder. - Changed property
contents(array)Library content versions that should be added to this profile entry. Each item identifies one content item by
contentIdandversionId.
Changed items (object):
Pair of Library identifiers that pinpoint one content version. Use this object whenever the API needs to reference a specific Library content version rather than the latest version.- Changed property
contentId(string -> string)The unique identifier for the Library content item, which is consistent across versions.
- Changed property
versionId(string -> string)The unique identifier for the specific content version being referenced.
- Changed property
- Changed property
Return Type:
New response : 401 Unauthorized
Unauthorized. The request is missing a valid authentication token or the token has expired. For backward compatibility, clients should also handle equivalent auth failures returned as
403in legacy environments.
New response : 403 Forbidden
Forbidden. The caller does not have theseismic.library.managescope or lacks permission to publish content into the target profile. In some legacy environments, expired or missing authentication may also surface as403; clients should handle both401and403for auth-related failures.
New response : 404 Not Found
Not Found. The specified TeamSite, target profile, profile folder, or Library content could not be resolved.
Changed response : 400 Bad Request
Bad Request. The request body is invalid, required fields are missing, or limits are exceeded (for example more than 100 profile entries or 100 content entries).
- Changed content type :
application/json
New required properties:
-Application
-Message
-Status
-Type
Added propertyStatus(string)
> HTTP status code represented as a string in legacy response format.
Added propertyApplication(string)
> Service identifier that produced the error.
Added propertyType(string)
> Service exception type.
Added propertyMessage(string)
> Human-readable summary of the failure.
Added propertyErrors(array)
> Optional structured error details when available.
Added propertyExtraInfo(object)
> Optional service-specific metadata.
Added propertyRemediation(string)
> Suggested next action callers should take.
Added propertyCorrelationId(string)
> Request correlation identifier used for diagnostics and support.
Changed response : 500 Internal Server ErrorInternal Server Error. The service failed while adding contents to the requested profiles.
- Changed content type :
application/json
New required properties:
-Application
-Message
-Status
-Type
Added propertyStatus(string)
> HTTP status code represented as a string in legacy response format.
Added propertyApplication(string)
> Service identifier that produced the error.
Added propertyType(string)
> Service exception type.
Added propertyMessage(string)
> Human-readable summary of the failure.
Added propertyErrors(array)
> Optional structured error details when available.
Added propertyExtraInfo(object)
> Optional service-specific metadata.
Added propertyRemediation(string)
> Suggested next action callers should take.
Added propertyCorrelationId(string)
> Request correlation identifier used for diagnostics and support.
Changed response : 200 OKAll content items were successfully added to the specified profiles.
- Changed content type :
application/json
Changed propertyrequestId(string -> string)
> The caller-suppliedrequestIdechoed from the request body, used to correlate the response with the originating request.
Changed propertyhasError(boolean)
> Aggregate flag indicating whether any content entry inactionResultDetailsfailed. Whentrue, inspect each result for per-content error messages.
Changed propertyactionResultDetails(array)
> Per-content result list. Each entry reports success or error for onecontentId+versionIdpair processed by the request.
Changed items (object):
> Result of processing one content entry in an add-to-profile or remove-from-profile request, including success status and any per-profile error messages.
Changed propertycontentId(string -> string)
> Identifier of the Library content item that this result entry refers to. Consistent across versions.
Changed propertycontentVersionId(string -> string)
> Identifier of the specific content version that was processed.
Changed propertycontentName(string)
> Display name of the content item at the time the request was processed.
Changed propertyhasError(boolean)
> Indicates whether processing of this content entry failed against any of the requested profiles. InspecterrorMessagesfor diagnostic details whentrue.
Changed propertyerrorMessages(array)
> Per-profile error messages for this content entry. Each entry typically encodes the failingprofileVersionId, anerrorType, and a human-readable reason. Empty whenhasErrorisfalse.
Changed response : 207 Multi-StatusPartial success. At least one content item encountered an error while being added to a profile. Inspect
actionResultDetailsfor per-item status. - Changed content type :
application/json- Changed property
requestId(string -> string)The caller-supplied
requestIdechoed from the request body, used to correlate the response with the originating request. - Changed property
hasError(boolean)Aggregate flag indicating whether any content entry in
actionResultDetailsfailed. Whentrue, inspect each result for per-content error messages. - Changed property
actionResultDetails(array)Per-content result list. Each entry reports success or error for one
contentId+versionIdpair processed by the request.
Changed items (object):
Result of processing one content entry in an add-to-profile or remove-from-profile request, including success status and any per-profile error messages.- Changed property
contentId(string -> string)Identifier of the Library content item that this result entry refers to. Consistent across versions.
- Changed property
contentVersionId(string -> string)Identifier of the specific content version that was processed.
- Changed property
contentName(string)Display name of the content item at the time the request was processed.
- Changed property
hasError(boolean)Indicates whether processing of this content entry failed against any of the requested profiles. Inspect
errorMessagesfor diagnostic details whentrue. - Changed property
errorMessages(array)Per-profile error messages for this content entry. Each entry typically encodes the failing
profileVersionId, anerrorType, and a human-readable reason. Empty whenhasErrorisfalse.
- Changed property
- Changed property
DELETE /v1/teamSites/{teamSiteId}/items/referencedProfiles
DELETE /v1/teamSites/{teamSiteId}/items/referencedProfilesParameters:
Changed: teamSiteId in path
Identifier of the teamsite context for the request. Depending on API behavior, it may be a GUID-formatted value or a documented special value such as
1.
Request:
Changed content type : application/json
- Changed property
requestId(string -> string)Caller-supplied identifier echoed back in the response to correlate asynchronous results with the originating request.
- Changed property
actionDetails(array)One entry per content version, listing the Sales Enablement profiles to unlink that content from.
Changed items (object):
One content version in a remove-from-profile request, listing the Sales Enablement profiles from which the content reference should be removed.- Changed property
contentId(string -> string)The unique identifier for the Library content item to unlink from the listed profiles. Consistent across versions.
- Changed property
versionId(string -> string)The unique identifier for the specific content version that is referenced by the target profiles and should be removed.
- Changed property
profiles(array)Sales Enablement profiles that currently reference this content and from which it should be unlinked.
Changed items (object):
Identifies one Sales Enablement profile and profile version, plus the profile folders involved in the operation.- Changed property
profileId(string -> string)Identifier of the Sales Enablement profile.
- Changed property
profileVersionId(string -> string)Identifier of the specific profile version targeted by the operation.
- Changed property
folderIds(array)Profile folders the operation applies to. Use
rootfor the top-level folder of the profile, or a folder GUID for a nested folder.
Changed items (string):
Profile folder identifier. Userootfor the top-level folder, or a UUID for a specific subfolder.
- Changed property
- Changed property
Return Type:
New response : 401 Unauthorized
Unauthorized. The request is missing a valid authentication token or the token has expired. For backward compatibility, clients should also handle equivalent auth failures returned as
403in legacy environments.
New response : 403 Forbidden
Forbidden. The caller does not have theseismic.library.managescope or lacks permission to update the target profile. In some legacy environments, expired or missing authentication may also surface as403; clients should handle both401and403for auth-related failures.
New response : 404 Not Found
Not Found. The specified TeamSite, target profile, or Library content could not be resolved.
Changed response : 400 Bad Request
Bad Request. The request body is invalid, required fields are missing, or limits are exceeded (for example more than 100 profile entries or 100 content entries).
- Changed content type :
application/json
New required properties:
-Application
-Message
-Status
-Type
Added propertyStatus(string)
> HTTP status code represented as a string in legacy response format.
Added propertyApplication(string)
> Service identifier that produced the error.
Added propertyType(string)
> Service exception type.
Added propertyMessage(string)
> Human-readable summary of the failure.
Added propertyErrors(array)
> Optional structured error details when available.
Added propertyExtraInfo(object)
> Optional service-specific metadata.
Added propertyRemediation(string)
> Suggested next action callers should take.
Added propertyCorrelationId(string)
> Request correlation identifier used for diagnostics and support.
Changed response : 500 Internal Server ErrorInternal Server Error. The service failed while removing contents from the requested profiles.
- Changed content type :
application/json
New required properties:
-Application
-Message
-Status
-Type
Added propertyStatus(string)
> HTTP status code represented as a string in legacy response format.
Added propertyApplication(string)
> Service identifier that produced the error.
Added propertyType(string)
> Service exception type.
Added propertyMessage(string)
> Human-readable summary of the failure.
Added propertyErrors(array)
> Optional structured error details when available.
Added propertyExtraInfo(object)
> Optional service-specific metadata.
Added propertyRemediation(string)
> Suggested next action callers should take.
Added propertyCorrelationId(string)
> Request correlation identifier used for diagnostics and support.
Changed response : 200 OKAll requested content items were successfully removed from the specified profiles.
- Changed content type :
application/json
Changed propertyrequestId(string -> string)
> The caller-suppliedrequestIdechoed from the request body, used to correlate the response with the originating request.
Changed propertyhasError(boolean)
> Aggregate flag indicating whether any content entry inactionResultDetailsfailed. Whentrue, inspect each result for per-content error messages.
Changed propertyactionResultDetails(array)
> Per-content result list. Each entry reports success or error for onecontentId+versionIdpair processed by the request.
Changed items (object):
> Result of processing one content entry in an add-to-profile or remove-from-profile request, including success status and any per-profile error messages.
Changed propertycontentId(string -> string)
> Identifier of the Library content item that this result entry refers to. Consistent across versions.
Changed propertycontentVersionId(string -> string)
> Identifier of the specific content version that was processed.
Changed propertycontentName(string)
> Display name of the content item at the time the request was processed.
Changed propertyhasError(boolean)
> Indicates whether processing of this content entry failed against any of the requested profiles. InspecterrorMessagesfor diagnostic details whentrue.
Changed propertyerrorMessages(array)
> Per-profile error messages for this content entry. Each entry typically encodes the failingprofileVersionId, anerrorType, and a human-readable reason. Empty whenhasErrorisfalse.
Changed response : 207 Multi-StatusPartial success. At least one content item encountered an error while being removed from a profile. Inspect
actionResultDetailsfor per-item status. - Changed content type :
application/json- Changed property
requestId(string -> string)The caller-supplied
requestIdechoed from the request body, used to correlate the response with the originating request. - Changed property
hasError(boolean)Aggregate flag indicating whether any content entry in
actionResultDetailsfailed. Whentrue, inspect each result for per-content error messages. - Changed property
actionResultDetails(array)Per-content result list. Each entry reports success or error for one
contentId+versionIdpair processed by the request.
Changed items (object):
Result of processing one content entry in an add-to-profile or remove-from-profile request, including success status and any per-profile error messages.- Changed property
contentId(string -> string)Identifier of the Library content item that this result entry refers to. Consistent across versions.
- Changed property
contentVersionId(string -> string)Identifier of the specific content version that was processed.
- Changed property
contentName(string)Display name of the content item at the time the request was processed.
- Changed property
hasError(boolean)Indicates whether processing of this content entry failed against any of the requested profiles. Inspect
errorMessagesfor diagnostic details whentrue. - Changed property
errorMessages(array)Per-profile error messages for this content entry. Each entry typically encodes the failing
profileVersionId, anerrorType, and a human-readable reason. Empty whenhasErrorisfalse.
- Changed property
- Changed property
Result
API changes broke backward compatibility
Content Properties
Content Properties (v v2)
What's Changed
GET /integration/v2/contentProperties/{contentPropertyId}/values
GET /integration/v2/contentProperties/{contentPropertyId}/valuesParameters:
Added: limit in query
Maximum number of values to return per page. Defaults to 100 if not specified. Use together with
offsetfor paginated traversal.
Added:offsetinquery
Zero-based index of the first value to return. Use together withlimitfor paginated traversal. Defaults to 0.
Changed:contentPropertyIdinpath
Unique identifier of the content property whose allowed values should be returned. Must be a UUID of an existing content property that has a defined domain of values.
Return Type:
New response : 400 Bad Request
Bad Request. The supplied
contentPropertyIdis not a valid UUID.
New response : 401 Unauthorized
Unauthorized. The request is missing a bearer token or the token is invalid.
New response : 403 Forbidden
Forbidden. The caller is authenticated but lacks permission to read content property values.
New response : 404 Not Found
Not Found. No content property exists for the suppliedcontentPropertyId.
New response : 500 Internal Server Error
Internal Server Error. An unexpected server-side error occurred while retrieving content property values.
Changed response : 200 OK
OK. Returns the ordered list of allowed values for the specified content property. Returns an empty array if the property has no defined domain of values.
- Changed content type :
application/json
Changed items (object):
> A single allowed value entry for a content property domain of values.
New required properties:idvalue
- Changed property
id(string)Unique identifier for this content property value entry.
- Changed property
value(string)The display string for this allowed value, as shown in the Seismic UI and used when tagging content.
POST /integration/v2/contentProperties/{contentPropertyId}/values
POST /integration/v2/contentProperties/{contentPropertyId}/valuesParameters:
Deleted: Content-Type in header
Changed: contentPropertyId in path
Unique identifier of the content property to which values should be added. Must be a UUID of an existing content property that has a defined domain of values.
Request:
Array of new value strings to add to the content property domain of values. Each string must be unique within the property's domain (case-sensitive) and the array must contain between 1 and 100 entries.
Changed content type :application/json
Changed items (string):
A new allowed value string. Case-sensitive and must not duplicate an existing value in the domain.
Return Type:
New response : 400 Bad Request
Bad Request. The supplied
contentPropertyIdis not a valid UUID, or one or more supplied values are invalid.
New response : 401 Unauthorized
Unauthorized. The request is missing a bearer token or the token is invalid.
New response : 403 Forbidden
Forbidden. The caller is authenticated but lacks permission to add content property values.
New response : 404 Not Found
Not Found. No content property exists for the suppliedcontentPropertyId.
New response : 409 Conflict
Conflict. One or more submitted values already exist in the content property's domain of values, or the property has no domain of values defined.
New response : 500 Internal Server Error
Internal Server Error. An unexpected server-side error occurred while adding content property values.
Changed response : 201 Created
Created. Returns the newly created value entries with Seismic-assigned UUIDs. Each entry corresponds to one input value string in the order submitted.
- Changed content type :
application/json
Changed items (object):
> A single newly created allowed value entry for a content property domain of values.
New required properties:idvalue
- Changed property
id(string)Unique identifier assigned by Seismic for this content property value entry.
- Changed property
value(string)The display string for the newly created allowed value, as submitted in the request body.
GET /integration/v2/contentProperties
GET /integration/v2/contentPropertiesParameters:
Added: limit in query
Maximum number of content properties to return per page. Defaults to 100 if not specified. Use together with offset for paginated traversal.
Added:offsetinquery
Zero-based index of the first content property to return. Use together with limit for paginated traversal. Defaults to 0.
Changed:teamsiteIdinquery
Filter content properties to those associated with this teamsite. Must be a valid UUID of an existing teamsite or the special value 1 for the global teamsite. Omit to return content properties across all teamsites.
Changed:includeValuesinquery
When true, includes the full list of domain values for each content property in the response. When false or omitted, the domainOfValues array is not populated.
Return Type:
New response : 400 Bad Request
Bad Request. The supplied query parameter value is invalid (for example, teamsiteId is not a valid UUID or the special value 1).
New response : 401 Unauthorized
Unauthorized. The request is missing a bearer token or the token is invalid.
New response : 403 Forbidden
Forbidden. The caller is authenticated but lacks permission to read content properties.
New response : 404 Not Found
Not Found. No teamsite exists for the supplied teamsiteId.
New response : 500 Internal Server Error
Internal Server Error. An unexpected server-side error occurred while retrieving content properties.
Changed response : 200 OK
OK. Returns the paginated list of content properties defined in the tenant, filtered by the supplied query parameters.
- Changed content type :
application/json
POST /integration/v2/contentProperties
POST /integration/v2/contentPropertiesRequest:
Content property definition to create, including its name, type, associated teamsites, and an optional initial domain of values.
Changed content type :application/json
New required properties:
nameteamsitestype
- Changed property
name(string)Display name for the new content property. Must be unique across all content properties in the tenant.
- Changed property
domainOfValues(array)Optional initial list of allowed values to seed the property's domain of values. Values are case-sensitive and must be unique within the list.
Changed items (string):
A case-sensitive allowed value string to add to the content property's domain of values. Must be unique within the list and the existing domain. - Changed property
type(string)The data type of the content property. Use
multi-valuefor properties with a fixed domain of values; usetagfor freeform tag-style input; usestring,boolean,integer,float, ordatefor structured data types. - Changed property
teamsites(array)One or more teamsites to associate with this content property. At least one teamsite must be specified.
Changed items (object):
A teamsite association entry for the content property.
New required properties:isRequiredteamsiteId
- Changed property
teamsiteId(string)Unique identifier of the teamsite to associate with this content property. Must be a valid UUID of an existing teamsite.
- Changed property
teamsiteName(string)Display name of the teamsite. Informational; the system uses
teamsiteIdfor association. - Changed property
isRequired(boolean)Whether this content property is required when tagging content in this teamsite. Set to
trueto enforce mandatory tagging.
Return Type:
New response : 400 Bad Request
Bad Request. The request body is missing required fields, contains invalid values, or specifies an unknown property type.
New response : 401 Unauthorized
Unauthorized. The request is missing a bearer token or the token is invalid.
New response : 403 Forbidden
Forbidden. The caller is authenticated but lacks permission to create content properties.
New response : 404 Not Found
Not Found. One or more of the suppliedteamsiteIdvalues do not correspond to an existing teamsite.
New response : 409 Conflict
Conflict. A content property with the same name already exists.
New response : 500 Internal Server Error
Internal Server Error. An unexpected server-side error occurred while creating the content property.
Changed response : 201 Created
Created. Returns the full content property definition with Seismic-assigned UUIDs for the property and each domain value entry.
- Changed content type :
application/json
New required properties:domainOfValueshasDomainOfValuesidnameteamsitestype
- Changed property
id(string)Unique identifier assigned by Seismic for this content property.
- Changed property
name(string)Display name of the content property as provided in the request.
- Changed property
type(string)Data type of the content property. One of string, boolean, integer, float, date, tag, or multi-value.
- Changed property
hasDomainOfValues(boolean)Indicates whether this content property has a defined domain of values.
trueifdomainOfValueswas supplied in the request or values exist. - Changed property
teamsites(array)List of teamsites associated with this content property.
Changed items (object):
A teamsite association entry for the content property.
New required properties:isRequiredteamsiteId
- Changed property
teamsiteId(string)Unique identifier of the teamsite to associate with this content property. Must be a valid UUID of an existing teamsite.
- Changed property
teamsiteName(string)Display name of the teamsite. Informational; the system uses
teamsiteIdfor association. - Changed property
isRequired(boolean)Whether this content property is required when tagging content in this teamsite. Set to
trueto enforce mandatory tagging.
- Changed property
domainOfValues(array)The domain of values entries created for this property, each with a Seismic-assigned UUID and the submitted value string.
Changed items (object):
A single allowed value entry in the content property's domain of values, returned after creation.
New required properties:idvalue
- Changed property
id(string)Unique identifier assigned by Seismic for this domain value entry.
- Changed property
value(string)The display string for this allowed value, as submitted in the request.
Result
API changes broke backward compatibility
Library
Library (v v2)
What's Changed
POST /integration/v2/teamsites/{teamsiteId}/files
POST /integration/v2/teamsites/{teamsiteId}/filesParameters:
Added: rollbackOnError in query
When true, the service automatically deletes any partially-created Library file record if the binary content upload fails after the metadata record was created, preventing orphaned draft entries in the target folder. When false or omitted, a failed upload may leave an empty metadata record behind that must be cleaned up manually. Agents performing unattended ingestion should set this to
truefor transactional safety.
Changed:resolveNameCollisioninquery
When true, automatically appends an incremented index such as(1),(2),(3)to the file name until no naming conflict exists in the target folder. When false, an upload that conflicts with an existing filename in the target folder is rejected with a 400 response. Defaults to true.
Changed:teamsiteIdinpath
Identifier of the teamsite context for the request. Depending on API behavior, it may be a GUID-formatted value or a documented special value such as1.
Request:
Multipart form data containing a JSON metadata part and a binary content part for the file to upload.
Changed content type :multipart/form-data
- Changed property
metadata(string)JSON string containing required file properties (
name,parentFolderId,format) and optional properties such asownerId,description,expiresAt, andexternalId. See the discoverableSeismic.LibraryContentManagement.AddAFile.MetadataPartschema for the full structure including field types, constraints, and validation rules. - Changed property
content(string -> string)Binary payload of the file to upload. Streamed as the second multipart part with content type application/octet-stream and stored as the file's initial version content.
Return Type:
New response : 201 Created
Created. Returns full metadata for the newly created Library file.
New response : 400 Bad Request
Bad Request. The teamsiteId is malformed, required metadata fields are missing, or the metadata JSON is invalid
New response : 401 Unauthorized
New response : 403 Forbidden
Forbidden. The caller is authenticated but does not have permission to add files to this teamsite.
New response : 404 Not Found
New response : 500 Internal Server Error
New response : 504 Gateway Timeout
Deleted response : 200 OK
OK
GET /integration/v2/teamsites/{teamsiteId}/files/{libraryContentId}/content
GET /integration/v2/teamsites/{teamsiteId}/files/{libraryContentId}/contentParameters:
Changed: redirect in query
Optional flag that controls response mode. When true, the endpoint responds with 302 and returns the temporary download link in the Location header. When false (default), the endpoint responds with 200 and returns a temporary download URL in the response body.
Changed:teamsiteIdinpath
Identifier of the teamsite context for the request. Depending on API behavior, it may be a GUID-formatted value or a documented special value such as1.
Changed:libraryContentIdinpath
Identifier of the library content item targeted by the operation. For file-specific endpoints, this must identify file content and not other content types.
Return Type:
New response : 400 Bad Request
Bad Request. The teamsiteId is malformed or the libraryContentId does not identify file content for this endpoint
New response : 401 Unauthorized
New response : 403 Forbidden
Forbidden. The caller is authenticated but does not have permission to download this file.
New response : 404 Not Found
New response : 500 Internal Server Error
New response : 504 Gateway Timeout
Changed response : 200 OK
OK. Returns a temporary download URL when redirect is false.
- New content type :
application/json - Deleted content type :
text/plain
Changed response : 302 Moved TemporarilyFound. Redirects to a temporary download URL when redirect is true.
- Changed content type :
text/plain
PUT /integration/v2/teamsites/{teamsiteId}/files/{libraryContentId}/content
PUT /integration/v2/teamsites/{teamsiteId}/files/{libraryContentId}/contentParameters:
Changed: teamsiteId in path
Identifier of the teamsite context for the request. Depending on API behavior, it may be a GUID-formatted value or a documented special value such as
1.
Changed:libraryContentIdinpath
Identifier of the library content item targeted by the operation. For file-specific endpoints, this must identify file content and not other content types.
Request:
Multipart upload payload containing the binary file content for the new version.
Changed content type :multipart/form-data
- Changed property
content(string -> string)Binary payload of the file to upload as the next version.
Return Type:
New response : 201 Created
Created. Returns metadata for the file after the new version is uploaded.
New response : 400 Bad Request
Bad Request. The teamsiteId is malformed or the libraryContentId does not identify file content for this endpoint
New response : 401 Unauthorized
New response : 403 Forbidden
Forbidden. The caller is authenticated but does not have permission to upload a new version for this file.
New response : 404 Not Found
New response : 500 Internal Server Error
New response : 504 Gateway Timeout
Deleted response : 200 OK
OK
GET /integration/v2/teamsites/{teamsiteId}/files/{libraryContentId}/versions/{libraryVersionId}/content
GET /integration/v2/teamsites/{teamsiteId}/files/{libraryContentId}/versions/{libraryVersionId}/contentParameters:
Changed: redirect in query
Optional query parameter. Accepts true or false, defaults to true. If true then response is a 302 redirect to download url,
else a 200 response with download location in response body.
Changed:teamsiteIdinpath
Identifier of the teamsite context for the request. Depending on API behavior, it may be a GUID-formatted value or a documented special value such as1.
Changed:libraryContentIdinpath
Identifier of the library content item targeted by the operation. For file-specific endpoints, this must identify file content and not other content types.
Changed:libraryVersionIdinpath
Identifier of a specific library version record when version-scoped endpoints are used.
Return Type:
New response : 400 Bad Request
Bad Request. One or more identifiers are malformed or do not reference file version content
New response : 401 Unauthorized
New response : 403 Forbidden
Forbidden. The caller is authenticated but does not have permission to download this file version.
New response : 404 Not Found
New response : 500 Internal Server Error
New response : 504 Gateway Timeout
Changed response : 200 OK
OK. Returns a temporary download URL when redirect is false.
- Changed content type :
application/json; charset=utf-8
* Changed propertydownloadUrl(string -> string)
> Temporary URL that can be used to download the requested file version content.
Changed response : 302 Moved TemporarilyFound. Redirects to a temporary download URL when redirect is true.
- Changed content type :
application/json; charset=utf-8
POST /integration/v2/teamsites/{teamsiteId}/items/{libraryContentId}/copy
POST /integration/v2/teamsites/{teamsiteId}/items/{libraryContentId}/copyParameters:
Changed: Content-Type in header
MIME type header for the request body. Use
application/jsonfor this operation.
Changed:teamsiteIdinpath
Identifier of the teamsite context for the request. Depending on API behavior, it may be a GUID-formatted value or a documented special value such as1.
Changed:libraryContentIdinpath
Identifier of the source library content item that will be copied into the destination folder.
Request:
Request payload specifying the destination folder where the copied item should be created.
Changed content type :application/json
- Changed property
parentFolderId(string)Destination folder identifier for the copied item. Use
rootto place the copy at teamsite root, or provide a folder UUID.
Return Type:
New response : 201 Created
Created. Returns metadata for the newly created copied item.
New response : 400 Bad Request
Bad Request. The teamsiteId, libraryContentId, or parentFolderId value is invalid
New response : 401 Unauthorized
New response : 403 Forbidden
Forbidden. The caller does not have permission to copy this item.
New response : 404 Not Found
New response : 500 Internal Server Error
New response : 504 Gateway Timeout
Deleted response : 200 OK
OK
PUT /integration/v2/teamsites/{teamsiteId}/items/{libraryContentId}/thumbnail
PUT /integration/v2/teamsites/{teamsiteId}/items/{libraryContentId}/thumbnailParameters:
Changed: Content-Type in header
The MIME type of the thumbnail image being uploaded. Must be one of the supported image types:
image/jpeg,image/png, orimage/tiff.
Changed:teamsiteIdinpath
Identifier of the teamsite context for the request. Depending on API behavior, it may be a GUID-formatted value or a documented special value such as1.
Changed:libraryContentIdinpath
Identifier of the library content item targeted by the operation. Must be a valid UUID referencing an existing library content item whose thumbnail will be replaced.
Request:
The thumbnail image encoded as a base64 string. The image must be in one of the supported formats: JPEG, PNG, or TIFF. Send the raw base64-encoded string as the request body.
New content type :text/plain
Return Type:
New response : 400 Bad Request
Bad Request. The teamsiteId or libraryContentId is malformed or invalid for this operation
New response : 401 Unauthorized
New response : 403 Forbidden
Forbidden. The caller is authenticated but does not have permission to replace the thumbnail on this item.
New response : 404 Not Found
New response : 500 Internal Server Error
New response : 504 Gateway Timeout
Changed response : 200 OK
OK. The thumbnail was replaced successfully. Returns the new thumbnail identifier as a plain-text UUID string.
- Changed content type :
text/plain
PUT /integration/v2/teamsites/{teamsiteId}/folders/createPath
PUT /integration/v2/teamsites/{teamsiteId}/folders/createPathParameters:
Changed: folderpath in query
Forward-slash-delimited folder path to create or resolve. Each segment between slashes becomes a folder name. A leading slash is required. Missing intermediate folders are created on the fly; if the entire path already exists, the existing leaf folder identifier is returned without modification. Each segment may be up to 255 characters.
Changed:teamsiteIdinpath
Identifier of the teamsite context for the request. Depending on API behavior, it may be a GUID-formatted value or a documented special value such as1.
Return Type:
New response : 201 Created
Created. Returns the leaf folder identifier and the full path hierarchy.
New response : 400 Bad Request
Bad Request. The teamsiteId or folderpath value is invalid
New response : 401 Unauthorized
New response : 403 Forbidden
Forbidden. The caller is authenticated but does not have the required scope to manage library folders.
New response : 404 Not Found
New response : 500 Internal Server Error
New response : 504 Gateway Timeout
Deleted response : 200 OK
OK
DELETE /integration/v2/teamsites/{teamsiteId}/items/{libraryContentId}/instructions/{instructionId}
DELETE /integration/v2/teamsites/{teamsiteId}/items/{libraryContentId}/instructions/{instructionId}Parameters:
Changed: teamsiteId in path
Identifier of the teamsite context for the request. May be a GUID or the special value
1representing the default teamsite.
Changed:libraryContentIdinpath
Identifier of the library content item that owns the instruction to delete.
Changed:instructionIdinpath
Unique identifier of the instruction to delete.
Return Type:
New response : 400 Bad Request
Bad Request. One or more path parameters are malformed or invalid
New response : 401 Unauthorized
New response : 403 Forbidden
Forbidden. The caller is authenticated but does not have the seismic.library.manage scope required for this endpoint.
New response : 404 Not Found
New response : 500 Internal Server Error
New response : 504 Gateway Timeout
Changed response : 204 No Content
No Content. The instruction was successfully deleted.
PUT /integration/v2/teamsites/{teamsiteId}/items/{libraryContentId}/submit
PUT /integration/v2/teamsites/{teamsiteId}/items/{libraryContentId}/submitParameters:
Changed: teamsiteId in path
Identifier of the teamsite context for the request. Accepts either the special value
1(representing the default teamsite) or a GUID-formatted teamsite identifier.
Changed:libraryContentIdinpath
Identifier of the library content item targeted by the operation. This must identify the content item to be submitted into the approval workflow.
Request:
Payload containing an optional comment for reviewers and an optional flag to automatically confirm workflow attestation acknowledgments.
Changed content type :application/json
- Changed property
comments(string)Optional comment to include with the workflow submission, providing context or instructions for reviewers.
- Changed property
attestationsConfirmed(boolean)If specified and set to
true, the required acknowledgments for workflows applicable to the current file are automatically considered as acknowledged by the submitter, and recorded upon the workflow submission. If not specified or set tofalse, the required acknowledgments are treated as disregarded by the submitter, and the file will be submitted to workflow without the required acknowledgments being confirmed.
Return Type:
New response : 400 Bad Request
Bad Request. One or more path parameters or request body fields are invalid
New response : 401 Unauthorized
New response : 403 Forbidden
Forbidden. The caller is authenticated but does not have permission to submit this document into workflow.
New response : 404 Not Found
New response : 500 Internal Server Error
New response : 504 Gateway Timeout
Changed response : 200 OK
OK. Returns an array of approval workflow instance identifiers created by the submission.
- Changed content type :
application/json
Changed items (string):
> Unique identifier of an approval workflow instance created by the submission.
PUT /integration/v2/teamsites/{teamsiteId}/items/{libraryContentId}/recall
PUT /integration/v2/teamsites/{teamsiteId}/items/{libraryContentId}/recallParameters:
Changed: teamsiteId in path
Identifier of the teamsite context for the request. Depending on API behavior, it may be a GUID-formatted value or a documented special value such as
1.
Changed:libraryContentIdinpath
Identifier of the library content item targeted by the operation.
Request:
Optional recall payload containing a comment explaining why the document is being recalled from the workflow.
Changed content type :application/json
- Changed property
comments(string)Optional comment explaining why the document is being recalled from the approval workflow.
Return Type:
New response : 200 OK
OK. The document was successfully recalled from the approval workflow.
New response : 400 Bad Request
Bad Request. One or more path parameters or request body fields are invalid
New response : 401 Unauthorized
New response : 403 Forbidden
Forbidden. The caller is authenticated but does not have permission to recall this document from the workflow.
New response : 404 Not Found
New response : 500 Internal Server Error
New response : 504 Gateway Timeout
Deleted response : default
PUT /integration/v2/teamsites/{teamsiteId}/items/{libraryContentId}/unpublish
PUT /integration/v2/teamsites/{teamsiteId}/items/{libraryContentId}/unpublishParameters:
Changed: teamsiteId in path
Identifier of the teamsite context for the request. May be a GUID-formatted value or the special value
1.
Changed:libraryContentIdinpath
Identifier of the library content item targeted by the operation. Must be a valid GUID referencing an existing published item.
Return Type:
New response : 400 Bad Request
Bad Request. The request contains an invalid teamsiteId or libraryContentId value
New response : 401 Unauthorized
New response : 403 Forbidden
Forbidden. The caller is authenticated but does not have permission to unpublish content.
New response : 404 Not Found
New response : 500 Internal Server Error
New response : 504 Gateway Timeout
Changed response : 200 OK
OK. The document was successfully unpublished or was already in draft state. The response body is empty; rely on the 200 status code to confirm success.
- Changed content type :
text/plain
GET /integration/v2/teamsites/{teamsiteId}/files/{libraryContentId}
GET /integration/v2/teamsites/{teamsiteId}/files/{libraryContentId}Parameters:
Changed: teamsiteId in path
Teamsite identifier that scopes the request to one teamsite context. A teamsite is a tenant-scoped Library container used to partition content metadata and access control boundaries.
Changed:libraryContentIdinpath
Library file identifier used to retrieve current file metadata.
Return Type:
New response : 400 Bad Request
Bad Request. The teamsiteId is malformed or the libraryContentId does not identify file content for this endpoint
New response : 401 Unauthorized
New response : 403 Forbidden
Forbidden. The caller is authenticated but does not have permission to view this file.
New response : 404 Not Found
New response : 500 Internal Server Error
New response : 504 Gateway Timeout
Changed response : 200 OK
OK. Returns the latest metadata for the requested Library file.
- Changed content type :
application/json- Added property
libraryMaterializedPath(string)The materialized path of the file within the library, which can be used to determine its location in the folder hierarchy.
- Added property
contentId(string)The unique identifier for the content item, which is consistent across versions.
- Added property
status(string)The latest version status of the file (for example Draft, Published, or Draft in review).
- Added property
language(string)The language of the file content, if applicable. It may be an empty string if the language is not specified.
- Added property
thumbnailId(string)The unique identifier for the thumbnail image associated with the file.
- Added property
thumbnailUrl(string)The URL to access the thumbnail image for the file.
- Changed property
repository(string)Always returns library for this endpoint, indicating that the file is stored in the library repository.
- Changed property
id(string)The unique identifier for the file.
- Changed property
versionId(string)The unique identifier for the latest version of the file.
- Changed property
externalId(string)An optional external identifier for the file, which may be used for integration with external systems. It may be an empty string if not applicable.
- Changed property
externalConnectionId(string)Optional external connection identifier associated with the externalId mapping source.
- Changed property
name(string)The name of the file.
- Changed property
type(string)For local upload or synced cloud file content, this value is file. Other Seismic content can return values such as microapp or livedoc.
- Changed property
size(number -> integer)The size of the file in bytes.
- Changed property
createdAt(string -> string)The timestamp when the file was created, in ISO 8601 format.
- Changed property
createdBy(object)Creator user reference. The nested id field behaves as createdByUserId.
- Added property
isDeleted(boolean)Indicates whether the referenced creator account is deleted.
- Added property
username(string)Login username of the user who created the file, as configured in the tenant identity directory. Returned only when the service is able to resolve the user record at response time; otherwise omitted.
- Added property
email(string)Primary email address on file for the user who created the file, used by downstream notification and collaboration features. Omitted when no email is recorded for the user.
- Added property
firstName(string)Given name of the user who created the file, returned when populated on the user record. Omitted when the user profile has no first name set or when the service cannot resolve the user.
- Added property
lastName(string)Family name of the user who created the file, returned when populated on the user record. Omitted when the user profile has no last name set or when the service cannot resolve the user.
- Added property
fullName(string)Service-rendered display name for the user who created the file, typically formatted as
<firstName> <lastName>. Use this value when surfacing the creator in agent-facing UI instead of concatenating the parts manually. - Added property
photoId(string)Identifier of the avatar/profile photo asset associated with the user who created the file. Combine with the tenant's photo CDN to render a thumbnail, or use
photoUrldirectly when available. - Added property
photoUrl(string)Fully-qualified URL pointing at the user's avatar/profile photo, used for surfacing the creator in agent-facing UI. Omitted when the user has no profile photo configured.
- Changed property
id(string)Unique user identifier for the creator account, equivalent to createdByUserId semantics.
- Added property
- Changed property
modifiedAt(string -> string)The timestamp when the file was last modified, in ISO 8601 format.
- Changed property
modifiedBy(object)Modifier user reference. The nested id field behaves as modifiedByUserId.
- Added property
isDeleted(boolean)Indicates whether the referenced modifier account is deleted.
- Added property
username(string)Login username of the user who last modified the file, as configured in the tenant identity directory. Returned only when the service is able to resolve the user record at response time; otherwise omitted.
- Added property
email(string)Primary email address on file for the user who last modified the file, used by downstream notification and collaboration features. Omitted when no email is recorded for the user.
- Added property
firstName(string)Given name of the user who last modified the file, returned when populated on the user record. Omitted when the user profile has no first name set or when the service cannot resolve the user.
- Added property
lastName(string)Family name of the user who last modified the file, returned when populated on the user record. Omitted when the user profile has no last name set or when the service cannot resolve the user.
- Added property
fullName(string)Service-rendered display name for the user who last modified the file, typically formatted as
<firstName> <lastName>. Use this value when surfacing the modifier in agent-facing UI instead of concatenating the parts manually. - Added property
photoId(string)Identifier of the avatar/profile photo asset associated with the user who last modified the file. Combine with the tenant's photo CDN to render a thumbnail, or use
photoUrldirectly when available. - Added property
photoUrl(string)Fully-qualified URL pointing at the user's avatar/profile photo, used for surfacing the modifier in agent-facing UI. Omitted when the user has no profile photo configured.
- Changed property
id(string)Unique user identifier for the modifier account, equivalent to modifiedByUserId semantics.
- Added property
- Changed property
parentFolderId(string)The identifier of the parent folder containing the file, which is root if the file is at the top level of the library.
- Changed property
format(string)The file format (for example PNG or PDF).
- Changed property
ownerId(string)The unique identifier of the user who owns the file.
- Changed property
description(string)The description for the file. May be an empty string if not set.
- Changed property
version(string)The version of the file.
- Changed property
expiresAt(string -> string)The date the file expires, in YYYY-MM-DD format. May be null or absent if no expiration is set.
- Changed property
experts(array)An array of experts associated with the file. Experts can be users or groups including their IDs and types.
Changed items (object):
Expert principal reference associated with the file for advisory ownership metadata.- Changed property
id(string)Principal identifier for the expert entry, equivalent to expertPrincipalId semantics.
- Changed property
type(string)Expert principal type resolved from backend metadata values.
Added enum values:usergroup
- Changed property
- Changed property
properties(array)An array of custom properties associated with the file, including their IDs, names, and values.
Changed items (object):
Custom property entry and its assigned values for the current file metadata snapshot.- Changed property
id(string)Property definition identifier, equivalent to propertyId semantics in teamsite configuration.
- Changed property
name(string)Display name of the custom property for human-readable output.
- Changed property
values(array)Values assigned to this property for the current file record.
Changed items (string):
- Changed property
- Changed property
assignedToProfiles(array)An array of profiles to which the file is assigned, including their IDs, names, and types.
Changed items (object):
Profile assignment entry linking the file to a content profile audience.- Changed property
id(string)Profile identifier for this assignment, equivalent to profileId semantics.
- Changed property
thumbnailId(string)Identifier for the profile thumbnail asset.
- Changed property
name(string)Display name of the assigned profile.
- Changed property
type(string)Profile classification name returned by library assignment services.
- Changed property
- Added property
PATCH /integration/v2/teamsites/{teamsiteId}/files/{libraryContentId}
PATCH /integration/v2/teamsites/{teamsiteId}/files/{libraryContentId}Parameters:
Added: includeResponse in query
When true, the response body contains the full updated file metadata payload (the same shape as the GET file endpoint). When false, the service returns an empty 200 response — useful when the caller does not need the updated metadata and wants to minimize bandwidth on bulk patch workflows. Defaults to true.
Changed:teamsiteIdinpath
Identifier of the teamsite context for the request. Depending on API behavior, it may be a GUID-formatted value or a documented special value such as1.
Changed:libraryContentIdinpath
Identifier of the library content item targeted by the operation. For file-specific endpoints, this must identify file content and not other content types.
Changed:Content-Typeinheader
MIME type header for the request payload. For this operation, sendapplication/json.
Request:
JSON object containing the file properties to update. Include only the fields you want to change; omitted fields remain unchanged.
Changed content type :application/json
- Changed property
name(string)Display name of the file as shown in Library navigation and search results. When supplied, the new name should include the appropriate file extension; the service will not auto-append one.
- Changed property
parentFolderId(string)Identifier of the destination parent folder. Use
rootto move the file to the top level of the teamsite, otherwise provide a folder UUID. When supplied, the file is moved to the new parent. - Changed property
ownerId(string)Identifier of the user to whom file ownership should be transferred (semantically
userId). May be1or2for built-in accounts or a UUID for a tenant user. Only callers with appropriate permissions may reassign ownership. - Changed property
externalId(string)Optional external identifier used to correlate this file with a record in an external system (such as a CRM or DAM). Set to empty string to clear an existing external mapping.
- Changed property
externalConnectionId(string)Optional external connection identifier associated with the
externalIdmapping source. Used to disambiguate when the same external id exists across multiple integrations. - Changed property
description(string)Free-text description shown to Library consumers. Set to empty string to clear an existing description.
- Changed property
expiresAt(string -> string)The date the file expires, in
YYYY-MM-DDformat. Must be a future date. Set to null or empty string to remove an existing expiration. - Changed property
experts(array)Replacement list of experts (subject-matter contacts) for the file. When supplied, the entire experts collection is replaced with the new list. Each entry includes the principal
idandtype(userorgroup).
Changed items (object):
An expert (subject-matter contact) associated with the file. Experts can be users or groups; thetypefield discriminates which kind so callers can resolve the identifier against the correct directory.
New required properties:idtype
- Changed property
id(string)Identifier of the expert principal (semantically
userIdwhentypeisuser,groupIdwhentypeisgroup). May be1or2for built-in accounts or a UUID for tenant users/groups. - Changed property
type(string)Principal type for the expert. Pair with
idto disambiguate user vs group identifiers when calling downstream user or group APIs.
Added enum values:usergroup
- Changed property
properties(array)Replacement list of custom property value assignments. When supplied, the entire properties collection is replaced; properties not included in the array are cleared on the file.
Changed items (object):
A custom property value assignment associated with the file. Each entry references a property definition byidand supplies one or more values to assign.
New required properties:id
- Changed property
id(string)Unique identifier (UUID) for the custom property definition. Use this
idwhen looking up the property by name or when correlating values across content items. - Changed property
name(string)Display name of the custom property as configured in the tenant. When supplied alongside
idthe service ignores it; included for human-readability of stored payloads. - Changed property
values(array)List of values to assign for this custom property. The accepted value count and value format depend on the property definition (single vs multi-value).
Changed items (string):
A single property value entry as a string. Multi-value properties may include several entries; single-value properties take one entry.
Return Type:
New response : 400 Bad Request
Bad Request. The teamsiteId is malformed, the libraryContentId does not identify file content, or the request body is invalid
New response : 401 Unauthorized
New response : 403 Forbidden
Forbidden. The caller is authenticated but does not have permission to modify this file.
New response : 404 Not Found
New response : 500 Internal Server Error
New response : 504 Gateway Timeout
Changed response : 200 OK
OK. Returns the updated metadata for the file after the patch has been applied.
- Changed content type :
application/json; charset=utf-8- Changed property
size(number -> integer)Size of the file in bytes for the current latest version. Returned as a 64-bit integer to accommodate files up to the 2 GB upload limit.
- Changed property
assignedToProfiles(array)Profile assignments controlling which downstream content profiles surface this file.
Agent note: the live runtime payload represents each entry as an object{ "id": "<profileId>", "name": "<displayName>", "type": "<assignmentType>" }. The OpenAPI item schema is documented asstringfor historical backward-compatibility reasons; treat each entry as the documented object when parsing. - Changed property
version(string)The version of the file.
- Changed property
versionId(string)The unique identifier for the latest version of the file.
- Changed property
format(string)The file format (for example PNG or PDF).
- Changed property
status(string)The latest version status of the file (for example Draft, Published, or Draft in review).
- Changed property
ownerId(string)The unique identifier of the user who owns the file.
- Changed property
thumbnailId(string)The unique identifier for the thumbnail image associated with the file.
- Changed property
thumbnailUrl(string)The URL to access the thumbnail image for the file.
- Changed property
expiresAt(string -> string)The date the file expires, in YYYY-MM-DD format. May be null or absent if no expiration is set.
- Changed property
repository(string)Always returns
libraryfor this endpoint, indicating that the file is stored in the library repository. - Changed property
id(string)The unique identifier for the file.
- Changed property
type(string)For local upload or synced cloud-file content, this value is
file. Other Seismic content may return values such asmicroapporlivedoc. - Changed property
createdAt(string -> string)The timestamp when the file was created, in ISO 8601 format.
- Changed property
createdBy(object)The user who created the file.
- Added property
username(string)Login username of the user who created the file, as configured in the tenant identity directory. Returned only when the service is able to resolve the user record at response time; otherwise omitted.
- Added property
email(string)Primary email address on file for the user who created the file, used by downstream notification and collaboration features. Omitted when no email is recorded for the user.
- Added property
firstName(string)Given name of the user who created the file, returned when populated on the user record. Omitted when the user profile has no first name set or when the service cannot resolve the user.
- Added property
lastName(string)Family name of the user who created the file, returned when populated on the user record. Omitted when the user profile has no last name set or when the service cannot resolve the user.
- Added property
fullName(string)Service-rendered display name for the user who created the file, typically formatted as
<firstName> <lastName>. Use this value when surfacing the creator in agent-facing UI instead of concatenating the parts manually. - Added property
photoId(string)Identifier of the avatar/profile photo asset associated with the user who created the file. Combine with the tenant's photo CDN to render a thumbnail, or use
photoUrldirectly when available. - Added property
photoUrl(string)Fully-qualified URL pointing at the user's avatar/profile photo, used for surfacing the creator in agent-facing UI. Omitted when the user has no profile photo configured.
- Changed property
id(string)The unique identifier of the user who created the file.
- Changed property
isDeleted(boolean)Whether the user account has been deleted.
- Added property
- Changed property
modifiedAt(string -> string)The timestamp when the file was last modified, in ISO 8601 format.
- Changed property
modifiedBy(object)The user who last modified the file.
- Added property
username(string)Login username of the user who last modified the file, as configured in the tenant identity directory. Returned only when the service is able to resolve the user record at response time; otherwise omitted.
- Added property
email(string)Primary email address on file for the user who last modified the file, used by downstream notification and collaboration features. Omitted when no email is recorded for the user.
- Added property
firstName(string)Given name of the user who last modified the file, returned when populated on the user record. Omitted when the user profile has no first name set or when the service cannot resolve the user.
- Added property
lastName(string)Family name of the user who last modified the file, returned when populated on the user record. Omitted when the user profile has no last name set or when the service cannot resolve the user.
- Added property
fullName(string)Service-rendered display name for the user who last modified the file, typically formatted as
<firstName> <lastName>. Use this value when surfacing the modifier in agent-facing UI instead of concatenating the parts manually. - Added property
photoId(string)Identifier of the avatar/profile photo asset associated with the user who last modified the file. Combine with the tenant's photo CDN to render a thumbnail, or use
photoUrldirectly when available. - Added property
photoUrl(string)Fully-qualified URL pointing at the user's avatar/profile photo, used for surfacing the modifier in agent-facing UI. Omitted when the user has no profile photo configured.
- Changed property
id(string)The unique identifier of the user who last modified the file.
- Changed property
isDeleted(boolean)Whether the user account has been deleted.
- Added property
- Changed property
parentFolderId(string)The identifier of the parent folder containing the file, which is
rootif the file is at the top level of the library. - Changed property
name(string)The name of the file.
- Changed property
externalId(string)An optional external identifier for the file, which may be used for integration with external systems. It may be an empty string if not applicable.
- Changed property
externalConnectionId(string)An optional external connection identifier for the file. It may be an empty string if not applicable.
- Changed property
experts(array)An array of experts associated with the file. Experts can be users or groups including their IDs and types.
Changed items (object):
An expert (subject-matter contact) associated with the file. Experts can be users or groups; thetypefield discriminates which kind so callers can resolve the identifier against the correct directory.
New required properties:idtype
- Changed property
id(string)Identifier of the expert principal (semantically
userIdwhentypeisuser,groupIdwhentypeisgroup). May be1or2for built-in accounts or a UUID for tenant users/groups. - Changed property
type(string)Principal type for the expert. Pair with
idto disambiguate user vs group identifiers when calling downstream user or group APIs.
Added enum values:usergroup
- Changed property
properties(array)An array of custom properties associated with the file, including their IDs, names, and values.
Changed items (object):
A custom property value assignment associated with the file. Each entry references a property definition byidand supplies one or more values to assign.
New required properties:id
- Changed property
id(string)Unique identifier (UUID) for the custom property definition. Use this
idwhen looking up the property by name or when correlating values across content items. - Changed property
name(string)Display name of the custom property as configured in the tenant. When supplied alongside
idthe service ignores it; included for human-readability of stored payloads. - Changed property
values(array)List of values to assign for this custom property. The accepted value count and value format depend on the property definition (single vs multi-value).
Changed items (string):
A single property value entry as a string. Multi-value properties may include several entries; single-value properties take one entry.
- Changed property
POST /integration/v2/teamsites/{teamsiteId}/files/{libraryContentId}/copy
POST /integration/v2/teamsites/{teamsiteId}/files/{libraryContentId}/copyParameters:
Changed: teamsiteId in path
Identifier of the teamsite context for the request. Depending on API behavior, it may be a GUID-formatted value or a documented special value such as
1.
Changed:libraryContentIdinpath
Identifier of the library content item targeted by the operation. For file-specific endpoints, this must identify file content and not other content types.
Changed:Content-Typeinheader
Media type of the request body. Must beapplication/jsonfor this endpoint.
Request:
JSON object specifying the destination folder for the copied file.
Changed content type :application/json
New required properties:
parentFolderId
- Changed property
parentFolderId(string)Identifier of the destination or current parent folder. Can be
rootwhen content is at top level, otherwise folder GUID format.
Return Type:
New response : 201 Created
Created. Returns the full metadata of the newly created file copy.
New response : 400 Bad Request
Bad Request. The teamsiteId is malformed, the libraryContentId does not identify file content, or the parentFolderId is missing or invalid
New response : 401 Unauthorized
New response : 403 Forbidden
Forbidden. The caller is authenticated but does not have permission to copy this file.
New response : 404 Not Found
New response : 500 Internal Server Error
New response : 504 Gateway Timeout
Deleted response : 200 OK
OK
POST /integration/v2/teamsites/{teamsiteId}/folders
POST /integration/v2/teamsites/{teamsiteId}/foldersParameters:
Changed: teamsiteId in path
Identifier of the teamsite context for the request. Depending on API behavior, it may be a GUID-formatted value or a documented special value such as
1.
Changed:Content-Typeinheader
MIME type header for the request payload. For this operation, sendapplication/json.
Request:
Payload that defines the folder name, target parent folder, and optional external-system identifiers.
Changed content type :application/json
New required properties:
nameparentFolderId
- Changed property
name(string)Display name for the folder to create. Provide a non-empty UTF-8 string used in Library navigation and search.
- Changed property
parentFolderId(string)Identifier of the destination or current parent folder. Can be
rootwhen content is at top level, otherwise folder GUID format. - Changed property
externalId(string)Optional external identifier used to correlate this folder with a record in an external system.
- Changed property
externalConnectionId(string)Optional external connection identifier associated with the
externalIdmapping source.
Return Type:
New response : 201 Created
Created. Returns metadata for the newly created folder.
New response : 400 Bad Request
Bad Request. The teamsiteId is malformed or the parentFolderId is invalid for folder creation
New response : 401 Unauthorized
New response : 403 Forbidden
Forbidden. The caller is authenticated but does not have the seismic.library.manage scope required to create folders in this teamsite.
New response : 404 Not Found
New response : 500 Internal Server Error
New response : 504 Gateway Timeout
Deleted response : 200 OK
OK
GET /integration/v2/teamsites/{teamsiteId}/folders/{libraryContentId}
GET /integration/v2/teamsites/{teamsiteId}/folders/{libraryContentId}Parameters:
Changed: teamsiteId in path
Identifier of the teamsite context for the request. Depending on API behavior, it may be a GUID-formatted value or a documented special value such as
1.
Changed:libraryContentIdinpath
Identifier of the library content item targeted by the operation. For folder-specific endpoints, this must identify folder content.
Return Type:
New response : 400 Bad Request
Bad Request. The teamsiteId or libraryContentId is malformed for this endpoint
New response : 401 Unauthorized
New response : 403 Forbidden
Forbidden. The caller is authenticated but does not have permission to view this folder.
New response : 404 Not Found
New response : 500 Internal Server Error
New response : 504 Gateway Timeout
Changed response : 200 OK
OK. Returns the latest metadata for the requested folder.
- Changed content type :
application/json- Added property
parentFolderId(string)Identifier of the current parent folder. It can be
rootwhen the folder is in the teamsite root. - Changed property
repository(string)Repository discriminator for this resource. For this endpoint, the value is always
library. - Changed property
id(string)Folder identifier for the returned folder resource.
- Changed property
externalId(string)Optional external identifier for the folder, used to correlate records with external systems.
- Changed property
externalConnectionId(string)Optional external connection identifier associated with the externalId mapping source.
- Changed property
name(string)Human-readable folder name shown in Library browsing and search results.
- Changed property
type(string)Content type for this resource. For this endpoint, the returned resource type is
folder. - Changed property
createdAt(string -> string)Timestamp when the folder was created, in ISO 8601 UTC format.
- Changed property
createdBy(object)Creator user reference. The nested id field behaves as createdByUserId.
- Added property
username(string)Login username of the user who created the folder, as configured in the tenant identity directory. Returned only when the service is able to resolve the user record at response time; otherwise omitted.
- Added property
email(string)Primary email address on file for the user who created the folder, used by downstream notification and collaboration features. Omitted when no email is recorded for the user.
- Added property
firstName(string)Given name of the user who created the folder, returned when populated on the user record. Omitted when the user profile has no first name set or when the service cannot resolve the user.
- Added property
lastName(string)Family name of the user who created the folder, returned when populated on the user record. Omitted when the user profile has no last name set or when the service cannot resolve the user.
- Added property
fullName(string)Service-rendered display name for the user who created the folder, typically formatted as
<firstName> <lastName>. Use this value when surfacing the creator in agent-facing UI instead of concatenating the parts manually. - Added property
photoId(string)Identifier of the avatar/profile photo asset associated with the user who created the folder. Combine with the tenant's photo CDN to render a thumbnail, or use
photoUrldirectly when available. - Added property
photoUrl(string)Fully-qualified URL pointing at the user's avatar/profile photo, used for surfacing the creator in agent-facing UI. Omitted when the user has no profile photo configured.
- Added property
isDeleted(boolean)Indicates whether the referenced user has been deleted from the tenant. When
true, agents should avoid surfacing the user as an active contact for follow-up actions on this folder. - Changed property
id(string)Semantic alias for createdByUserId, representing the unique account identifier of the user who originally created this item.
- Added property
- Changed property
modifiedAt(string -> string)Timestamp when the folder was last modified, in ISO 8601 UTC format.
- Changed property
modifiedBy(object)Modifier user reference. The nested id field behaves as modifiedByUserId.
- Added property
username(string)Login username of the user who last modified the folder, as configured in the tenant identity directory. Returned only when the service is able to resolve the user record at response time; otherwise omitted.
- Added property
email(string)Primary email address on file for the user who last modified the folder, used by downstream notification and collaboration features. Omitted when no email is recorded for the user.
- Added property
firstName(string)Given name of the user who last modified the folder, returned when populated on the user record. Omitted when the user profile has no first name set or when the service cannot resolve the user.
- Added property
lastName(string)Family name of the user who last modified the folder, returned when populated on the user record. Omitted when the user profile has no last name set or when the service cannot resolve the user.
- Added property
fullName(string)Service-rendered display name for the user who last modified the folder, typically formatted as
<firstName> <lastName>. Use this value when surfacing the modifier in agent-facing UI instead of concatenating the parts manually. - Added property
photoId(string)Identifier of the avatar/profile photo asset associated with the user who last modified the folder. Combine with the tenant's photo CDN to render a thumbnail, or use
photoUrldirectly when available. - Added property
photoUrl(string)Fully-qualified URL pointing at the user's avatar/profile photo, used for surfacing the modifier in agent-facing UI. Omitted when the user has no profile photo configured.
- Added property
isDeleted(boolean)Indicates whether the referenced user has been deleted from the tenant. When
true, agents should avoid surfacing the user as an active contact for follow-up actions on this folder. - Changed property
id(string)modifiedByUserId semantic mapping — unique user identifier for the modifier account. Treat as opaque; may be a UUID for tenant users or
1/2for built-in system accounts. Treat as opaque; may be a UUID for tenant users or1/2for built-in system accounts.
- Added property
- Added property
PATCH /integration/v2/teamsites/{teamsiteId}/folders/{libraryContentId}
PATCH /integration/v2/teamsites/{teamsiteId}/folders/{libraryContentId}Parameters:
Changed: teamsiteId in path
Identifier of the teamsite context for the request. Depending on API behavior, it may be a GUID-formatted value or a documented special value such as
1.
Changed:libraryContentIdinpath
Identifier of the library content item targeted by the operation. For folder-specific endpoints, this must identify folder content.
Changed:Content-Typeinheader
MIME type header for the request payload. For this operation, sendapplication/json.
Request:
Payload containing one or more folder metadata fields to update.
Changed content type :application/json
- Changed property
name(string)New display name for the folder. Provide a non-empty UTF-8 string used in Library navigation and search.
- Changed property
parentFolderId(string)Identifier of the destination or current parent folder. Can be
rootwhen content is at top level, otherwise folder GUID format. - Changed property
externalId(string)Optional external identifier used to correlate this folder with a record in an external system.
- Changed property
externalConnectionId(string)Optional external connection identifier associated with the
externalIdmapping source.
Return Type:
New response : 400 Bad Request
Bad Request. One or more identifiers or request fields are malformed
New response : 401 Unauthorized
New response : 403 Forbidden
Forbidden. The caller is authenticated but does not have the seismic.library.manage scope required to modify this folder.
New response : 404 Not Found
New response : 500 Internal Server Error
New response : 504 Gateway Timeout
Changed response : 200 OK
OK. Returns the latest folder metadata after the update is applied.
- Changed content type :
application/json; charset=utf-8- Changed property
repository(string)Repository discriminator for this resource. For this endpoint, the value is always
library. - Changed property
id(string)Folder identifier for the updated folder resource.
- Changed property
type(string)Content type for this resource. For this endpoint, the updated resource type is
folder. - Changed property
createdAt(string -> string)The timestamp when the folder was created, in ISO 8601 format.
- Changed property
createdBy(object)Creator user reference. The nested id field behaves as createdByUserId.
- Added property
username(string)Login username of the user who created the folder, as configured in the tenant identity directory. Returned only when the service is able to resolve the user record at response time; otherwise omitted.
- Added property
email(string)Primary email address on file for the user who created the folder, used by downstream notification and collaboration features. Omitted when no email is recorded for the user.
- Added property
firstName(string)Given name of the user who created the folder, returned when populated on the user record. Omitted when the user profile has no first name set or when the service cannot resolve the user.
- Added property
lastName(string)Family name of the user who created the folder, returned when populated on the user record. Omitted when the user profile has no last name set or when the service cannot resolve the user.
- Added property
fullName(string)Service-rendered display name for the user who created the folder, typically formatted as
<firstName> <lastName>. Use this value when surfacing the creator in agent-facing UI instead of concatenating the parts manually. - Added property
photoId(string)Identifier of the avatar/profile photo asset associated with the user who created the folder. Combine with the tenant's photo CDN to render a thumbnail, or use
photoUrldirectly when available. - Added property
photoUrl(string)Fully-qualified URL pointing at the user's avatar/profile photo, used for surfacing the creator in agent-facing UI. Omitted when the user has no profile photo configured.
- Changed property
id(string)createdByUserId semantic mapping — unique user identifier for the creator account. Treat as opaque; may be a UUID for tenant users or
1/2for built-in system accounts. Treat as opaque; may be a UUID for tenant users or1/2for built-in system accounts. - Changed property
isDeleted(boolean)Indicates whether the referenced creator account is deleted.
- Added property
- Changed property
modifiedAt(string -> string)The timestamp when the folder was last modified, in ISO 8601 format.
- Changed property
modifiedBy(object)Modifier user reference. The nested id field behaves as modifiedByUserId.
- Added property
username(string)Login username of the user who last modified the folder, as configured in the tenant identity directory. Returned only when the service is able to resolve the user record at response time; otherwise omitted.
- Added property
email(string)Primary email address on file for the user who last modified the folder, used by downstream notification and collaboration features. Omitted when no email is recorded for the user.
- Added property
firstName(string)Given name of the user who last modified the folder, returned when populated on the user record. Omitted when the user profile has no first name set or when the service cannot resolve the user.
- Added property
lastName(string)Family name of the user who last modified the folder, returned when populated on the user record. Omitted when the user profile has no last name set or when the service cannot resolve the user.
- Added property
fullName(string)Service-rendered display name for the user who last modified the folder, typically formatted as
<firstName> <lastName>. Use this value when surfacing the modifier in agent-facing UI instead of concatenating the parts manually. - Added property
photoId(string)Identifier of the avatar/profile photo asset associated with the user who last modified the folder. Combine with the tenant's photo CDN to render a thumbnail, or use
photoUrldirectly when available. - Added property
photoUrl(string)Fully-qualified URL pointing at the user's avatar/profile photo, used for surfacing the modifier in agent-facing UI. Omitted when the user has no profile photo configured.
- Changed property
id(string)modifiedByUserId semantic mapping — unique user identifier for the modifier account. Treat as opaque; may be a UUID for tenant users or
1/2for built-in system accounts. Treat as opaque; may be a UUID for tenant users or1/2for built-in system accounts. - Changed property
isDeleted(boolean)Indicates whether the referenced modifier account is deleted.
- Added property
- Changed property
parentFolderId(string)Identifier of the destination or current parent folder. Can be
rootwhen content is at top level, otherwise folder GUID format. - Changed property
name(string)Name of the folder after update.
- Changed property
externalId(string)Optional external identifier used to correlate this folder to an external system.
- Changed property
externalConnectionId(string)Optional external connection identifier associated with the externalId mapping.
- Changed property
POST /integration/v2/teamsites/{teamsiteId}/folders/{libraryContentId}/copy
POST /integration/v2/teamsites/{teamsiteId}/folders/{libraryContentId}/copyParameters:
Changed: teamsiteId in path
Identifier of the teamsite context for the request. Depending on API behavior, it may be a GUID-formatted value or a documented special value such as
1.
Changed:libraryContentIdinpath
Identifier of the library content item targeted by the operation. For folder-specific endpoints, this must identify folder content.
Changed:Content-Typeinheader
MIME type header for the request payload. For this operation, sendapplication/json.
Request:
Payload that specifies the destination parent folder where the copied folder will be created.
Changed content type :application/json
New required properties:
parentFolderIdparentFolderId
- Changed property
parentFolderId(string)Identifier of the destination or current parent folder. Can be
rootwhen content is at top level, otherwise folder GUID format.
Return Type:
New response : 201 Created
Created. Returns metadata for the copied folder resource.
New response : 400 Bad Request
Bad Request. The teamsiteId, libraryContentId, or parentFolderId is malformed
New response : 401 Unauthorized
New response : 403 Forbidden
Forbidden. The caller is authenticated but does not have permission to copy this folder.
New response : 404 Not Found
New response : 500 Internal Server Error
New response : 504 Gateway Timeout
Deleted response : 200 OK
OK
GET /integration/v2/teamsites/{teamsiteId}/folders/{libraryContentId}/items
GET /integration/v2/teamsites/{teamsiteId}/folders/{libraryContentId}/itemsParameters:
Changed: limit in query
Maximum number of items to return in one page. This value cannot exceed 1000.
Changed:offsetinquery
Zero-based number of items to skip before returning results for pagination.
Changed:includeExpirationinquery
If specified and set to 'true', the item's ExpiresAt field will be filled, if it has an expiration date.
Changed:includePropertiesinquery
If specified and set to 'true', the items's Properties field will be filled, if it has custom properties.
Changed:teamsiteIdinpath
Identifier of the teamsite context for the request. Depending on API behavior, it may be a GUID-formatted value or a documented special value such as1.
Changed:libraryContentIdinpath
Identifier of the folder content item whose children are returned by this operation.
Return Type:
New response : 400 Bad Request
Bad Request. One or more request parameters are malformed
New response : 401 Unauthorized
New response : 403 Forbidden
Forbidden. The caller is authenticated but does not have permission to view folder items.
New response : 404 Not Found
New response : 500 Internal Server Error
New response : 504 Gateway Timeout
Changed response : 200 OK
OK. Returns a paginated list of item summaries for the requested folder.
- Changed content type :
application/json- Changed property
totalCount(number -> integer)Total number of items available in the folder for the current filter scope.
- Changed property
limit(string -> integer)Maximum number of items requested per page in this response.
- Changed property
offset(string -> integer)Zero-based index of the first item included in this page.
- Changed property
entries(array)Item summaries returned for the requested folder page.
Changed items (object):
Item summary entry representing a folder child resource returned by listing.- Added property
thumbnailId(string)Optional identifier for the item's thumbnail asset when a thumbnail exists.
- Added property
thumbnailUrl(string)Optional URL that can be used to retrieve the thumbnail preview.
- Added property
versionId(string)Identifier of the latest version for versioned item types.
- Added property
format(string)Format indicator for content types where format is applicable.
- Added property
size(integer)File size in bytes for file-type entries.
- Added property
ownerId(string)Identifier of the owner user for entries that support ownership metadata.
- Added property
description(string)Optional free-text description stored on the content item.
- Added property
version(string)Version label for items that support versioned revisions.
- Added property
expiresAt(string)Optional expiration date for items configured with expiration metadata, in YYYY-MM-DD format.
- Added property
properties(array)Optional custom property assignments for the listed item.
Items (object):- Property
id(string)The propertyId (unique identifier) of the content property definition as configured in the Seismic Library. Use this to identify which property the values belong to.
- Property
name(string)The display name of the custom property as defined in the Seismic Library configuration.
- Property
values(array)The list of string values assigned to this custom property for this file.
Items (string):
- Property
- Added property
url(object)URL payload for URL-type entries.
- Property
url(string)The target URL that this content item points to.
- Property
openInNewWindow(boolean)Whether the URL opens in a new browser window or is displayed inside the Seismic application.
- Property
- Changed property
repository(string)Repository discriminator for this entry. For this endpoint, the value is always
library. - Changed property
id(string)Identifier of the listed item entry within Library content storage.
- Changed property
externalId(string)Optional external identifier used to correlate this item with external systems.
- Changed property
externalConnectionId(string)Optional external connection identifier associated with the external item mapping.
- Changed property
name(string)Display name of the listed item, as shown in Library navigation and search results.
- Changed property
type(string)Item type classification used by clients to dispatch to the right type-specific operation or renderer. The value is one of the supported Library content kinds.
Added enum values:filefolderurlmicroapplivedoc
- Changed property
createdAt(string -> string)Timestamp when this item was created, in ISO 8601 UTC format.
- Changed property
createdBy(object)Creator user reference. The nested id field behaves as createdByUserId.
- Added property
username(string)Login username of the user who created the Library content item, as configured in the tenant identity directory. Returned only when the service is able to resolve the user record at response time; otherwise omitted.
- Added property
email(string)Primary email address on file for the user who created the Library content item, used by downstream notification and collaboration features. Omitted when no email is recorded for the user.
- Added property
firstName(string)Given name of the user who created the Library content item, returned when populated on the user record. Omitted when the user profile has no first name set or when the service cannot resolve the user.
- Added property
lastName(string)Family name of the user who created the Library content item, returned when populated on the user record. Omitted when the user profile has no last name set or when the service cannot resolve the user.
- Added property
fullName(string)Service-rendered display name for the user who created the Library content item, typically formatted as
<firstName> <lastName>. Use this value when surfacing the creator in agent-facing UI instead of concatenating the parts manually. - Added property
photoId(string)Identifier of the avatar/profile photo asset associated with the user who created the Library content item. Combine with the tenant's photo CDN to render a thumbnail, or use
photoUrldirectly when available. - Added property
photoUrl(string)Fully-qualified URL pointing at the user's avatar/profile photo, used for surfacing the creator in agent-facing UI. Omitted when the user has no profile photo configured.
- Changed property
id(string)createdByUserId semantic mapping — unique user identifier for the creator account. Treat as opaque; may be a UUID for tenant users or
1/2for built-in system accounts. Treat as opaque; may be a UUID for tenant users or1/2for built-in system accounts. - Changed property
isDeleted(boolean)Indicates whether the referenced creator account has been deleted.
- Added property
- Changed property
modifiedAt(string -> string)Timestamp when this item was last modified, in ISO 8601 UTC format.
- Changed property
modifiedBy(object)Modifier user reference. The nested id field behaves as modifiedByUserId.
- Added property
username(string)Login username of the user who last modified the Library content item, as configured in the tenant identity directory. Returned only when the service is able to resolve the user record at response time; otherwise omitted.
- Added property
email(string)Primary email address on file for the user who last modified the Library content item, used by downstream notification and collaboration features. Omitted when no email is recorded for the user.
- Added property
firstName(string)Given name of the user who last modified the Library content item, returned when populated on the user record. Omitted when the user profile has no first name set or when the service cannot resolve the user.
- Added property
lastName(string)Family name of the user who last modified the Library content item, returned when populated on the user record. Omitted when the user profile has no last name set or when the service cannot resolve the user.
- Added property
fullName(string)Service-rendered display name for the user who last modified the Library content item, typically formatted as
<firstName> <lastName>. Use this value when surfacing the modifier in agent-facing UI instead of concatenating the parts manually. - Added property
photoId(string)Identifier of the avatar/profile photo asset associated with the user who last modified the Library content item. Combine with the tenant's photo CDN to render a thumbnail, or use
photoUrldirectly when available. - Added property
photoUrl(string)Fully-qualified URL pointing at the user's avatar/profile photo, used for surfacing the modifier in agent-facing UI. Omitted when the user has no profile photo configured.
- Changed property
id(string)modifiedByUserId semantic mapping — unique user identifier for the modifier account. Treat as opaque; may be a UUID for tenant users or
1/2for built-in system accounts. Treat as opaque; may be a UUID for tenant users or1/2for built-in system accounts. - Changed property
isDeleted(boolean)Indicates whether the referenced modifier account has been deleted.
- Added property
- Changed property
parentFolderId(string)Identifier of the item's parent folder. It can be
rootfor top-level items.
- Added property
- Changed property
DELETE /integration/v2/teamsites/{teamsiteId}/items/{libraryContentId}
DELETE /integration/v2/teamsites/{teamsiteId}/items/{libraryContentId}Parameters:
Changed: teamsiteId in path
Identifier of the teamsite context for the request. Depending on API behavior, it may be a GUID-formatted value or a documented special value such as
1.
Changed:libraryContentIdinpath
Identifier of the library content item to delete within the teamsite scope.
Return Type:
New response : 400 Bad Request
Bad Request. The teamsiteId or libraryContentId format is invalid
New response : 401 Unauthorized
New response : 403 Forbidden
Forbidden. The caller does not have permission to delete this item.
New response : 404 Not Found
New response : 500 Internal Server Error
New response : 504 Gateway Timeout
Changed response : 200 OK
OK. The item was deleted successfully.
- Changed content type :
text/plain
GET /integration/v2/teamsites/{teamsiteId}/items/{libraryContentId}
GET /integration/v2/teamsites/{teamsiteId}/items/{libraryContentId}Parameters:
Changed: teamsiteId in path
Identifier of the teamsite context for the request. Depending on API behavior, it may be a GUID-formatted value or a documented special value such as
1.
Changed:libraryContentIdinpath
Identifier of the library content item targeted by this metadata lookup operation.
Return Type:
New response : 400 Bad Request
Bad Request. The teamsiteId or libraryContentId format is invalid
New response : 401 Unauthorized
New response : 403 Forbidden
Forbidden. The caller does not have permission to view this item.
New response : 404 Not Found
New response : 500 Internal Server Error
New response : 504 Gateway Timeout
Changed response : 200 OK
OK. Returns the latest metadata snapshot for the requested item.
- Changed content type :
application/json- Changed property
repository(string)Repository discriminator for this resource. For this endpoint, the value is always
library. - Changed property
id(string)Unique identifier of the requested Library content item, used for retrieval, updates, and cross-endpoint correlation workflows.
- Changed property
thumbnailId(string)Optional identifier for the thumbnail asset linked to this item, present only when thumbnail metadata has been generated.
- Changed property
versionId(string)Identifier for the latest version record of this item when versioning applies.
- Changed property
externalId(string)Optional external identifier used to correlate this item with external systems.
- Changed property
externalConnectionId(string)Optional external connection identifier associated with the external item mapping.
- Changed property
name(string)Display name of the item returned by the metadata lookup, shown in Library navigation and integration surfaces.
- Changed property
type(string)Item type classification used by clients to dispatch to the right type-specific operation or renderer. The value is one of the supported Library content kinds.
Added enum values:filefolderurlmicroapplivedoc
- Changed property
createdAt(string -> string)Timestamp when the item was created, in ISO 8601 UTC format.
- Changed property
createdBy(object)Creator user reference. The nested id field behaves as createdByUserId.
- Added property
username(string)Login username of the user who created the Library content item, as configured in the tenant identity directory. Returned only when the service is able to resolve the user record at response time; otherwise omitted.
- Added property
email(string)Primary email address on file for the user who created the Library content item, used by downstream notification and collaboration features. Omitted when no email is recorded for the user.
- Added property
firstName(string)Given name of the user who created the Library content item, returned when populated on the user record. Omitted when the user profile has no first name set or when the service cannot resolve the user.
- Added property
lastName(string)Family name of the user who created the Library content item, returned when populated on the user record. Omitted when the user profile has no last name set or when the service cannot resolve the user.
- Added property
fullName(string)Service-rendered display name for the user who created the Library content item, typically formatted as
<firstName> <lastName>. Use this value when surfacing the creator in agent-facing UI instead of concatenating the parts manually. - Added property
photoId(string)Identifier of the avatar/profile photo asset associated with the user who created the Library content item. Combine with the tenant's photo CDN to render a thumbnail, or use
photoUrldirectly when available. - Added property
photoUrl(string)Fully-qualified URL pointing at the user's avatar/profile photo, used for surfacing the creator in agent-facing UI. Omitted when the user has no profile photo configured.
- Added property
isDeleted(boolean)Indicates whether the referenced user has been deleted from the tenant. When
true, agents should avoid surfacing the user as an active contact for follow-up actions on this Library content item. - Changed property
id(string)createdByUserId semantic mapping — unique user identifier for the creator account. Treat as opaque; may be a UUID for tenant users or
1/2for built-in system accounts. Treat as opaque; may be a UUID for tenant users or1/2for built-in system accounts.
- Added property
- Changed property
modifiedAt(string -> string)Timestamp when the item was last modified, in ISO 8601 UTC format.
- Changed property
modifiedBy(object)Modifier user reference. The nested id field behaves as modifiedByUserId.
- Added property
username(string)Login username of the user who last modified the Library content item, as configured in the tenant identity directory. Returned only when the service is able to resolve the user record at response time; otherwise omitted.
- Added property
email(string)Primary email address on file for the user who last modified the Library content item, used by downstream notification and collaboration features. Omitted when no email is recorded for the user.
- Added property
firstName(string)Given name of the user who last modified the Library content item, returned when populated on the user record. Omitted when the user profile has no first name set or when the service cannot resolve the user.
- Added property
lastName(string)Family name of the user who last modified the Library content item, returned when populated on the user record. Omitted when the user profile has no last name set or when the service cannot resolve the user.
- Added property
fullName(string)Service-rendered display name for the user who last modified the Library content item, typically formatted as
<firstName> <lastName>. Use this value when surfacing the modifier in agent-facing UI instead of concatenating the parts manually. - Added property
photoId(string)Identifier of the avatar/profile photo asset associated with the user who last modified the Library content item. Combine with the tenant's photo CDN to render a thumbnail, or use
photoUrldirectly when available. - Added property
photoUrl(string)Fully-qualified URL pointing at the user's avatar/profile photo, used for surfacing the modifier in agent-facing UI. Omitted when the user has no profile photo configured.
- Added property
isDeleted(boolean)Indicates whether the referenced user has been deleted from the tenant. When
true, agents should avoid surfacing the user as an active contact for follow-up actions on this Library content item. - Changed property
id(string)Semantic alias for modifiedByUserId, representing the unique account identifier of the last user who updated this item.
- Added property
- Changed property
parentFolderId(string)Identifier of the parent folder containing this item. It can be
rootfor top-level items. - Changed property
ownerId(string)Owner user identifier for item types that support ownership metadata.
- Changed property
description(string)Optional free-text description saved on the item metadata.
- Changed property
version(string)Version label for item types that support versioning.
- Changed property
expiresAt(string -> string)Optional expiration date for items configured with expiration metadata, in YYYY-MM-DD format.
- Changed property
url(object)URL data payload returned for URL-type items.
- Changed property
url(string -> string)Absolute HTTP or HTTPS destination URL configured for this item and used by clients when rendering or opening the linked resource.
- Changed property
openInNewWindow(boolean)Indicates whether consumers should open the configured URL in a new browser window instead of navigating within the current application context.
- Changed property
- Changed property
experts(array)Expert principal assignments associated with the item.
Changed items (object):
Expert principal reference associated with the item.- Changed property
id(string)Identifier of the expert principal (user or group) associated with the content item. Pair with
typeto disambiguate user vs group when calling downstream APIs. - Changed property
type(string)Principal type represented by this expert entry.
- Changed property
- Changed property
properties(array)Custom property assignments configured on the item.
Changed items (object):
Custom property entry and values assigned to the item.- Changed property
id(string)Property definition identifier (UUID) for this custom property. Use to look up the property definition or to update the values via the custom-property endpoints.
- Changed property
name(string)Human-readable name of the custom property.
- Changed property
values(array)Values assigned to this custom property for the item.
Changed items (string):
- Changed property
- Changed property
assignedToProfiles(array)Content profile assignments associated with this item.
Changed items (object):
Profile assignment entry linking this item to a content profile audience.- Changed property
id(string)Profile identifier for this URL-content assignment entry, used to map the URL to a specific consumer-facing profile or surface.
- Changed property
name(string)Display name of the assigned profile.
- Changed property
type(string)Profile classification for this assignment entry.
- Changed property
- Changed property
GET /integration/v2/teamsites/{teamsiteId}/items/{libraryContentId}/versions
GET /integration/v2/teamsites/{teamsiteId}/items/{libraryContentId}/versionsParameters:
Changed: teamsiteId in path
Identifier of the teamsite context for the request. Depending on API behavior, it may be a GUID-formatted value or a documented special value such as
1.
Changed:libraryContentIdinpath
Identifier of the library content item targeted by this version-history lookup operation.
Return Type:
New response : 400 Bad Request
Bad Request. The teamsiteId or libraryContentId format is invalid
New response : 401 Unauthorized
New response : 403 Forbidden
Forbidden. The caller does not have permission to access this item's version history.
New response : 404 Not Found
New response : 500 Internal Server Error
New response : 504 Gateway Timeout
Changed response : 200 OK
OK. Returns all discovered versions for the requested item from newest to oldest.
- Changed content type :
application/json
Changed items (object):
> A single version record for the requested Library item, including version identifier and creation metadata.- Added property
libraryContentId(string)Explicit semantic alias for the item identifier, matching the
libraryContentIdpath parameter used to request version history. - Changed property
id(string)The unique identifier for the Library item whose version history is being returned. This field mirrors
libraryContentIdfor backward compatibility. - Changed property
versionId(string)Identifier of a specific immutable version record for this item.
- Changed property
createdAt(string -> string)Timestamp when this version was created in ISO 8601 UTC (RFC3339) format, used to sort versions and identify the most recent revision.
- Changed property
version(string)Human-friendly version label used for display and selection workflows. This label is not a globally stable identifier across different items.
- Added property
GET /integration/v2/teamsites/{teamsiteId}/items
GET /integration/v2/teamsites/{teamsiteId}/itemsParameters:
Added: externalConnectionId in query
External connection identifier used to filter items linked to a specific external integration. Used together with
externalIdto disambiguate when the same external identifier appears across multiple integrations. At least one ofexternalIdorexternalConnectionIdmust be supplied; the service responds 400 Bad Request when both are omitted.
Changed:externalIdinquery
External identifier used to filter items linked to an external system. Only items whoseexternalIdmatches this value are returned. At least one ofexternalIdorexternalConnectionIdmust be supplied — the service rejects requests with neither parameter set as a 400 Bad Request.
Changed:teamsiteIdinpath
Identifier of the teamsite context for the request. Depending on API behavior, it may be a GUID-formatted value or a documented special value such as1.
Return Type:
New response : 400 Bad Request
Bad Request. The teamsiteId is malformed or a query parameter value is invalid
New response : 401 Unauthorized
New response : 403 Forbidden
Forbidden. The caller is authenticated but does not have permission to view items in this teamsite.
New response : 404 Not Found
New response : 500 Internal Server Error
New response : 504 Gateway Timeout
Changed response : 200 OK
OK. Returns the count and list of items matching the query filters within the specified teamsite.
- Changed content type :
application/json- Changed property
itemCount(number -> integer)The total number of items matching the query filters. Capped at 50 because this endpoint is intentionally limited and does not paginate.
- Changed property
items(array)An array of Library items matching the query filters. Each item contains metadata such as name, type, timestamps, and parent folder. Capped at 50 entries.
Changed items (object):
Metadata for a single Library item returned by the items query endpoint. Items may be files, folders, URLs, microapps, or livedocs; thetypefield discriminates the kind so callers can dispatch to type-specific operations.- Added property
externalConnectionId(string)Optional external connection identifier associated with the
externalIdmapping source, used to disambiguate when the same external id exists across multiple integrations. - Added property
versionId(string)Identifier of the latest version record for the item when versioning applies (files). Absent for content types without version history (folders).
- Added property
expiresAt(string)Optional expiration date in
YYYY-MM-DDformat. Present for file and URL content items when expiration is configured; absent for content types without expiration or when no expiration was set. - Changed property
repository(string)Repository discriminator for the resource. For this endpoint the value is always
library, indicating the item is stored in the Library repository. - Changed property
id(string)Unique identifier (semantically the
libraryContentId) for this item, used to look up full metadata, copy, download, or delete the item via type-specific endpoints. - Changed property
thumbnailId(string)Unique identifier for the thumbnail image asset associated with the item, present only when thumbnail metadata has been generated. Combine with the thumbnail service base URL to retrieve the image.
- Changed property
name(string)Display name of the item as shown in Library navigation, search results, and integration surfaces.
- Changed property
externalId(string)Optional external identifier used to correlate this item with a record in an external system (such as a CRM or DAM). May be an empty string when no external mapping is configured.
- Changed property
type(string)The content type of the item. Use the value to dispatch to a type-specific endpoint or renderer. Possible values are
file,folder,url,microapp, andlivedoc.
Added enum values:filefolderurlmicroapplivedoc
- Changed property
createdAt(string -> string)The timestamp when the item was created, in ISO 8601 format.
- Changed property
createdBy(object)Reference to the user who created the listed item, used for audit attribution. Contains the user identifier (semantically
createdByUserId) and the account deletion status.- Added property
isDeleted(boolean)Indicates whether the creator user account has since been deleted from the tenant. When true the user record is no longer active and the
idmay not resolve to a current account. - Added property
username(string)Login username of the user who created the Library content item, as configured in the tenant identity directory. Returned only when the service is able to resolve the user record at response time; otherwise omitted.
- Added property
email(string)Primary email address on file for the user who created the Library content item, used by downstream notification and collaboration features. Omitted when no email is recorded for the user.
- Added property
firstName(string)Given name of the user who created the Library content item, returned when populated on the user record. Omitted when the user profile has no first name set or when the service cannot resolve the user.
- Added property
lastName(string)Family name of the user who created the Library content item, returned when populated on the user record. Omitted when the user profile has no last name set or when the service cannot resolve the user.
- Added property
fullName(string)Service-rendered display name for the user who created the Library content item, typically formatted as
<firstName> <lastName>. Use this value when surfacing the creator in agent-facing UI instead of concatenating the parts manually. - Added property
photoId(string)Identifier of the avatar/profile photo asset associated with the user who created the Library content item. Combine with the tenant's photo CDN to render a thumbnail, or use
photoUrldirectly when available. - Added property
photoUrl(string)Fully-qualified URL pointing at the user's avatar/profile photo, used for surfacing the creator in agent-facing UI. Omitted when the user has no profile photo configured.
- Changed property
id(string)createdByUserId semantic mapping — unique user identifier for the creator account. Treat as opaque; may be a UUID for tenant users or
1/2for built-in system accounts.
- Added property
- Changed property
modifiedAt(string -> string)Timestamp when the item was last modified, in ISO 8601 UTC format. Updated whenever metadata or version content changes.
- Changed property
modifiedBy(object)Reference to the user who last modified the listed item, used for audit attribution. Contains the user identifier (semantically
modifiedByUserId) and the account deletion status.- Added property
isDeleted(boolean)Indicates whether the modifier user account has since been deleted from the tenant. When true the user record is no longer active and the
idmay not resolve to a current account. - Added property
username(string)Login username of the user who last modified the Library content item, as configured in the tenant identity directory. Returned only when the service is able to resolve the user record at response time; otherwise omitted.
- Added property
email(string)Primary email address on file for the user who last modified the Library content item, used by downstream notification and collaboration features. Omitted when no email is recorded for the user.
- Added property
firstName(string)Given name of the user who last modified the Library content item, returned when populated on the user record. Omitted when the user profile has no first name set or when the service cannot resolve the user.
- Added property
lastName(string)Family name of the user who last modified the Library content item, returned when populated on the user record. Omitted when the user profile has no last name set or when the service cannot resolve the user.
- Added property
fullName(string)Service-rendered display name for the user who last modified the Library content item, typically formatted as
<firstName> <lastName>. Use this value when surfacing the modifier in agent-facing UI instead of concatenating the parts manually. - Added property
photoId(string)Identifier of the avatar/profile photo asset associated with the user who last modified the Library content item. Combine with the tenant's photo CDN to render a thumbnail, or use
photoUrldirectly when available. - Added property
photoUrl(string)Fully-qualified URL pointing at the user's avatar/profile photo, used for surfacing the modifier in agent-facing UI. Omitted when the user has no profile photo configured.
- Changed property
id(string)modifiedByUserId semantic mapping — unique user identifier for the modifier account. Treat as opaque; may be a UUID for tenant users or
1/2for built-in system accounts.
- Added property
- Changed property
parentFolderId(string)Identifier of the parent folder containing the item. Value is
rootwhen the item is at the top level of the teamsite library, otherwise a folder UUID.
- Added property
- Changed property
POST /integration/v2/teamsites/{teamsiteId}/urls
POST /integration/v2/teamsites/{teamsiteId}/urlsAdd a URL
Parameters:
Changed: teamsiteId in path
Identifier of the teamsite context for the request. Depending on API behavior, it may be a GUID-formatted value or a documented special value such as
1.
Changed:Content-Typeinheader
Media type of the request body. Must beapplication/json.
Request:
JSON object containing the URL content metadata to create.
Changed content type :application/json
New required properties:
nameparentFolderIdurl
- Changed property
name(string)The display name of the URL content item shown in Library navigation, search results, and integration surfaces.
- Changed property
parentFolderId(string)The identifier of the destination parent folder. Use
rootto place the URL at the top level of the library, otherwise provide a folder UUID. - Changed property
externalId(string)Optional external identifier used to correlate this URL with a record in an external system (such as a CRM or DAM). Provide a value when the URL was created in response to an external trigger.
- Changed property
externalConnectionId(string)Optional external connection identifier associated with the
externalIdmapping source. Used together withexternalIdto disambiguate when the same external identifier exists in multiple integrations. - Changed property
description(string)Optional free-text description shown to Library consumers. Supports brief context about what the linked URL contains and how to use it. May be empty.
- Changed property
expiresAt(string -> string)Optional expiration date in
YYYY-MM-DDformat. After this date the URL is treated as expired in consumer surfaces. Must be a future date when set. - Changed property
format(string)Content format indicator. Typically
Urlfor URL content items; included for parity with file/folder format fields and for downstream rendering hints. - Changed property
url(object)An object containing the URL string and its display behavior.
- Changed property
url(string)The target URL that this content item points to.
- Changed property
openInNewWindow(boolean)Whether the URL opens in a new browser window or is displayed inside the Seismic application.
- Changed property
- Changed property
experts(array)An array of experts (subject matter experts) to associate with the URL content item. Each expert has an
idand atype(userorgroup) and is surfaced to consumers seeking subject expertise on the linked content.
Changed items (object):
An expert associated with the URL content item. Experts can be users or groups.- Changed property
id(string)The unique identifier of the expert (user ID or group ID).
- Changed property
type(string)The type of expert, either
userorgroup.
- Changed property
- Changed property
properties(array)An array of custom properties to assign to the URL content item. Each property is identified by its
idand includes an array ofvalues.
Changed items (object):
A custom property associated with the URL content item, including its ID, name, and values.- Changed property
id(string -> string)The unique identifier of the custom property.
- Changed property
name(string)The display name of the custom property.
- Changed property
values(array)An array of values assigned to the custom property.
- Changed property
Return Type:
New response : 201 Created
Created. Returns the full metadata of the newly created URL content item.
New response : 400 Bad Request
Bad Request. The teamsiteId is malformed or the request body is invalid
New response : 401 Unauthorized
New response : 403 Forbidden
Forbidden. The caller is authenticated but does not have permission to add URL content.
New response : 404 Not Found
New response : 500 Internal Server Error
New response : 504 Gateway Timeout
Deleted response : 200 OK
OK
GET /integration/v2/teamsites/{teamsiteId}/urls/{libraryContentId}
GET /integration/v2/teamsites/{teamsiteId}/urls/{libraryContentId}Parameters:
Changed: teamsiteId in path
Teamsite identifier that scopes the request to one teamsite context. A teamsite is a tenant-scoped Library container used to partition content metadata and access control boundaries.
Changed:libraryContentIdinpath
Library URL content identifier used to retrieve current URL metadata.
Return Type:
New response : 400 Bad Request
Bad Request. The teamsiteId is malformed or the libraryContentId does not identify URL content for this endpoint
New response : 401 Unauthorized
New response : 403 Forbidden
Forbidden. The caller is authenticated but does not have permission to view this URL content.
New response : 404 Not Found
New response : 500 Internal Server Error
New response : 504 Gateway Timeout
Changed response : 200 OK
OK. Returns the latest metadata for the requested Library URL content item.
- Changed content type :
application/json- Changed property
repository(string)Always returns library for this endpoint, indicating that the URL content is stored in the library repository.
- Changed property
id(string)The unique identifier for the URL content item.
- Changed property
thumbnailId(string)The unique identifier for the thumbnail image associated with the URL content.
- Changed property
versionId(string)The unique identifier for the latest version of the URL content.
- Changed property
externalId(string)An optional external identifier for the URL content, which may be used for integration with external systems. It may be an empty string if not applicable.
- Changed property
externalConnectionId(string)An optional external connection identifier for the URL content, used for integration with external systems.
- Changed property
name(string)The name of the URL content item.
- Changed property
type(string)The content type. For URL content this is always
url. Other Seismic content may return values such asfile,folder,microapp, orlivedoc.
Added enum values:urlfilefoldermicroapplivedoc
- Changed property
format(string)The content format indicator. For URL content this value is always
URL. Included for parity with file/folder format fields and for downstream rendering hints. - Changed property
createdAt(string -> string)The timestamp when the URL content was created, in ISO 8601 format.
- Changed property
createdBy(object)Creator user reference. The nested id field behaves as createdByUserId.
- Added property
username(string)Login username of the user who created the URL, as configured in the tenant identity directory. Returned only when the service is able to resolve the user record at response time; otherwise omitted.
- Added property
email(string)Primary email address on file for the user who created the URL, used by downstream notification and collaboration features. Omitted when no email is recorded for the user.
- Added property
firstName(string)Given name of the user who created the URL, returned when populated on the user record. Omitted when the user profile has no first name set or when the service cannot resolve the user.
- Added property
lastName(string)Family name of the user who created the URL, returned when populated on the user record. Omitted when the user profile has no last name set or when the service cannot resolve the user.
- Added property
fullName(string)Service-rendered display name for the user who created the URL, typically formatted as
<firstName> <lastName>. Use this value when surfacing the creator in agent-facing UI instead of concatenating the parts manually. - Added property
photoId(string)Identifier of the avatar/profile photo asset associated with the user who created the URL. Combine with the tenant's photo CDN to render a thumbnail, or use
photoUrldirectly when available. - Added property
photoUrl(string)Fully-qualified URL pointing at the user's avatar/profile photo, used for surfacing the creator in agent-facing UI. Omitted when the user has no profile photo configured.
- Added property
isDeleted(boolean)Indicates whether the referenced user has been deleted from the tenant. When
true, agents should avoid surfacing the user as an active contact for follow-up actions on this URL. - Changed property
id(string)Unique user identifier for the creator account, equivalent to createdByUserId semantics.
- Added property
- Changed property
modifiedAt(string -> string)The timestamp when the URL content was last modified, in ISO 8601 format.
- Changed property
modifiedBy(object)Modifier user reference. The nested id field behaves as modifiedByUserId.
- Added property
username(string)Login username of the user who last modified the URL, as configured in the tenant identity directory. Returned only when the service is able to resolve the user record at response time; otherwise omitted.
- Added property
email(string)Primary email address on file for the user who last modified the URL, used by downstream notification and collaboration features. Omitted when no email is recorded for the user.
- Added property
firstName(string)Given name of the user who last modified the URL, returned when populated on the user record. Omitted when the user profile has no first name set or when the service cannot resolve the user.
- Added property
lastName(string)Family name of the user who last modified the URL, returned when populated on the user record. Omitted when the user profile has no last name set or when the service cannot resolve the user.
- Added property
fullName(string)Service-rendered display name for the user who last modified the URL, typically formatted as
<firstName> <lastName>. Use this value when surfacing the modifier in agent-facing UI instead of concatenating the parts manually. - Added property
photoId(string)Identifier of the avatar/profile photo asset associated with the user who last modified the URL. Combine with the tenant's photo CDN to render a thumbnail, or use
photoUrldirectly when available. - Added property
photoUrl(string)Fully-qualified URL pointing at the user's avatar/profile photo, used for surfacing the modifier in agent-facing UI. Omitted when the user has no profile photo configured.
- Added property
isDeleted(boolean)Indicates whether the referenced user has been deleted from the tenant. When
true, agents should avoid surfacing the user as an active contact for follow-up actions on this URL. - Changed property
id(string)Unique user identifier for the modifier account, equivalent to modifiedByUserId semantics.
- Added property
- Changed property
parentFolderId(string)The identifier of the parent folder containing the URL content, which is root if the URL content is at the top level of the library.
- Changed property
ownerId(string)The unique identifier of the user who owns the URL content.
- Changed property
description(string)Free-text description shown to Library consumers, providing context about what the linked URL contains and how it should be used. May be empty when no description has been set.
- Changed property
version(string)Human-friendly version label of the URL content (typically reflects metadata revisions, not the linked target). May be useful for tracking when the URL or its metadata was last revised.
- Changed property
expiresAt(string -> string)The expiration date of the URL content in
YYYY-MM-DDformat. May be null or absent if no expiration has been set. After this date the URL is treated as expired in consumer surfaces. - Changed property
url(object)URL target details for this URL content item, including the destination address and window behavior.
- Changed property
url(string -> string)The destination URL that this URL content item points to.
- Changed property
openInNewWindow(boolean)Whether the URL should open in a new browser window when accessed.
- Changed property
- Changed property
experts(array)An array of experts associated with the URL content. Experts can be users or groups including their IDs and types.
Changed items (object):
Expert principal reference associated with the URL content for advisory ownership metadata.- Changed property
id(string)Principal identifier for the expert entry, equivalent to expertPrincipalId semantics.
- Changed property
type(string)Expert principal type resolved from backend metadata values.
Added enum values:usergroup
- Changed property
- Changed property
properties(array)An array of custom properties associated with the URL content, including their IDs, names, and values.
Changed items (object):
Custom property entry and its assigned values for the current URL content metadata snapshot.- Changed property
id(string)Property definition identifier, equivalent to propertyId semantics in teamsite configuration.
- Changed property
name(string)Display name of the custom property for human-readable output.
- Changed property
values(array)Values assigned to this property for the current URL content record.
Changed items (string):
- Changed property
- Changed property
assignedToProfiles(array)An array of profiles to which the URL content is assigned, including their IDs, names, and types.
Changed items (object):
Profile assignment entry linking the URL content to a content profile audience.- Changed property
id(string)Profile identifier for this assignment, equivalent to profileId semantics.
- Changed property
name(string)Display name of the assigned profile.
- Changed property
type(string)Profile classification name returned by library assignment services.
- Changed property
- Changed property
PATCH /integration/v2/teamsites/{teamsiteId}/urls/{libraryContentId}
PATCH /integration/v2/teamsites/{teamsiteId}/urls/{libraryContentId}Parameters:
Added: includeResponse in query
When true, the response body contains the full updated URL metadata payload (the same shape as the GET URL endpoint). When false, the service returns an empty 200 response — useful when the caller does not need the updated metadata and wants to minimize bandwidth on bulk patch workflows. Defaults to true.
Changed:teamsiteIdinpath
Identifier of the teamsite context for the request. Depending on API behavior, it may be a GUID-formatted value or a documented special value such as1.
Changed:libraryContentIdinpath
Identifier of the library content item targeted by the operation. Must identify URL content for this endpoint.
Changed:Content-Typeinheader
Media type of the request body. Must beapplication/jsonfor this endpoint.
Request:
JSON body containing the URL metadata fields to update. Only included fields are modified; omitted fields remain unchanged.
Changed content type :application/json
- Changed property
name(string)The name of the URL content item.
- Changed property
parentFolderId(string)The identifier of the destination parent folder. Changing this value moves the URL content item to a different folder. Use
rootto place the item in the root folder of the teamsite. - Changed property
externalId(string)An optional external identifier for the URL content item, used for integration with external systems.
- Changed property
externalConnectionId(string)An optional external connection identifier for the URL content item, used for integration with external systems.
- Changed property
description(string)The description for the URL content item. Can be an empty string to clear the description.
- Changed property
expiresAt(string -> string)The date the URL content item expires, in YYYY-MM-DD format. Only future dates are accepted.
- Changed property
url(object)URL-specific metadata fields for the Library URL content item.
- Changed property
url(string -> string)The target URL that this Library URL content item points to.
- Changed property
openInNewWindow(boolean)Whether the URL opens in a new browser window or is displayed inside the Seismic application.
- Changed property
- Changed property
experts(array)A list of experts for this URL content item. Each expert identifies a user or group principal.
Changed items (object):
Expert principal reference associated with the URL content item for advisory ownership metadata.- Changed property
id(string)Principal identifier for the expert entry, equivalent to expertPrincipalId semantics. Can be a user ID or a group ID.
- Changed property
type(string)Expert principal type indicating whether the expert is an individual user or a group.
Added enum values:usergroup
- Changed property
- Changed property
properties(array)An array of custom properties and their values, where each property is identified by its id.
Changed items (object):
Custom property entry and its assigned values for the URL content metadata.- Changed property
id(string)Property definition identifier, equivalent to propertyId semantics in teamsite configuration.
- Changed property
name(string)Display name of the custom property for human-readable output.
- Changed property
values(array)Values assigned to this property for the current URL content record.
Changed items (string):
- Changed property
Return Type:
New response : 400 Bad Request
Bad Request. The teamsiteId is malformed, the libraryContentId does not identify URL content, or the request body contains invalid field values
New response : 401 Unauthorized
New response : 403 Forbidden
Forbidden. The caller is authenticated but does not have permission to modify this URL content item.
New response : 404 Not Found
New response : 500 Internal Server Error
New response : 504 Gateway Timeout
Changed response : 200 OK
OK. Returns the updated metadata for the URL content item after applying the requested changes.
Deleted header :Cache-Control
Deleted header :Pragma
Deleted header :Transfer-Encoding
Deleted header :Content-Encoding
Deleted header :Vary
Deleted header :X-Content-Type-Options
Deleted header :Strict-Transport-Security
Deleted header :api-supported-versions
Deleted header :Date
- New content type :
application/json - Deleted content type :
application/json; charset=utf-8
POST /integration/v2/teamsites/{teamsiteId}/urls/{libraryContentId}/copy
POST /integration/v2/teamsites/{teamsiteId}/urls/{libraryContentId}/copyCopy a URL
Parameters:
Changed: teamsiteId in path
Identifier of the teamsite context for the request. Depending on API behavior, it may be a GUID-formatted value or a documented special value such as
1.
Changed:libraryContentIdinpath
Identifier of the library URL content item to copy. Must reference a URL content type.
Changed:Content-Typeinheader
Media type of the request body. Must beapplication/json.
Request:
JSON object specifying the destination folder for the copied URL.
Changed content type :application/json
New required properties:
parentFolderId
- Changed property
parentFolderId(string)The identifier of the destination parent folder. Use
rootto copy to the teamsite's root folder, otherwise provide a folder GUID.
Return Type:
New response : 201 Created
Created. Returns the full metadata of the newly created URL copy.
New response : 400 Bad Request
Bad Request. The teamsiteId or libraryContentId is malformed, or the request body is invalid
New response : 401 Unauthorized
New response : 403 Forbidden
Forbidden. The caller is authenticated but does not have the seismic.library.manage scope required to copy this URL.
New response : 404 Not Found
New response : 500 Internal Server Error
New response : 504 Gateway Timeout
Deleted response : 200 OK
OK
POST /integration/v2/teamsites/{teamsiteId}/items/{libraryContentId}/instructions
POST /integration/v2/teamsites/{teamsiteId}/items/{libraryContentId}/instructionsParameters:
Changed: teamsiteId in path
Identifier of the teamsite context for the request. Depending on API behavior, it may be a GUID-formatted value or a documented special value such as
1.
Changed:libraryContentIdinpath
Identifier of the library content item targeted by the operation.
Request:
JSON object describing the instruction to create on the content item.
Changed content type :application/json
- Changed property
type(string)The type of instruction to create. Currently the only supported value is
text, indicating a free-text instruction with limited HTML formatting.
Added enum value:text
- Changed property
title(string)The title of the instruction displayed to users. Used as the heading shown to readers in the Library UI and in downstream rendering surfaces.
- Changed property
text(string)The rich-text body of the instruction. Supports a limited set of HTML tags including bold, italic, underline, strikethrough, ordered and unordered lists, hyperlinks, and heading elements.
Return Type:
New response : 201 Created
Created. The instruction was created successfully and the full instruction object is returned.
New response : 400 Bad Request
Bad Request. The teamsiteId or libraryContentId is malformed, or the request body is invalid
New response : 401 Unauthorized
New response : 403 Forbidden
Forbidden. The caller is authenticated but does not have the seismic.library.manage scope required to add instructions.
New response : 404 Not Found
New response : 500 Internal Server Error
New response : 504 Gateway Timeout
Deleted response : 200 OK
OK
GET /integration/v2/teamsites/{teamsiteId}/items/{libraryContentId}/instructions
GET /integration/v2/teamsites/{teamsiteId}/items/{libraryContentId}/instructionsParameters:
Changed: offset in query
Zero-based offset for pagination. Determines how many instruction entries to skip before returning results. Defaults to 0 when omitted.
Changed:limitinquery
Maximum number of instruction entries to return per page. Defaults to 50 when omitted. Maximum allowed value is 100.
Changed:teamsiteIdinpath
Identifier of the teamsite context for the request. Depending on API behavior, it may be a GUID-formatted value or a documented special value such as1.
Changed:libraryContentIdinpath
Identifier of the library content item targeted by the operation.
Return Type:
New response : 400 Bad Request
Bad Request. The teamsiteId or libraryContentId is malformed or invalid
New response : 401 Unauthorized
New response : 403 Forbidden
Forbidden. The caller is authenticated but does not have permission to view instructions on this item.
New response : 404 Not Found
New response : 500 Internal Server Error
New response : 504 Gateway Timeout
Changed response : 200 OK
OK. Returns the paginated list of instructions for the requested library content item.
- Changed content type :
application/json; charset=utf-8- Added property
pageCap(integer)The effective per-page entry cap enforced by the service for this listing operation. Returns
50for instructions. Use this value to size client-side page buffers when the requestedlimitexceeds the cap. - Added property
continuationToken(string)Opaque cursor that, when present, can be supplied as the
offsetof a follow-up request to retrieve the next page. Returned only for queries where the service prefers continuation-style paging over numeric offsets; otherwise omitted. - Added property
nextPageLink(string)Pre-built absolute URL pointing at the next page of results when more pages are available, including all required query parameters. Omitted on the last page.
- Changed property
totalCount(number -> integer)The total number of instructions available for the item across all pages of this query.
- Changed property
limit(number -> integer)The maximum number of instruction entries returned per page, echoing the
limitquery parameter (default 50). Note that the service enforces an effective hard cap of 50 entries per page regardless of the value requested. - Changed property
offset(number -> integer)The zero-based offset indicating how many entries were skipped before the current page, echoing the
offsetquery parameter. - Changed property
entries(array)An array of instruction entries attached to the library content item for the requested page.
Changed items (object):
A single instruction record attached to a library content item, containing its identifier, type, title, and HTML body.- Changed property
id(string -> string)The unique identifier for the instruction entry. Treat as an opaque UUID and use for delete or future update operations on this specific instruction.
- Changed property
type(string)The type of the instruction. Currently the only supported value is
text, indicating a free-text instruction with limited HTML formatting.
Added enum value:text
- Changed property
title(string)The title of the instruction entry, shown as the heading in the Library UI and rendering surfaces.
- Changed property
text(string)The HTML-formatted body of the instruction. Supports a limited set of HTML tags including bold, italic, underline, strikethrough, lists, hyperlinks, and headings.
- Changed property
- Added property
POST /integration/v2/teamsites/{teamsiteId}/publish
POST /integration/v2/teamsites/{teamsiteId}/publishParameters:
Changed: teamsiteId in path
Identifier of the teamsite context for the request. Depending on API behavior, it may be a GUID-formatted value or a documented special value such as
1.
Request:
JSON object containing the list of documents to publish, an optional scheduled publish date, an optional comment, and a notification flag.
Changed content type :application/json
- Changed property
comment(string)An optional comment to associate with the publish action, visible in content history.
- Changed property
publishAt(string)Optional scheduled publish date. Accepts either
YYYY-MM-DD HH:MM AM|PM(date with time) orYYYY-MM-DD(date only). All times are processed in UTC. Omit to publish immediately. - Changed property
IsSendNotification(boolean)Whether to send a notification to subscribers when the content is published. Defaults to true when omitted, matching the backend
PublishRequest.IsSendNotificationdefault. Set to false to publish silently without notifying subscribers. - Changed property
content(array)An array of content items to publish. Each item must include a valid library content
id. The documented maximum of 10 items per request applies to immediate (unscheduled) publishing; whenpublishAtis supplied for scheduled publishing the backend accepts up to 50 items. The array is required and must contain at least one item.
Changed items (object):
A reference to a single library content item to publish.- Changed property
id(string)The unique identifier of the library content item to publish.
- Changed property
Return Type:
New response : 400 Bad Request
Bad Request. The teamsiteId is malformed or the request body is invalid
New response : 401 Unauthorized
New response : 403 Forbidden
Forbidden. The caller is authenticated but does not have permission to publish content.
New response : 404 Not Found
New response : 500 Internal Server Error
New response : 504 Gateway Timeout
Changed response : 200 OK
OK. Returns a summary of the publish operation including counts for total requests, successes, errors, and warnings, along with detail arrays for any content items that encountered errors or warnings.
- Changed content type :
application/json- Changed property
totalRequests(number -> integer)The total number of content items submitted in the publish request.
- Changed property
totalErrors(number -> integer)The number of content items that failed to publish.
- Changed property
totalSucceeded(number -> integer)The number of content items that were successfully published or scheduled.
- Changed property
totalWarnings(number -> integer)The number of content items that published with warnings.
- Changed property
errors(array)An array of error details for content items that failed to publish. Empty when all items succeed.
Changed items (object):
Error detail for a single content item that failed to publish.- Changed property
id(string)The library content identifier of the document that failed to publish.
- Changed property
message(string)A human-readable message explaining why the document failed to publish.
- Changed property
- Changed property
warnings(array)An array of warning details for content items that published with non-fatal issues. Empty when no warnings occur.
Changed items (object):
Warning detail for a single content item that published with a non-fatal issue.- Changed property
id(string)The library content identifier of the document that published with a warning.
- Changed property
message(string)A human-readable message describing the warning encountered during publishing.
- Changed property
- Changed property
PUT /integration/v2/approvalWorkflows/{approvalWorkflowId}/steps/{stepId}
PUT /integration/v2/approvalWorkflows/{approvalWorkflowId}/steps/{stepId}Parameters:
Changed: approvalWorkflowId in path
Unique UUID identifier of the approval workflow instance that contains the target step.
Changed:stepIdinpath
Unique UUID identifier of the workflow step to approve, reject, or revoke.
Changed:Content-Typeinheader
Content type for request payload. Must beapplication/json.
Request:
Action payload describing the decision to apply to the step.
Changed content type :application/json
- Changed property
comment(string)Optional explanation provided with the step action.
- Changed property
nextApprover(object)Optional principal assignment for dynamic next-step routing.
- Changed property
id(string)Identifier of the next approver principal. For user type, may be
1or a UUID. For group type, may be1or a UUID. - Changed property
type(string)Principal type for the next approver.
Added enum values:usergroup
- Changed property
isDefault(boolean)Indicates whether the next approver comes from default workflow configuration.
- Changed property
- Changed property
action(string)The decision an authenticated approver records on a workflow step.
approveadvances the workflow to the next step (or marks it complete when this is the final step);rejecthalts the workflow and returns the content to the submitter;revokeis used to cancel a previously-recorded approval, typically because new information requires the approver to reconsider.
Return Type:
New response : 400 Bad Request
Bad Request. One or more path parameters or request body fields are invalid
New response : 401 Unauthorized
New response : 403 Forbidden
Forbidden. The caller is authenticated but is not allowed to act on this step.
New response : 404 Not Found
New response : 500 Internal Server Error
New response : 504 Gateway Timeout
Changed response : 200 OK
OK. Returns the updated workflow after the step decision is applied.
- Changed content type :
application/json- Changed property
id(string)approvalWorkflowId — Unique UUID identifier of the workflow instance. Treat as opaque; use to retrieve the workflow via the get-workflow endpoint or to record further step decisions.
- Changed property
approvalProcess(object)The approval process template that defines step routing and decision policy.
- Changed property
id(string)approvalProcessId — Unique UUID identifier of the approval process template.
- Changed property
name(string)Human-readable approval process name shown in workflow UI and reports.
- Changed property
- Changed property
submittedOn(string -> string)Timestamp when the content was submitted to the workflow, in ISO 8601 UTC format. Use this to order workflows chronologically and to compute review SLAs.
- Changed property
submittedBy(object)User details for the person who originally submitted the workflow content.
- Changed property
id(string)submittedByUserId — User identifier of the submitter. May be
1,2, or a UUID. - Changed property
username(string)Login username of the submitter.
- Changed property
email(string)Email address of the submitter.
- Changed property
firstName(string)Submitter first name.
- Changed property
lastName(string)Submitter last name.
- Changed property
fullName(string)Display full name of the submitter.
- Changed property
photoId(string)Identifier of the submitter profile photo.
- Changed property
photoUrl(string)URL used to retrieve the submitter profile photo.
- Changed property
isDeleted(boolean)Indicates whether the submitter account has been deleted.
- Changed property
- Changed property
comment(string)Latest workflow-level comment associated with submission or decision. Provides reviewer context about why the document was submitted or about a workflow-wide note.
- Changed property
libraryContent(object)Metadata describing the library content item associated with the workflow.
- Changed property
id(string)libraryContentId — Unique UUID identifier of the library item under workflow review.
- Changed property
versionId(string)libraryVersionId — Unique UUID identifier of the exact submitted version.
- Changed property
type(string)Type or format of the submitted content (for example DOCX or PPTX).
- Changed property
name(string)Display name of the submitted content item.
- Changed property
teamsiteId(string)Identifier of the teamsite that owns the submitted content.
- Changed property
- Changed property
status(string)Current overall workflow status after applying the step action. The workflow status is derived from step states — typically
pendingwhile at least one step is undecided,approvedonce all required steps approve,rejectedif any required step rejects, orrevokedafter an approver retracts a prior approval.
Added enum values:pendingapprovedrejectedrevoked
- Changed property
stateChangedOn(string -> string)Timestamp when the workflow-level status last changed, in ISO 8601 UTC format. Updated whenever any step transitions and the workflow-level status is recomputed.
- Changed property
steps(array)Ordered list of workflow steps with current assignees and decision state. The latest applied step decision is reflected in the step's
statusandstateChangedOnfields.
Changed items (object):
One step in the workflow snapshot returned after applying a decision. Includes step identifier, current decision state, assignees, approvers, watchers, and state-change attribution.- Changed property
id(string)stepId — Unique UUID identifier of the workflow step. Treat as opaque; use to call subsequent approve-or-reject operations on the same step.
- Changed property
name(string)Human-readable step name as configured in the approval-process template. Used to identify the step to reviewers and in routing diagnostics.
- Changed property
status(string)Current decision status of this step after applying the latest action. Transitions are
pending→ (approved|rejected) and may berevokedto reset a prior approval.
Added enum values:pendingapprovedrejectedrevoked
- Changed property
approveButtonLabel(string)UI label displayed for the approve action on this step. Allows the process owner to customize wording (for example, "Sign off" or "Approve and notify").
- Changed property
rejectButtonLabel(string)UI label displayed for the reject action on this step. Allows the process owner to customize wording (for example, "Send back for revision").
- Changed property
comment(string)Optional comment captured with the latest decision on this step. Provides context for downstream reviewers or audit trails about why the step was approved or rejected.
- Changed property
assignedTo(object)Principal (user or group) currently assigned to act on the step. The workflow waits for a decision until at least one assigned principal records an action.
- Changed property
id(string)Identifier of the assigned principal (semantically
userIdwhentypeisuser,groupIdwhentypeisgroup). May be1or2for built-in accounts (system / service principal) or a UUID for tenant users/groups. - Changed property
type(string)Principal type for the assignee. Pair with the
idfield to disambiguate user vs group identifiers when calling downstream user/group APIs.
Added enum values:usergroup
- Changed property
- Changed property
stateChangedOn(string -> string)Timestamp when this step status last changed, in ISO 8601 UTC format. Updated whenever the step transitions (for example, from
pendingtoapproved). - Changed property
stateChangedBy(object)User who last changed the workflow step state.
- Changed property
id(string)stateChangedByUserId — Identifier of the user who performed the latest state change. May be
1,2, or a UUID. - Changed property
username(string)Username of the state-changing user.
- Changed property
email(string)Email address of the state-changing user.
- Changed property
firstName(string)First name of the state-changing user.
- Changed property
lastName(string)Last name of the state-changing user.
- Changed property
fullName(string)Display full name of the state-changing user.
- Changed property
photoId(string)Identifier of the user profile photo.
- Changed property
photoUrl(string)URL used to retrieve the user profile photo.
- Changed property
isDeleted(boolean)Indicates whether the user account has been deleted.
- Changed property
- Changed property
approvers(array)Array of principals (users or groups) configured as eligible approvers for this step. Each entry has the principal
idandtype.
Changed items (object):
Principal (user or group) configured as an eligible approver for this step. Differs fromassignedTobecause approvers represent the configured set;assignedTois the currently-acting subset.- Changed property
id(string)Identifier of the approver principal (semantically
userIdwhentypeisuser,groupIdwhentypeisgroup). May be1or2for built-in accounts or a UUID for tenant users/groups. - Changed property
type(string)Principal type for the approver. Pair with the
idfield to disambiguate user vs group identifiers when calling downstream user/group APIs.
Added enum values:usergroup
- Changed property
isDefault(boolean)Indicates whether this approver was preconfigured as a default approver in the approval-process template. Default approvers are pre-selected when a workflow is instantiated, but the submitter may override them at submission time.
- Changed property
- Changed property
watchers(array)Array of principals (users or groups) configured to observe this step's state changes without decision rights. Watchers typically receive notifications but cannot approve or reject.
Changed items (object):
Principal (user or group) configured to observe this step's state changes without decision rights. Watchers typically receive notifications but cannot approve or reject the step.- Changed property
id(string)Identifier of the watcher principal (semantically
userIdwhentypeisuser,groupIdwhentypeisgroup). May be1or2for built-in accounts or a UUID for tenant users/groups. - Changed property
type(string)Principal type for the watcher. Pair with the
idfield to disambiguate user vs group identifiers when calling downstream user/group APIs.
Added enum values:usergroup
- Changed property
isDefault(boolean)Indicates whether this watcher was preconfigured as a default watcher in the approval-process template. Default watchers are pre-attached when a workflow is instantiated.
- Changed property
- Changed property
- Changed property
GET /integration/v2/approvalWorkflows
GET /integration/v2/approvalWorkflowsParameters:
Added: limit in query
Maximum number of entries to return per page. Must be a positive integer. Defaults to 100 if not specified. Maximum allowed value is 1000.
Added:offsetinquery
Zero-based index of the first entry to return. Use with limit for offset-based pagination. Defaults to 0 when not specified.
Added:continuationTokeninquery
Opaque cursor token returned by a previous response for cursor-based pagination. When provided, takes precedence over the offset parameter.
Return Type:
New response : 400 Bad Request
Bad Request. One or more query parameter values are invalid (for example a non-integer limit or a malformed continuationToken)
New response : 401 Unauthorized
New response : 403 Forbidden
Forbidden. The caller is authenticated but does not have the seismic.library.manage scope required for this endpoint.
New response : 500 Internal Server Error
New response : 504 Gateway Timeout
Changed response : 200 OK
OK
- Changed content type :
application/json- Changed property
totalCount(number -> integer)Total number of approval workflow records matching the query across all pages.
- Changed property
limit(number -> integer)Maximum number of entries returned in this response page.
- Changed property
offset(number -> integer)Zero-based index of the first entry in this response page.
- Changed property
continuationToken(string)Opaque token used to fetch the next page of results; absent when no more pages exist.
- Changed property
nextPageLink(string)Full URL to retrieve the next page of results using the current limit and the next offset.
- Changed property
entries(array)Array of approval workflow records returned for the current page.
Changed items (object):
A single approval workflow instance record, representing one document submitted through a specific approval process, along with its current state and ordered review steps.- Changed property
id(string)approvalWorkflowId — Unique UUID identifier of this approval workflow instance. Use this value to call GET /integration/v2/approvalWorkflows/{approvalWorkflowId} for full details.
- Changed property
approvalProcess(object)The approval process template that defines the workflow steps and approvers for a document review.
- Changed property
id(string)approvalProcessId — Unique UUID identifier of the approval process template that defines the steps and routing rules for this workflow.
- Changed property
name(string)Human-readable name of the approval process template.
- Changed property
- Changed property
submittedOn(string -> string)ISO 8601 timestamp when the document was submitted into this workflow.
- Changed property
submittedBy(object)The user who submitted the document into this approval workflow.
- Added property
username(string)Login username of the user who submitted the document into the workflow, as configured in the tenant identity directory. Returned only when the service is able to resolve the user record at response time; otherwise omitted.
- Added property
email(string)Primary email address on file for the submitting user, used for workflow notifications and follow-up routing. Omitted when no email is recorded for the user.
- Added property
firstName(string)Given name of the submitting user, returned when populated on the user record. Omitted when the user profile has no first name set or when the service cannot resolve the user.
- Added property
lastName(string)Family name of the submitting user, returned when populated on the user record. Omitted when the user profile has no last name set or when the service cannot resolve the user.
- Added property
fullName(string)Service-rendered display name for the submitting user, typically formatted as
<firstName> <lastName>. Use this value when surfacing the submitter in workflow review UIs instead of concatenating the parts manually. - Added property
photoId(string)Identifier of the avatar/profile photo asset associated with the submitting user. Combine with the tenant's photo CDN to render a thumbnail, or use
photoUrldirectly when available. - Added property
photoUrl(string)Fully-qualified URL pointing at the submitter's avatar/profile photo, used for surfacing the user in workflow review UIs. Omitted when the user has no profile photo configured.
- Changed property
id(string)Identifier of the user who submitted the document. May be
1(system user) or a UUID. - Changed property
isDeleted(boolean)Indicates whether the submitting user account has been deleted.
- Added property
- Changed property
comment(string)Optional comment provided by the submitter when initiating the workflow.
- Changed property
libraryContent(object)Metadata identifying the library content item (document or file) that is being reviewed in this approval workflow.
- Changed property
id(string)libraryContentId — Unique UUID identifier of the library content item under review. Use this to call GET /integration/v2/teamsites/{teamsiteId}/files/{libraryContentId} for full file metadata.
- Changed property
versionId(string)libraryVersionId — Unique UUID identifier of the specific library content version submitted for review. A new versionId is assigned each time a file is updated.
- Changed property
type(string)File format type of the content being reviewed (for example DOCX or PPTX).
- Changed property
name(string)Display name of the library content item.
- Changed property
teamsiteId(string)Identifier of the teamsite that contains the library content item.
- Changed property
- Changed property
status(string)Current overall status of the workflow (for example Pending, Approved, or Rejected).
Added enum values:PendingApprovedRejected
- Changed property
steps(array)Ordered list of approval steps in this workflow instance, each with its own status and assigned reviewers.
Changed items (object):
An individual step within an approval workflow instance, including its current status, action labels, and assigned reviewers.- Changed property
id(string)stepId — Unique UUID identifier of this individual workflow step within the approval workflow instance.
- Changed property
name(string)Display name of this step (for example Step 1).
- Changed property
status(string)Current status of this individual step (for example Pending, Approved, or Rejected).
Added enum values:PendingApprovedRejected
- Changed property
approveButtonLabel(string)Label displayed on the approve action button for this step.
- Changed property
rejectButtonLabel(string)Label displayed on the reject action button for this step.
- Changed property
assignedTo(object)The user or group principal currently assigned to review and act on a workflow step.
- Changed property
id(string)Identifier of the user or group. For User type, may be
1(system user) or a UUID. For Group type, may be1or a UUID. - Changed property
type(string)Principal type, either User or Group.
Added enum values:UserGroup
- Changed property
- Changed property
approvers(array)List of users or groups who are configured as approvers for this step.
Changed items (object):
A user or group principal configured as an approver for a workflow step, indicating their origin and default status.- Changed property
id(string)Identifier of the user or group. For User type, may be
1(system user) or a UUID. For Group type, may be1or a UUID. - Changed property
type(string)Principal type, either User or Group.
Added enum values:UserGroup
- Changed property
isDefault(boolean)Indicates whether this approver was added by default from the process template configuration.
- Changed property
- Changed property
watchers(array)List of users or groups who are watching this step without approval authority.
Changed items (object):
A user or group principal watching a workflow step for visibility without having approval authority.- Changed property
id(string)Identifier of the user or group. For User type, may be
1(system user) or a UUID. For Group type, may be1or a UUID. - Changed property
type(string)Principal type, either User or Group.
Added enum values:UserGroup
- Changed property
isDefault(boolean)Indicates whether this watcher was added by default from the process template configuration.
- Changed property
- Changed property
- Changed property
- Changed property
GET /integration/v2/approvalWorkflows/{approvalWorkflowId}
GET /integration/v2/approvalWorkflows/{approvalWorkflowId}Parameters:
Changed: approvalWorkflowId in path
Unique UUID identifier of the approval workflow instance. Use a value previously returned as workflow
idfrom list workflow APIs.
Return Type:
New response : 400 Bad Request
Bad Request
New response : 401 Unauthorized
New response : 403 Forbidden
Forbidden
New response : 404 Not Found
New response : 500 Internal Server Error
New response : 504 Gateway Timeout
Changed response : 200 OK
OK
- Changed content type :
application/json- Changed property
id(string)approvalWorkflowId — Unique UUID identifier of the approval workflow instance.
- Changed property
approvalProcess(object)The approval process template associated with this workflow.
- Changed property
id(string)approvalProcessId — Unique UUID identifier of the approval process template.
- Changed property
name(string)Human-readable name of the approval process template, shown in workflow UI and reports. Used by agents to identify which approval policy governs the workflow without resolving the underlying
id.
- Changed property
- Changed property
submittedOn(string -> string)Timestamp when the workflow was submitted, in ISO 8601 UTC format. Use this to order workflows chronologically and to compute review SLAs.
- Changed property
submittedBy(object)The user principal who submitted the content into this workflow.
- Added property
isDeleted(boolean)Indicates whether the submitting user account has since been deleted from the tenant. When true, the submitter is no longer an active user and
idcannot be resolved to a current account. - Added property
username(string)Login username of the user who submitted the document into the workflow, as configured in the tenant identity directory. Returned only when the service is able to resolve the user record at response time; otherwise omitted.
- Added property
email(string)Primary email address on file for the submitting user, used for workflow notifications and follow-up routing. Omitted when no email is recorded for the user.
- Added property
firstName(string)Given name of the submitting user, returned when populated on the user record. Omitted when the user profile has no first name set or when the service cannot resolve the user.
- Added property
lastName(string)Family name of the submitting user, returned when populated on the user record. Omitted when the user profile has no last name set or when the service cannot resolve the user.
- Added property
fullName(string)Service-rendered display name for the submitting user, typically formatted as
<firstName> <lastName>. Use this value when surfacing the submitter in workflow review UIs instead of concatenating the parts manually. - Added property
photoId(string)Identifier of the avatar/profile photo asset associated with the submitting user. Combine with the tenant's photo CDN to render a thumbnail, or use
photoUrldirectly when available. - Added property
photoUrl(string)Fully-qualified URL pointing at the submitter's avatar/profile photo, used for surfacing the user in workflow review UIs. Omitted when the user has no profile photo configured.
- Changed property
id(string)Identifier of the submitting user. May be
1or2for built-in accounts (system / service principal) or a UUID for tenant users. Treat as opaque and use asuserIdsemantics when calling downstream user APIs.
- Added property
- Changed property
comment(string)Optional submitter comment attached to the workflow request. Provides context for reviewers about why the document was submitted and any caveats that affect the decision.
- Changed property
content(object)Metadata about the library content item under approval.
- Changed property
id(string)libraryContentId — Unique UUID identifier of the library content item under review.
- Changed property
versionId(string)libraryVersionId — Unique UUID identifier of the submitted version.
- Changed property
type(string)Content format (file extension) of the library item under review. Common values include
docx,pptx,pdf,xlsx, and image formats. The value follows the file's underlying format rather than the Library content category. - Changed property
name(string)Display name of the content item as shown in Library navigation, search results, and the workflow review surface.
- Changed property
teamsiteId(string)Identifier of the teamsite that owns the content. May be
1(default teamsite) or a UUID.
- Changed property
- Changed property
stateChangedOn(string -> string)Timestamp when the workflow-level status last changed, in ISO 8601 UTC format. Updated whenever any step transitions and the workflow-level status is recomputed.
- Changed property
status(string)Current approval state for the workflow or an individual step.
- Changed property
steps(array)Ordered list of approval steps with assignees and decision state.
Changed items (object):
One approval step within the workflow, including its decision state, assigned principals, and audit attribution.- Changed property
id(string)stepId — Unique UUID identifier of this workflow step. Treat as opaque; use to call the approve-or-reject endpoint to record a decision.
- Changed property
name(string)Human-readable step name as configured in the approval process template. Used to identify the step to reviewers and in routing diagnostics.
- Changed property
approveButtonLabel(string)UI label displayed for the approve action on this step. Allows the process owner to customize the wording of the approve control (for example, "Sign off" or "Approve and notify").
- Changed property
rejectButtonLabel(string)UI label displayed for the reject action on this step. Allows the process owner to customize the wording of the reject control (for example, "Send back for revision").
- Changed property
comment(string)Optional step-level comment left during decisioning by the approver. Provides context for downstream reviewers about why the step was approved or rejected.
- Changed property
stateChangedOn(string -> string)Timestamp when this step status last changed.
- Changed property
stateChangedBy(object)User principal that last changed workflow or step status, with display attributes for audit and notification surfaces.
- Added property
username(string)Username (login handle) of the state-changing user, suitable for display in audit logs.
- Added property
email(string)Email address of the state-changing user. May be empty when the user is a system principal without an email.
- Added property
firstName(string)First (given) name of the state-changing user as recorded in their tenant profile.
- Added property
lastName(string)Last (family) name of the state-changing user as recorded in their tenant profile.
- Added property
fullName(string)Display full name of the state-changing user, typically composed from first and last name and used in notification surfaces.
- Added property
photoId(string)Identifier of the user's profile photo asset. Combine with the photo service base URL to retrieve the image, or use
photoUrldirectly. - Added property
photoUrl(string)URL pointing to the user's profile photo asset. May be empty when the user has not uploaded a profile photo.
- Added property
isDeleted(boolean)Indicates whether the user account has since been deleted from the tenant. When true,
username/emailmay still appear but the account is no longer active. - Changed property
id(string)userId — Identifier of the user who changed the state. May be
1or2for built-in accounts (system / service principal) or a UUID for tenant users.
- Added property
- Changed property
approvers(array)Eligible approvers configured for this step.
Changed items (object):
Principal (user or group) eligible to approve or reject this step. Differs fromassignedTobecause approvers represent the configured set, whileassignedTois the currently-acting subset.- Changed property
id(string)Identifier of the approver principal. For user type, may be
1or2for built-in accounts or a tenant-user UUID. For group type, may be1for the built-in default group or a tenant-group UUID. - Changed property
isDefault(boolean)Indicates whether this approver was configured as a default approver in the approval process template. Default approvers are pre-selected when a workflow is instantiated, but the submitter may override them.
- Changed property
- Changed property
watchers(array)Principals configured to observe this step without approving.
Changed items (object):
Principal (user or group) configured to observe this step's state changes without decision rights. Watchers typically receive notifications but cannot approve or reject.- Changed property
id(string)Identifier of the watcher principal. For user type, may be
1or2for built-in accounts or a tenant-user UUID. For group type, may be1for the built-in default group or a tenant-group UUID.
- Changed property
- Changed property
assignedTo(array)Principals currently assigned to act on this step.
Changed items (object):
Principal (user or group) currently assigned to act on this step. The step waits for a decision until at least one assignee acts.- Changed property
id(string)Identifier of the assigned principal. For user type, may be
1or2for built-in accounts or a tenant-user UUID. For group type, may be1for the built-in default group or a tenant-group UUID. - Changed property
type(string)Principal type used in workflow assignee, approver, and watcher fields.
- Changed property
- Changed property
- Changed property
Result
API changes broke backward compatibility
Search
Search (v v1)
What's Changed
POST /v1/generative/source
POST /v1/generative/sourceRequest:
Changed content type : application/json
- Changed property
filter(object)Use to filter the content. It uses the json format, like {"operator":"and", "conditions":[{"attribute":"custom.propert_a", "operator":"in", "value":["test"]}]}
- Changed property
operator(string)Logical operator joining the conditions. Use "and" to require all conditions, "or" to match any.
- Changed property
conditions(array)One array contain multi conditions
Changed items (object):- Changed property
attribute(string)The property name to filter by. Use the following predefined content properties: contentVersionId, contentId, id, engagementMeetingId, format, contentProfiles, profileVersionId, or folderPath. For date-based filtering, use: createdDate, expireDate, modifiedDate, publishDate, versionActivatedTime, or versionCreatedDate. For custom properties, use the format 'custom.{propertyName}' where {propertyName} is the exact custom property name.
- Changed property
operator(string)The value should be 'in', 'notin', 'or', 'and'. For date type or integer custom property, its value should be 'greaterthan', 'greaterthanorequal', 'lessthan', or 'lessthanorequal'.
- Changed property
- Changed property
Return Type:
Changed response : 403 Forbidden
No Aura Feature enabled
Changed response : 200 OK
Success
- Changed content type :
application/json- Changed property
documents(array)Source documents related to the search
Changed items (object):- Changed property
createdDate(string)Date when the content was created (RFC 3339 format, e.g. 2024-01-15T08:00:00Z).
- Changed property
publishDate(string)Date when the content was published (RFC 3339 format).
- Changed property
modifiedDate(string)Date when the content was last modified (RFC 3339 format).
- Changed property
- Changed property
POST /v1/generative/query
POST /v1/generative/queryRequest:
Changed content type : application/json
- Changed property
filter(object)Use to filter the content. It uses the json format, like {"operator":"and", "conditions":[{"attribute":"custom.propert_a", "operator":"in", "value":["test"]}]}
- Changed property
operator(string)Logical operator joining the conditions. Use "and" to require all conditions, "or" to match any.
- Changed property
conditions(array)One array contain multi conditions
Changed items (object):- Changed property
attribute(string)The property name to filter by. Use the following predefined content properties: contentVersionId, contentId, id, engagementMeetingId, format, contentProfiles, profileVersionId, or folderPath. For date-based filtering, use: createdDate, expireDate, modifiedDate, publishDate, versionActivatedTime, or versionCreatedDate. For custom properties, use the format 'custom.{propertyName}' where {propertyName} is the exact custom property name.
- Changed property
operator(string)The value should be 'in', 'notin', 'or', 'and'. For date type or integer custom property, its value should be 'greaterthan', 'greaterthanorequal', 'lessthan', or 'lessthanorequal'.
- Changed property
- Changed property
Return Type:
New response : 400 Bad Request
Invalid request — page size out of range or malformed payload.
Changed response : 403 Forbidden
No Aura Feature enabled
- Changed content type :
application/json
Changed response : 200 OKSuccess
- Changed content type :
application/json- Changed property
documents(array)Source files related to the search
Changed items (object):- Changed property
createdDate(string)Date when the content was created (RFC 3339 format, e.g. 2024-01-15T08:00:00Z).
- Changed property
publishDate(string)Date when the content was published (RFC 3339 format).
- Changed property
modifiedDate(string)Date when the content was last modified (RFC 3339 format).
- Changed property
- Changed property
POST /v1/content/query
POST /v1/content/queryParameters:
Changed: continuationToken in query
Opaque pagination token returned in a previous response. Pass this value to retrieve the next page of results. Omit on the first request. When provided, the request body is not required.
Request:
Changed content type : application/json
- Changed property
term(string)Search term to match against content. Supports full-text search. Omit or leave empty to return all accessible content.
- Changed property
sort(array)Optional list of sort criteria. Results are sorted by relevance when omitted.
Changed items (object):- Changed property
field(string)Field to sort by. Supported values: "name", "createdDate", "publishDate", "modifiedDate", "majorVersion", "minorVersion".
- Changed property
order(string)Sort direction. Use "asc" for ascending or "desc" for descending.
- Changed property
- Changed property
options(object)Optional search configuration controlling which fields to search, which fields to return, page size, and suggested query behaviour.
- Changed property
searchFields(array)Fields to search within. Supported values: "name", "description", "body", "properties". Defaults to all fields when omitted.
- Changed property
returnFields(array)Fields to include in each result document. When omitted, returns all default fields (repository, name, teamsiteId, id, versionId, type, applicationUrls, format).
- Changed property
pageSize(number)Maximum number of results per page, between 0 and 100. Defaults to 40.
- Changed property
- Changed property
filter(object)Optional filter expression to narrow results by repository, format, date range, custom properties, and more.
- Changed property
operator(string)Logical operator joining the conditions and nested filters. Use "and" to require all conditions, "or" to match any condition.
- Changed property
filters(array)List of nested filter groups for complex boolean logic (max depth 2).
- Changed property
conditions(array)List of individual field conditions combined by the operator.
Changed items (object):- Changed property
attribute(string)Name of the content field to filter on (e.g. "repository", "format", "versionId"). For custom properties use the prefix "custom." followed by the property name (e.g. "custom.Region").
- Changed property
operator(string)Comparison operator to apply. Use "equal" for exact match, "in" to match any value in a list, and "greaterThan" / "greaterThanOrEqual" / "lessThan" / "lessThanOrEqual" for date or integer fields.
- Changed property
value(array)One or more values to match against the attribute. Provide a single-element array for "equal"; multiple elements for "in".
- Changed property
- Changed property
Return Type:
New response : 400 Bad Request
Bad request — invalid query, filter field, page size, operator, or date format.
New response : 401 Unauthorized
Unauthorized — auth token is expired, invalid, or not provided.
New response : 403 Forbidden
Forbidden — caller does not have access to the search API.
New response : 500 Internal Server Error
Internal server error.
Changed response : 200 OK
OK
- Changed content type :
application/json; charset=utf-8- Changed property
documents(array)
Changed items (object):- Changed property
repository(string)Repository containing the content. Supported values are "DocCenter" (published content), "NewsCenter" (articles), or "Knowledge" (knowledge base articles).
- Changed property
name(string)Display name of the content item.
- Changed property
teamsiteId(string)Unique identifier of the teamsite (library) that owns this content.
- Changed property
id(string)Unique identifier of the content item within Seismic.
- Changed property
versionId(string)Unique identifier of the specific content version returned.
- Changed property
type(string)Content item type, e.g. "file", "url", or "folder".
- Changed property
format(string)File format of the content, e.g. "PDF", "PPTX", "GSLIDES", "MP4".
- Changed property
thumbnailUrl(string)Pre-signed URL for the content thumbnail image. Token expires in 24 hours; re-fetch if the URL is stale.
- Changed property
pageThumbnailUrls(array)Array of pre-signed URLs for page-level thumbnail images, one per page. Token expires in 24 hours. Only returned when requested via returnFields.
- Changed property
createdDate(string)Date when the content was created (RFC 3339 format, e.g. 2024-01-15T08:00:00Z).
- Changed property
publishDate(string)Date when the content was published (RFC 3339 format).
- Changed property
modifiedDate(string)Date when the content was last modified (RFC 3339 format).
- Changed property
majorVersion(number)Major version number of the content. Incremented on significant published updates.
- Changed property
minorVersion(number)Minor version number of the content. Incremented on minor revisions.
- Changed property
applicationUrls(array)Public links for accessing the content across Seismic applications (DocCenter, Content Manager, NewsCenter, Workspace).
- Changed property
properties(array)Custom metadata properties associated with the content item.
- Changed property
- Changed property
Result
API changes are backward compatible
Teamsites
Teamsites (v v2)
What's Changed
GET /integration/v2/teamsites/{teamsiteId}
GET /integration/v2/teamsites/{teamsiteId}Parameters:
Changed: teamsiteId in path
Teamsite identifier to retrieve. Use
1for the tenant default teamsite or a UUID for a custom teamsite.
Return Type:
New response : 400 Bad Request
Bad Request. The supplied
teamsiteIdformat is invalid.
New response : 401 Unauthorized
Unauthorized. The request is missing a bearer token or the token is invalid.
New response : 403 Forbidden
Forbidden. The caller is authenticated but lacks permission to view teamsite details.
New response : 404 Not Found
Not Found. No teamsite exists for the suppliedteamsiteId.
New response : 500 Internal Server Error
Internal Server Error. An unexpected server-side error occurred.
Changed response : 200 OK
OK. Returns metadata for the requested teamsite.
- Changed content type :
application/json
New required properties:idisDefaultnameteamsiteId
- Added property
teamsiteId(string)Canonical teamsite identifier used by teamsite-scoped endpoints. May be
1for the default teamsite or a UUID for custom teamsites. - Changed property
id(string)Legacy teamsite identifier field kept for backward compatibility. Semantically equivalent to
teamsiteId. Value may be1for the default teamsite or a UUID for non-default teamsites. - Changed property
name(string)Human-readable display name of the teamsite as configured by tenant administrators and shown in the Seismic UI, administrative tools, and downstream content surfaces. Use this value when rendering teamsite labels to end users; do not parse it for identifier purposes.
- Changed property
isDefault(boolean)Indicates whether this teamsite is the tenant default teamsite, which is always addressable by the special teamsite identifier
1. Use this flag to short-circuit teamsite resolution when the calling integration only operates against the default teamsite.
GET /integration/v2/teamsites
GET /integration/v2/teamsitesReturn Type:
New response : 400 Bad Request
Bad Request. The request is malformed or contains unsupported query options.
New response : 401 Unauthorized
Unauthorized. The request is missing a bearer token or the token is invalid.
New response : 403 Forbidden
Forbidden. The caller is authenticated but does not have permission to list teamsites.
New response : 500 Internal Server Error
Internal Server Error. An unexpected server-side error occurred.
Changed response : 200 OK
OK. Returns the list of all teamsites in the tenant.
- Changed content type :
application/json
Changed items (object):
> Teamsite summary entry returned when listing all tenant teamsites, including identifier, display name, and default teamsite indicator.
New required properties:idisDefaultnameteamsiteId
- Added property
teamsiteId(string)Canonical teamsite identifier used by teamsite-scoped endpoints. May be
1for the default teamsite or a UUID for custom teamsites. - Changed property
id(string)Legacy teamsite identifier field kept for backward compatibility. Semantically equivalent to
teamsiteId. Value may be1for the default teamsite or a UUID for non-default teamsites. - Changed property
name(string)Human-readable display name of the teamsite as configured by tenant administrators and shown in the Seismic UI, administrative tools, and downstream content surfaces. Use this value when rendering teamsite labels to end users; do not parse it for identifier purposes.
- Changed property
isDefault(boolean)Indicates whether this entry represents the tenant default teamsite, which is always addressable by the special teamsite identifier
1. Use this flag to highlight the default teamsite in selection UIs or to short-circuit teamsite resolution for tenants that only use the default teamsite.
Result
API changes broke backward compatibility
Summary: Updated APIs for LiveSend (Legacy). Updated APIs for LiveSend. Updated APIs for Meeting. Updated APIs for Search.
LiveSend (Legacy)
LiveSend (Legacy) (v v2)
What's Changed
GET /integration/v2/liveSend/settings
GET /integration/v2/liveSend/settingsReturn Type:
Changed response : 200 OK
OK
- Changed content type :
application/json- Changed property
defaultExpirationDays(number)Default number of days until a LiveSend link expires when the sender does not explicitly set an expiration date; use this value to pre-populate expiration fields in your UI.
- Changed property
maxExpirationDays(number)Maximum number of days a sender is permitted to set for a LiveSend link's expiration, enforcing the tenant administrator's upper limit policy; reject values exceeding this.
- Changed property
allowDownload(boolean)Tenant-level flag indicating whether recipients may download content from LiveSend links; when false, content is view-only and download controls should be hidden in your UI.
- Changed property
singleView(boolean)Indicates whether LiveSend links in this tenant can only be opened once; when true, subsequent access attempts after the first view are denied by the platform.
- Changed property
passwordSettings(object)Tenant-level password complexity requirements applied when password protection is enabled on a LiveSend link; this object may be absent if no password policy has been configured.
- Changed property
requiresLowerCase(boolean)When true, the LiveSend link password must contain at least one lowercase letter; assumed false if this field is absent from the response.
- Changed property
requiresNumber(boolean)When true, the LiveSend link password must contain at least one numeric digit; assumed false if this field is absent from the response.
- Changed property
requiresSymbols(boolean)When true, the LiveSend link password must contain at least one special symbol character; assumed false if this field is absent from the response.
- Changed property
requiresUpperCase(boolean)When true, the LiveSend link password must contain at least one uppercase letter; assumed false if this field is absent from the response.
- Changed property
minimumLength(number)Minimum number of characters required for the LiveSend link password when password protection is enabled; validate user input against this value before creating a link.
- Changed property
isRequired(boolean)When true, all LiveSend links in the tenant must have password protection enabled; when false, all other password complexity settings in this object are ignored.
- Changed property
- Changed property
POST /integration/v2/liveSend/links
POST /integration/v2/liveSend/linksRequest:
Settings and content items for the new LiveSend link.
Changed content type :application/json
- Changed property
tags(array)Optional single-element array; the value is used as the recipient name in the delivery system. Maximum 1 tag — requests with more than 1 tag will be rejected.
- Changed property
settings(object)Configuration options for the LiveSend link including expiration date, download permissions, and notification preferences.
- Added property
singleView(boolean)When true, the link can only be viewed once; subsequent access attempts will be blocked. Defaults to false for unlimited views.
- Changed property
expiresAt(string)The date on which the LiveSend link expires, in YYYY-MM-DD format (e.g. 2026-12-31). After this date the link will no longer be accessible to recipients.
- Changed property
password(string)Optional password required for recipients to access the LiveSend link. Leave empty for public access subject to tenant password policy.
- Changed property
allowDownload(boolean)When true, recipients can download the shared content files. When false, content is view-only with no download option.
- Changed property
notificationType(string)Controls when the link creator receives email notifications about recipient activity. Accepted values are All (every view), Session (per session), None (disabled). Case-insensitive.
- Added property
- Changed property
content(array)List of one or more Seismic content items to include in the LiveSend link. Each item must reference valid content in the specified repository.
Changed items (object):- Changed property
repository(string)The Seismic content repository where the shared content is stored. Accepted values are doccenter, newscenter, workspace, library. Input is case-insensitive; response returns PascalCase e.g. DocCenter.
- Changed property
name(string)Display name of the content item as it will appear to the recipient viewing the LiveSend link.
- Changed property
type(string)The content type of the shared item. Accepted values are file for standard documents and media, url for external URL content.
- Changed property
teamsiteId(string)UUID of the Seismic TeamSite, required for library repository content items.
- Changed property
id(string)UUID of the content item, used for workspace and library repository types instead of libraryContent.
- Changed property
versionId(string)UUID identifying the version of the content item for workspace and library repository types.
- Changed property
libraryContent(object)Content identifiers for doccenter and newscenter repository items; mutually exclusive with the top-level id and versionId fields.
- Changed property
id(string)UUID of the Seismic library content item to be shared via this LiveSend link.
- Changed property
versionId(string)UUID of the specific version of the library content item; use to pin the link to a particular published version.
- Changed property
teamsiteId(string)UUID of the Seismic TeamSite (workspace) where the library content is hosted.
- Changed property
- Changed property
contentProfileId(string)UUID of the content profile applied to this item, required for DocCenter and NewsCenter repository items for personalized document assembly.
- Changed property
contentProfilePath(array)Ordered list of folder names representing the content profile path for assembled document generation.
- Changed property
Return Type:
New response : 400 Bad Request
Bad Request
New response : 401 Unauthorized
Unauthorized - missing or invalid bearer token
New response : 403 Forbidden
Forbidden - token does not have seismic.delivery scope
Changed response : 200 OK
OK
- Changed content type :
application/json- Changed property
id(string)UUID of the newly created LiveSend link, used for tracking and management.
- Changed property
url(string)The shareable URL to send to recipients, redirecting them to the LiveSend content viewer.
- Changed property
tags(array)Echo of the tags array submitted in the request; tags[0] is used as the recipient name in the delivery system.
- Changed property
settings(object)The applied link settings including expiration, download permissions, and notification preferences.
- Added property
singleView(boolean)When true, the link can only be viewed once; subsequent access attempts will be blocked. Defaults to false for unlimited views.
- Changed property
expiresAt(string)The date on which the LiveSend link expires, in YYYY-MM-DD format (e.g. 2026-12-31). After this date the link will no longer be accessible to recipients.
- Changed property
password(string)Optional password required for recipients to access the LiveSend link. Leave empty for public access subject to tenant password policy.
- Changed property
allowDownload(boolean)When true, recipients can download the shared content files. When false, content is view-only with no download option.
- Changed property
notificationType(string)Controls when the link creator receives email notifications about recipient activity. Accepted values are All (every view), Session (per session), None (disabled). Case-insensitive.
- Added property
- Changed property
content(array)The list of content items included in this LiveSend link as returned by the API after creation.
Changed items (object):- Changed property
repository(string)The Seismic content repository where the shared content is stored. Accepted values are doccenter, newscenter, workspace, library. Input is case-insensitive; response returns PascalCase e.g. DocCenter.
- Changed property
name(string)Display name of the content item as it will appear to the recipient viewing the LiveSend link.
- Changed property
type(string)The content type of the shared item. Accepted values are file for standard documents and media, url for external URL content.
- Changed property
teamsiteId(string)UUID of the Seismic TeamSite, required for library repository content items.
- Changed property
id(string)UUID of the content item, used for workspace and library repository types instead of libraryContent.
- Changed property
versionId(string)UUID identifying the version of the content item for workspace and library repository types.
- Changed property
libraryContent(object)Content identifiers for doccenter and newscenter repository items; mutually exclusive with the top-level id and versionId fields.
- Changed property
id(string)UUID of the Seismic library content item to be shared via this LiveSend link.
- Changed property
versionId(string)UUID of the specific version of the library content item; use to pin the link to a particular published version.
- Changed property
teamsiteId(string)UUID of the Seismic TeamSite (workspace) where the library content is hosted.
- Changed property
- Changed property
contentProfileId(string)UUID of the content profile applied to this item, required for DocCenter and NewsCenter repository items for personalized document assembly.
- Changed property
contentProfilePath(array)Ordered list of folder names representing the content profile path for assembled document generation.
- Changed property
- Changed property
Result
API changes are backward compatible
LiveSend
LiveSend (v v1)
What's New
GET /v1/livesends/{livesendId}/versions/{livesendVersionId}
GET /v1/livesends/{livesendId}/versions/{livesendVersionId}Get LiveSend version
Result
API changes are backward compatible
Meeting
Meeting (v v1)
What's Changed
POST /v1/meetings/manuallyIngest
POST /v1/meetings/manuallyIngestRequest:
Changed content type : multipart/form-data
- Added property
summary(string)Optional plain-text meeting summary. Provide as a multipart form-data text field named
Summary. May be supplied in place of a recording or transcript file. - Changed property
metadata(string)Meeting metadata as a JSON string. Must include Title, Provider, MeetingStartDateTime, MeetingEndDateTime, and Participants. See the description above for the full field reference and sample.
- Changed property
recordingFile(string)Meeting recording file. Supported extensions:
.mp4,.mp3. Maximum file size is 2 GB. - Changed property
transcriptFile(string)Meeting transcript file. For all providers except Manual Upload, must be
.jsonand conform to the documented transcript entry schema. For the Manual Upload provider,.json,.vtt,.xml, and.txtare accepted.
Result
API changes are backward compatible
Search
Search (v v1)
What's Changed
POST /v1/generative/source
POST /v1/generative/sourceRequest:
Changed content type : application/json
- Added property
isShareable(boolean)Optional filter flag. When set to true, only externally shareable content is returned. When set to false, only non-shareable content is returned. If not provided, all content is returned regardless of shareable status and the response documents will not include the isShareable field.
Return Type:
Changed response : 200 OK
Success
- Changed content type :
application/json- Changed property
documents(array)Source documents related to the search
Changed items (object):- Added property
isShareable(boolean)Indicates whether the content is externally shareable. This field is only present in the response when the isShareable filter is provided in the request.
- Added property
- Changed property
POST /v1/generative/query
POST /v1/generative/queryRequest:
Changed content type : application/json
- Added property
isShareable(boolean)Optional filter flag. When set to true, only externally shareable content is returned. When set to false, only non-shareable content is returned. If not provided, all content is returned regardless of shareable status and the response documents will not include the isShareable field.
Return Type:
Changed response : 200 OK
Success
- Changed content type :
application/json- Changed property
documents(array)Source files related to the search
Changed items (object):- Added property
isShareable(boolean)Indicates whether the content is externally shareable. This field is only present in the response when the isShareable filter is provided in the request.
- Added property
- Changed property
POST /v1/content/query
POST /v1/content/queryResult
API changes are backward compatible
Summary: Updated APIs for Digital Sales Room. Updated APIs for Integration. Updated APIs for Link Delivery. Updated APIs for LiveSend. Updated APIs for Workspace.
Digital Sales Room
Digital Sales Room (v v1)
What's Changed
GET /v1/dsrs/{id}
GET /v1/dsrs/{id}Return Type:
Changed response : 200 OK
Returns the full DSR object including name, shareable link URL, content items, co-branding, layout widgets, sharing settings, and creator identity.
- Changed content type :
application/json
GET /v1/dsrs
GET /v1/dsrsReturn Type:
Changed response : 200 OK
OK
- Changed content type :
application/json
POST /v1/dsrs
POST /v1/dsrsRequest:
Changed content type : application/json
Result
API changes are backward compatible
Integration
Integration (v v2)
What's Changed
POST /integration/v2/workspace/urls
POST /integration/v2/workspace/urlsRequest:
Changed content type : application/json
- Added property
description(string) - Added property
thumbnail(string) - Added property
urlMode(object)
Enum values:DialogNewPage
Result
API changes are backward compatible
Link Delivery
Link Delivery (v 1.0)
Result
No differences. Specifications are equivalent
LiveSend
LiveSend (v v1)
Result
No differences. Specifications are equivalent
Workspace
Workspace (v v1)
Result
No differences. Specifications are equivalent
Summary: Updated APIs for Document Generator. Updated APIs for Integration.
Document Generator
Document Generator (v v1)
What's New
GET /v1/generatedLivedocs/{generatedLivedocId}/trackedFields
GET /v1/generatedLivedocs/{generatedLivedocId}/trackedFieldsGet the tracked fields
What's Deleted
GET /livedoc/v1/generatedLivedocs/{generatedLivedocId}/trackedFields
GET /livedoc/v1/generatedLivedocs/{generatedLivedocId}/trackedFieldsGet the tracked fields
Result
API changes broke backward compatibility
Integration
Integration (v v2)
Result
No differences. Specifications are equivalent
Summary: Updated APIs for Activity Logging. Updated APIs for Engagement Permission. Updated APIs for Engagement.
Activity Logging
Activity Logging (v v1)
Result
No differences. Specifications are equivalent
Engagement Permission
Engagement Permission (v v1)
Result
No differences. Specifications are equivalent
Engagement
Engagement (v v1)
Result
No differences. Specifications are equivalent
Summary: Updated APIs for Search.
Search
Search (v v1)
What's Changed
POST /v1/generative/source
POST /v1/generative/sourceRequest:
Changed content type : application/json
- Changed property
filter(object)Use to filter the content. It uses the json format, like {"operator":"and", "conditions":[{"attribute":"custom.propert_a", "operator":"in", "value":["test"]}]}
- Changed property
operator(string)Value should be 'and' or 'or'
- Changed property
filters(array)One array contains multi filters
- Changed property
conditions(array)One array contain multi conditions
Changed items (object):- Changed property
attribute(string)Property name of content to be used in filter, for custom property, the value should be 'custom.{propertyName}'
- Changed property
operator(string)The value should be 'in', for date type property, its value should be 'greaterthan' 'greaterthanorequalto' 'lessthan' 'lessthanorequalto'
- Changed property
value(array)The values of the property
- Changed property
- Changed property
POST /v1/generative/query
POST /v1/generative/queryRequest:
Changed content type : application/json
- Changed property
filter(object)Use to filter the content. It uses the json format, like {"operator":"and", "conditions":[{"attribute":"custom.propert_a", "operator":"in", "value":["test"]}]}
- Changed property
operator(string)Value should be 'and' or 'or'
- Changed property
filters(array)One array contains multi filters
- Changed property
conditions(array)One array contain multi conditions
Changed items (object):- Changed property
attribute(string)Property name of content to be used in filter, for custom property, the value should be 'custom.{propertyName}'
- Changed property
operator(string)The value should be 'in', for date type property, its value should be 'greaterthan' 'greaterthanorequalto' 'lessthan' 'lessthanorequalto'
- Changed property
value(array)The values of the property
- Changed property
- Changed property