Changelog
Getting StartedGuidesAPI DocsMy AppsChangelog
Back to All
improved

2024 January Week 5 release: New APIs added, updates to existing APIs and removed deprecated APIs

30 days ago by ReadMe API

Summary: Added new APIs for Approval Workflow. Added new APIs for Custom Properties. Added new APIs for Custom Schema (Early Access). Updated APIs for Digital Sales Room. Added new APIs for Integration. Added new APIs for Intelligence Services (early access). Updated APIs for Link Delivery. Added new APIs for LiveDoc. Added new APIs for LiveForm. Added new APIs for Livedoc Express. Updated APIs for Meeting. Updated APIs for Planner. Added new APIs for SCIM. Added new APIs for Search. Added new APIs for Workspace. Deleted APIs from Content Properties.

Approval Workflow

Released new feature - approval workflow apis for the first time.

Link to the documentation

  • /workflow/v1/engagements/pendingApprovals [post]
  • /workflow/v1/engagements/{engagementId}/operations/{operation} [put]
  • /workflow/v1/engagements/{engagementId}/runningWorkflows [get]
  • /workflow/v1/engagements/{engagementId}/workflows/{workflowId}/steps/{stepId}/operations/{operation} [put]

Custom Properties

Released new feature - custom properties apis for the first time.

Link to the documentation

  • /custom-property/v1/customProperties [post]
  • /custom-property/v1/customProperties/{customPropertyId} [get]

Custom Schema (Early Access)

Released new feature - custom schema (early access) apis for the first time.

Link to the documentation

  • /css/v1/schemas [get]
  • /css/v1/schemas/{id} [get]
  • /css/v1/schemas/{id}/versions/{version} [get]

Integration

Released new feature - integration apis for the first time.

Link to the documentation

  • /integration/v2/teamsites [get]
  • /integration/v2/teamsites/{teamsiteId} [get]
  • /integration/v2/contentProperties/{contentPropertyId}/values [get]
  • /integration/v2/contentProperties [get]
  • /integration/v2/teamsites/{teamsiteId}/files [post]
  • /integration/v2/teamsites/{teamsiteId}/files/{libraryContentId} [patch]
  • /integration/v2/teamsites/{teamsiteId}/files/{libraryContentId}/content [put]
  • /integration/v2/teamsites/{teamsiteId}/files/{libraryContentId}/versions/{libraryVersionId}/content [get]
  • /integration/v2/teamsites/{teamsiteId}/files/{libraryContentId}/copy [post]
  • /integration/v2/teamsites/{teamsiteId}/folders [post]
  • /integration/v2/teamsites/{teamsiteId}/folders/{libraryContentId} [get]
  • /integration/v2/teamsites/{teamsiteId}/folders/{libraryContentId}/copy [post]
  • /integration/v2/teamsites/{teamsiteId}/folders/{libraryContentId}/items [get]
  • /integration/v2/teamsites/{teamsiteId}/items/{libraryContentId} [delete]
  • /integration/v2/teamsites/{teamsiteId}/items/{libraryContentId}/copy [post]
  • /integration/v2/teamsites/{teamsiteId}/items/{libraryContentId}/versions [get]
  • /integration/v2/teamsites/{teamsiteId}/items [get]
  • /integration/v2/teamsites/{teamsiteId}/items/{libraryContentId}/thumbnail [put]
  • /integration/v2/teamsites/{teamsiteId}/urls [post]
  • /integration/v2/teamsites/{teamsiteId}/urls/{libraryContentId} [patch]
  • /integration/v2/teamsites/{teamsiteId}/urls/{libraryContentId}/copy [post]
  • /integration/v2/teamsites/{teamsiteId}/folders/createPath [put]
  • /integration/v2/teamsites/{teamsiteId}/items/{libraryContentId}/instructions [post]
  • /integration/v2/teamsites/{teamsiteId}/items/{libraryContentId}/instructions/{instructionId} [delete]
  • /integration/v2/teamsites/{teamsiteId}/items/{libraryContentId}/submit [put]
  • /integration/v2/teamsites/{teamsiteId}/items/{libraryContentId}/recall [put]
  • /integration/v2/approvalWorkflows/{approvalWorkflowId}/steps/{stepId} [put]
  • /integration/v2/approvalWorkflows/{approvalWorkflowId} [get]
  • /integration/v2/approvalWorkflows [get]
  • /integration/v2/teamsites/{teamsiteId}/publish [post]
  • /integration/v2/teamsites/{teamsiteId}/items/{libraryContentId}/unpublish [put]
  • /integration/v2/delivery [get]
  • /integration/v2/customDelivery/{deliveryOptionId} [get]
  • /integration/v2/customDelivery [post]
  • /integration/v2/saveToWorkspace [post]
  • /integration/v2/liveSend/links [post]
  • /integration/v2/liveSend/settings [get]
  • /integration/v2/teamsites/{teamsiteId}/livedocVersions/{libraryContentVersionId} [get]
  • /integration/v2/generatedLivedocs/{generatedLivedocId} [get]
  • /integration/v2/generatedLivedocs/{generatedLivedocId}/outputs/{outputId}/content [get]
  • /integration/v2/predictiveContent/{predictiveContentId}/{contextId} [get]
  • /integration/v2/predictiveContent [get]
  • /integration/v2/workspace/folders [post]
  • /integration/v2/workspace/folders/{workspaceFolderId}/copy [post]
  • /integration/v2/workspace/folders/createContextualFolder [post]
  • /integration/v2/workspace/files [post]
  • /integration/v2/workspace/files/{workspaceContentId} [get]
  • /integration/v2/workspace/files/{workspaceContentId}/copy [post]
  • /integration/v2/workspace/files/{workspaceContentId}/content [get]
  • /integration/v2/workspace/urls [post]
  • /integration/v2/workspace/urls/{workspaceContentId} [get]
  • /integration/v2/workspace/urls/{workspaceContentId}/copy [post]
  • /integration/v2/workspace/items/{workspaceContentId} [get]
  • /integration/v2/workspace/items/{workspaceContentId}/copy [post]
  • /integration/v2/workspace/folders/{workspaceFolderId} [get]
  • /integration/v2/workspace/folders/{workspaceContentId}/items [get]
  • /integration/v2/workspace/{workspaceContentId}/members [get]
  • /integration/v2/system/optouts [put]
  • /integration/v2/system/optouts/{email} [delete]
  • /integration/v2/users [get]
  • /integration/v2/users/{userId} [get]
  • /integration/v2/users/favorites [get]
  • /integration/v2/users/recents [get]
  • /integration/v2/users/teamsites [get]
  • /integration/v2/users/profiles [get]
  • /integration/v2/workspace/spaces/{spaceId}/items/{workspaceContentId}/comments [get]
  • /integration/v2/workspace/spaces/{spaceId}/items/{workspaceContentId}/versions/{workspaceVersionId}/comments [post]
  • /integration/v2/workspace/spaces/{spaceId}/items/{workspaceContentId}/versions/{workspaceVersionId}/comments/{commentId}/reply [post]
  • /integration/v2/workspace/spaces/{spaceId}/items/{workspaceContentId}/versions/{workspaceVersionId}/comments/{commentId} [delete]
  • /integration/v2/workspace/spaces/{spaceId}/items/{workspaceContentId}/versions/{workspaceVersionId}/comments/{commentId}/reply/{replyId} [delete]
  • /integration/v2/workspace/spaces/{spaceId}/items/{workspaceContentId}/versions/{workspaceVersionId}/comments/{commentId}/resolve [put]

Intelligence Services (early access)

Released new feature - intelligence services (early access) apis for the first time.

Link to the documentation

  • /intelligence/v2/recommenders [get]
  • /intelligence/v2/contentRecommendations [post]

LiveDoc

Released new feature - livedoc apis for the first time.

Link to the documentation

  • /livedoc/v1/generatedLivedocs/{generatedLivedocId}/trackedFields [get]

LiveForm

Released new feature - liveform apis for the first time.

Link to the documentation

  • /liveform/v1/teamSites/{teamsiteId}/contents/{contentId}/sellerTemplates [get]

Livedoc Express

Released new feature - livedoc express apis for the first time.

Link to the documentation

  • /livedocs-express/v2/teamsites/{teamsiteId}/batches [post]
  • /livedocs-express/v2/teamsites/{teamsiteId}/batches/{batchId}/generate [post]
  • /livedocs-express/v2/teamsites/{teamsiteId}/batches/{batchId}/schedule [post]
  • /livedocs-express/v2/teamsites/{teamsiteId}/batches/{batchId}/criteria [post]
  • /livedocs-express/v2/teamsites/{teamsiteId}/batches/{batchId}/batchInstances [get]
  • /livedocs-express/v2/teamsites/{teamsiteId}/batches/{batchId}/variants [get]
  • /livedocs-express/v2/teamsites/{teamsiteId}/batches/{batchId} [put]
  • /livedocs-express/v2/teamsites/{teamsiteId}/batches/{batchId}/livedocs [put]
  • /livedocs-express/v2/teamsites/{teamsiteId}/batchInstances/{batchInstanceId} [patch]
  • /livedocs-express/v2/teamsites/{teamsiteId}/batches/{batchId}/schedule/{scheduledBatchId} [delete]
  • /livedocs-express/v2/teamsites/{teamsiteId}/batchInstances/{batchInstanceId}/variantInstances [get]
  • /livedocs-express/v2/teamsites/{teamsiteId}/batchInstances/{batchInstanceId}/livedocs [get]
  • /livedocs-express/v2/teamsites/{teamsiteId}/batchInstances/{batchInstanceId}/status [get]
  • /livedocs-express/v2/teamsites/{teamsiteId}/batches/{batchId}/variants/count [get]
  • /livedocs-express/v2/teamsites/{teamsiteId}/batchInstances/{batchInstanceId}/cancel [patch]
  • /livedocs-express/v2/teamsites/{teamsiteId}/livedocVersions/{libraryContentVersionId}/generate [post]
  • /livedocs-express/v2/teamsites/{teamsiteId}/livedocVersions/{libraryContentVersionId}/import/{uploadId} [post]
  • /livedocs-express/v2/teamsites/{teamsiteId}/livedocVersions/{libraryContentVersionId}/upload [post]
  • /livedocs-express/v2/teamsites/{teamsiteId}/livedocVersions/{libraryContentVersionId}/variants [post]
  • /livedocs-express/v2/teamsites/{teamsiteId}/livedocVersions/{libraryContentVersionId}/variants/copy [post]
  • /livedocs-express/v2/teamsites/{teamsiteId}/livedocVersions/{libraryContentVersionId}/batchInstances [get]
  • /livedocs-express/v2/teamsites/{teamsiteId}/livedocVersions/{libraryContentVersionId}/export [get]
  • /livedocs-express/v2/teamsites/{teamsiteId}/livedocVersions/{libraryContentVersionId}/template [get]
  • /livedocs-express/v2/teamsites/{teamsiteId}/livedocVersions/{libraryContentVersionId}/variantInstances [get]
  • /livedocs-express/v2/teamsites/{teamsiteId}/livedocVersions/{libraryContentVersionId}/variantInstances/{variantInstanceId} [get]
  • /livedocs-express/v2/teamsites/{teamsiteId}/livedocVersions/{libraryContentVersionId}/variants/{variantId} [put]
  • /livedocs-express/v2/teamsites/{teamsiteId}/livedocVersions/{libraryContentVersionId}/bulkVariants [put]

SCIM

Released new feature - scim apis for the first time.

Link to the documentation

  • /scim/v2/Groups [get]
  • /scim/v2/Groups/{groupId} [delete]
  • /scim/v2/Groups/{groupId}/Users [get]
  • /scim/v2/ResourceTypes [get]
  • /scim/v2/Schemas [get]
  • /scim/v2/ServiceProviderConfig [get]
  • /scim/v2/Users [get]
  • /scim/v2/Users/{userId} [delete]
  • /scim/v2/Users/{userId}/Groups [get]
  • /scim/v2/Users/{userId}/Groups/{groupId} [delete]

Search

Released new feature - search apis for the first time.

Link to the documentation

  • /v1/content/query [post]
  • /v1/generative/source [post]
  • /v1/generative/query [post]

Workspace

Released new feature - workspace apis for the first time.

Link to the documentation

  • /workspace/v1/files/{workspaceContentId}/versions [get]
  • /workspace/v1/files/{workspaceContentId}/customProperties [get]
  • /workspace/v1/items/{workspaceContentId}/members [post]
  • /workspace/v1/items/{workspaceContentId}/members/{memberId} [delete]
  • /workspace/v1/items/{workspaceContentId}/owner [put]

Digital Sales Room

Link to the documentation

What's Changed

PUT /dsr/v1/{engagementType}/{id}/viewerACL/{userIdentifier}
Parameters:

Deleted: X-CORRELATION-ID in header

This header can help Seismic with the linking of a client call to our internal logs and events for technical troubleshooting.

PATCH /dsr/v1/{engagementType}/{id}/viewerACL
Parameters:

Deleted: X-CORRELATION-ID in header

This header can help Seismic with the linking of a client call to our internal logs and events for technical troubleshooting.

Link Delivery

Link to the documentation

What's New

POST /v1/deliveries

Create Link Delivery

What's Deleted

POST /link-delivery/v1/deliveries

Create Link Delivery

Meeting

Link to the documentation

What's New

GET /meetings/v1/meetings/{meetingId}/shareableContents

Get list of meeting contents by meeting id which can be shared with other users

What's Changed

GET /meetings/v1/meetings/{meetingId}/postMeetingOverview
Return Type:

Changed response : 200 OK

Successful response

  • Changed content type : application/json
    • Added property objections (object)

      A set of objections in the meeting from AIML analysis

    • Added property discoveryQuestions (object)

      A set of discovery questions in the meeting from AIML analysis

    • Added property commercialTopics (object)

      A set of commercial topics in the meeting from AIML analysis

Planner

Link to the documentation

What's New

GET /v2/access

Check access

GET /v2/spaces/{spaceId}/activity

Get activities

GET /v2/spaces/{spaceId}/nodes/{nodeId}/activity

Get activities for a node

GET /v2/spaces/{spaceId}/nodes/{nodeId}/associations

Get associations

POST /v2/spaces/{spaceId}/nodes/{nodeId}/associations

Add associations

POST /v2/spaces/{spaceId}/nodes/{nodeId}/associations/delete

Remove associations

GET /v2/spaces/{spaceId}/asyncAction

Get async actions

GET /v2/spaces/{spaceId}/nodes/{nodeId}/comments

Get comments

POST /v2/spaces/{spaceId}/nodes/{nodeId}/comments

Create comment

GET /v2/spaces/{spaceId}/nodes/{nodeId}/comments/{commentId}

Get comment

PUT /v2/spaces/{spaceId}/nodes/{nodeId}/comments/{commentId}

Update comment

DELETE /v2/spaces/{spaceId}/nodes/{nodeId}/comments/{commentId}

Delete comment

GET /v2/spaces/{spaceId}/nodes/{nodeId}/follower

Get followers

POST /v2/spaces/{spaceId}/nodes/{nodeId}/follower

Add followers

DELETE /v2/spaces/{spaceId}/nodes/{nodeId}/follower

Remove followers

GET /v2/spaces/{spaceId}/projects

Get projects

POST /v2/spaces/{spaceId}/projects

Create project

DELETE /v2/spaces/{spaceId}/projects

Delete projects

GET /v2/spaces/{spaceId}/projects/{projectId}

Get project

PUT /v2/spaces/{spaceId}/projects/{projectId}

Update a project

DELETE /v2/spaces/{spaceId}/projects/{projectId}

Delete project

GET /v2/spaces/{spaceId}/projects/{projectId}/contents

Get project content

GET /v2/spaces/{spaceId}/projects/my

Get my projects

GET /v2/spaces/{spaceId}/projects/groupby

Group by projects

POST /v2/spaces/{spaceId}/projects/{projectId}/makeTemplate

Create a project template

GET /v2/spaces/{spaceId}/projects/template

Get project templates

DELETE /v2/spaces/{spaceId}/projects/template

Delete project templates

GET /v2/spaces/{spaceId}/projects/template/{templateId}

Get project template

PUT /v2/spaces/{spaceId}/projects/template/{templateId}

Update project template

PATCH /v2/spaces/{spaceId}/projects/bulk

Bulk patch project (patch)

POST /v2/spaces/{spaceId}/projects/template/{templateId}/apply

Apply project template

PUT /v2/spaces/{spaceId}/rank

Update rank

GET /v2/spaces/{spaceId}/forms

Get request forms

POST /v2/spaces/{spaceId}/forms

Create request form

GET /v2/spaces/{spaceId}/forms/{formId}

Get request form

PUT /v2/spaces/{spaceId}/forms/{formId}

Update request form

DELETE /v2/spaces/{spaceId}/forms/{formId}

Delete request form

POST /v2/spaces/{spaceId}/forms/{formId}/permission

Update request form permissions

PUT /v2/spaces/{spaceId}/forms/{formId}/activate

Activate a request form

PUT /v2/spaces/{spaceId}/forms/{formId}/deactivate

Deactivate a request form

GET /v2/spaces/{spaceId}/requests

Get requests

POST /v2/spaces/{spaceId}/requests

Create request

DELETE /v2/spaces/{spaceId}/requests

Delete requests

GET /v2/spaces/{spaceId}/requests/{requestId}

Get request

PUT /v2/spaces/{spaceId}/requests/{requestId}

Update request

DELETE /v2/spaces/{spaceId}/requests/{requestId}

Delete request

GET /v2/spaces/{spaceId}/requests/my

Get my requests

PATCH /v2/spaces/{spaceId}/requests/bulk

Bulk patch requests

GET /v2/spaces/{spaceId}/requests/groupby

Group by requests

GET /v2/spaces/{spaceId}/savedViews

Get saved views

POST /v2/spaces/{spaceId}/savedViews

Create a saved view

GET /v2/spaces/{spaceId}/savedViews/{savedViewId}

Get a saved view

PUT /v2/spaces/{spaceId}/savedViews/{savedViewId}

Update a saved view

DELETE /v2/spaces/{spaceId}/savedViews/{savedViewId}

Delete saved view

GET /v2/spaces

Get spaces

GET /v2/spaces/{spaceId}

Get a space

GET /v2/spaces/{spaceId}/statusschema

Get status schemas

GET /v2/spaces/{spaceId}/statusschema/{statusSchemaId}

Get status schema

GET /v2/spaces/{spaceId}/tasks

Get tasks

POST /v2/spaces/{spaceId}/tasks

Create task

GET /v2/spaces/{spaceId}/tasks/template

Get task templates

POST /v2/spaces/{spaceId}/tasks/template

Create a task template

GET /v2/spaces/{spaceId}/tasks/{taskId}

Get task

PUT /v2/spaces/{spaceId}/tasks/{taskId}

Update task

DELETE /v2/spaces/{spaceId}/tasks/{taskId}

Delete task

GET /v2/spaces/{spaceId}/tasks/template/{taskTemplateId}

Get a task template

PUT /v2/spaces/{spaceId}/tasks/template/{taskTemplateId}

Update a task template

DELETE /v2/spaces/{spaceId}/tasks/template/{taskTemplateId}

Delete a task template

GET /v2/spaces/{spaceId}/tasks/my

Get my tasks

PATCH /v2/spaces/{spaceId}/tasks/bulk

Bulk patch tasks

GET /v2/spaces/{spaceId}/tasks/groupby

Group by tasks

DELETE /v2/spaces/{spaceId}/tasks/delete

Delete tasks

What's Deleted

GET /planner/v2/access

Check access

GET /planner/v2/spaces/{spaceId}/activity

Get activities

GET /planner/v2/spaces/{spaceId}/nodes/{nodeId}/activity

Get activities for a node

GET /planner/v2/spaces/{spaceId}/nodes/{nodeId}/associations

Get associations

POST /planner/v2/spaces/{spaceId}/nodes/{nodeId}/associations

Add associations

POST /planner/v2/spaces/{spaceId}/nodes/{nodeId}/associations/delete

Remove associations

GET /planner/v2/spaces/{spaceId}/asyncAction

Get async actions

GET /planner/v2/spaces/{spaceId}/nodes/{nodeId}/comments

Get comments

POST /planner/v2/spaces/{spaceId}/nodes/{nodeId}/comments

Create comment

GET /planner/v2/spaces/{spaceId}/nodes/{nodeId}/comments/{commentId}

Get comment

PUT /planner/v2/spaces/{spaceId}/nodes/{nodeId}/comments/{commentId}

Update comment

DELETE /planner/v2/spaces/{spaceId}/nodes/{nodeId}/comments/{commentId}

Delete comment

GET /planner/v2/spaces/{spaceId}/nodes/{nodeId}/follower

Get followers

POST /planner/v2/spaces/{spaceId}/nodes/{nodeId}/follower

Add followers

DELETE /planner/v2/spaces/{spaceId}/nodes/{nodeId}/follower

Remove followers

GET /planner/v2/spaces/{spaceId}/projects

Get projects

POST /planner/v2/spaces/{spaceId}/projects

Create project

DELETE /planner/v2/spaces/{spaceId}/projects

Delete projects

GET /planner/v2/spaces/{spaceId}/projects/{projectId}

Get project

PUT /planner/v2/spaces/{spaceId}/projects/{projectId}

Update a project

DELETE /planner/v2/spaces/{spaceId}/projects/{projectId}

Delete project

GET /planner/v2/spaces/{spaceId}/projects/{projectId}/contents

Get project content

GET /planner/v2/spaces/{spaceId}/projects/my

Get my projects

GET /planner/v2/spaces/{spaceId}/projects/groupby

Group by projects

POST /planner/v2/spaces/{spaceId}/projects/{projectId}/makeTemplate

Create a project template

GET /planner/v2/spaces/{spaceId}/projects/template

Get project templates

DELETE /planner/v2/spaces/{spaceId}/projects/template

Delete project templates

GET /planner/v2/spaces/{spaceId}/projects/template/{templateId}

Get project template

PUT /planner/v2/spaces/{spaceId}/projects/template/{templateId}

Update project template

POST /planner/v2/spaces/{spaceId}/projects/template/{templateId}/apply

Apply project template

PUT /planner/v2/spaces/{spaceId}/rank

Update rank

GET /planner/v2/spaces/{spaceId}/forms

Get request forms

POST /planner/v2/spaces/{spaceId}/forms

Create request form

GET /planner/v2/spaces/{spaceId}/forms/{formId}

Get request form

PUT /planner/v2/spaces/{spaceId}/forms/{formId}

Update request form

DELETE /planner/v2/spaces/{spaceId}/forms/{formId}

Delete request form

POST /planner/v2/spaces/{spaceId}/forms/{formId}/permission

Update request form permissions

PUT /planner/v2/spaces/{spaceId}/forms/{formId}/activate

Activate a request form

PUT /planner/v2/spaces/{spaceId}/forms/{formId}/deactivate

Deactivate a request form

GET /planner/v2/spaces/{spaceId}/requests

Get requests

POST /planner/v2/spaces/{spaceId}/requests

Create request

DELETE /planner/v2/spaces/{spaceId}/requests

Delete requests

GET /planner/v2/spaces/{spaceId}/requests/{requestId}

Get request

PUT /planner/v2/spaces/{spaceId}/requests/{requestId}

Update request

DELETE /planner/v2/spaces/{spaceId}/requests/{requestId}

Delete request

GET /planner/v2/spaces/{spaceId}/requests/my

Get my requests

GET /planner/v2/spaces/{spaceId}/requests/groupby

Group by requests

GET /planner/v2/spaces

Get spaces

GET /planner/v2/spaces/{spaceId}

Get a space

GET /planner/v2/spaces/{spaceId}/statusschema

Get status schemas

GET /planner/v2/spaces/{spaceId}/statusschema/{statusSchemaId}

Get status schema

GET /planner/v2/spaces/{spaceId}/tasks

Get tasks

POST /planner/v2/spaces/{spaceId}/tasks

Create task

GET /planner/v2/spaces/{spaceId}/tasks/{taskId}

Get task

PUT /planner/v2/spaces/{spaceId}/tasks/{taskId}

Update task

DELETE /planner/v2/spaces/{spaceId}/tasks/{taskId}

Delete task

GET /planner/v2/spaces/{spaceId}/tasks/my

Get my tasks

GET /planner/v2/spaces/{spaceId}/tasks/groupby

Group by tasks

DELETE /planner/v2/spaces/{spaceId}/tasks/delete

Delete tasks