Summary: Updated APIs for Delivery.

Delivery

Link to the documentation

Delivery (v v2)

What's Changed

GET /integration/v2/customDelivery/{deliveryOptionId}

Parameters:

Changed: deliveryOptionId in path

Unique identifier of the custom delivery option whose input form fields should be retrieved. Obtain this value from GET /integration/v2/delivery; must reference an option where isCustom is true.

Return Type:

New response : 400 Bad Request

Bad Request — deliveryOptionId references a non-custom delivery option or the request is malformed.
New response : 401 Unauthorized
Unauthorized
New response : 403 Forbidden
Forbidden
Changed response : 200 OK
OK

• Changed content type : application/json
  • Added property adHocInputs (array)

    List of ad-hoc input fields required by this custom delivery option. Empty array when the delivery option has no form fields.
    Items (object):

    • Property name (string)

      The variable name for this input field, used as the key when submitting values in POST /integration/v2/customDelivery adHocInputs.

    • Property type (string)

      The data type of this input field. Supported values are string, integer, date, boolean, float, and table.

    • Property format (string)

      Optional format specifier for the field value. Present for date type fields with value "yyyy-mm-dd".

    • Property columns (array)

      Sub-field definitions for table type inputs. Each column follows the same structure as a top-level adHocInput field.
      Items (object):

  • Deleted property adhocInputs (array)

GET /integration/v2/delivery

Return Type:

Changed response : 200 OK

OK

• Changed content type : application/json
  Changed items (object):
  • Changed property externalApplication (string)

    The external platform this delivery option integrates with. Empty string for standard Seismic delivery channels. Possible non-empty values: ios, salesforce, google drive.
    Removed enum values:

    • sharepoint
    • gmail

POST /integration/v2/saveToWorkspace

Parameters:

Changed: Content-Type in header

Media type of the request body. Must be set to application/json.

Request:

Changed content type : application/json

• Changed property workspaceOptions (object)

  Options controlling where the content items are saved within the workspace folder hierarchy.

  • Changed property workspaceFolderId (string)

    Identifier of the destination workspace folder. Use the special value "root" to save to the user's root workspace folder, or provide a folder ID from the workspace folder listing endpoint.

• Changed property content (array)

  Array of exactly one content item to save to workspace. The API enforces a maximum of 1 item; requests with multiple items return 400.
  Changed items (object):

  • Changed property repository (string)

    Source repository of the content item. Use doccenter or newscenter for library content, workspace for user-owned files. Note that generatedlivedocs is not supported.

  • Changed property name (string)

    Display name for the content item as it will appear in the user's workspace after saving.

  • Changed property type (string)

    Type of the content object being saved. Use file for documents and presentations, url for web links, article for news articles, livedoc for live document templates.

  • Changed property libraryContent (object)

    References the specific library content item and version to save to workspace.

    • Changed property id (string)

      Unique identifier of the library content item to save to workspace.

    • Changed property versionId (string)

      Specific version identifier of the content item. Use the latest versionId to save the most current version.

    • Changed property teamsiteId (string)

      Identifier of the teamsite that owns this library content item. Required for doccenter and newscenter repositories.

  • Changed property contentProfileId (string)

    Identifier of the content profile used to personalize the saved content. Leave empty for unfiltered content.

  • Changed property contentProfilePath (array)

    Ordered list of folder names representing the content profile path for personalizing the saved content.

  • Changed property id (string)

    Unique identifier of an existing workspace item when repository is workspace, or base64-encoded full path for other repositories.

Return Type:

New response : 400 Bad Request

Bad Request — invalid content references, unsupported repository type, or malformed workspaceFolderId.
New response : 401 Unauthorized
Unauthorized — missing or invalid bearer token.
New response : 403 Forbidden
Forbidden — the caller is authenticated but lacks the seismic.delivery scope.
Changed response : 200 OK
OK

• Changed content type : application/json
  • Changed property id (string -> string)

    Unique identifier of the newly created workspace file entry.

  • Changed property type (string)

    Type of the saved workspace item. For saveToWorkspace operations this is typically file.
    Added enum values:

    • file
    • url
    • folder
  • Changed property repository (string)

    The repository where the saved file now resides, typically workspace after saving.

  • Changed property resourceUrl (string)

    Direct API URL to retrieve this workspace file's metadata and content details.

  • Changed property size (number -> integer)

    File size in bytes of the saved workspace content item.

  • Changed property versionId (string -> string)

    Version identifier of the saved file, used to reference this specific version in subsequent API calls.

  • Changed property createdAt (string)

    RFC 3339 timestamp (UTC) indicating when this workspace file entry was created (e.g., 2024-09-04T09:09:13.157Z).

  • Changed property createdBy (object)

    Identity of the user who created this workspace file entry.

    • Changed property id (string -> string)

      Unique identifier of the Seismic user who created this workspace file entry.

  • Changed property modifiedAt (string)

    RFC 3339 timestamp (UTC) indicating when this workspace file entry was last modified (e.g., 2024-09-04T09:09:13.157Z).

  • Changed property modifiedBy (object)

    Identity of the user who last modified this workspace file entry.

    • Changed property id (string -> string)

      Unique identifier of the Seismic user who last modified this workspace file entry.

  • Changed property isContextualContent (boolean)

    Indicates whether this file is contextual content associated with a specific sales or engagement context.

  • Changed property iconUrl (string)

    URL of the icon image representing the file format (e.g., PowerPoint, PDF) for display in the UI.

  • Changed property format (string)

    File format extension of the saved content item (e.g., pptx, pdf, docx).

  • Changed property name (string)

    Display name of the saved workspace file as it appears in the user's workspace.

  • Changed property parentFolderId (string -> string)

    UUID of the workspace folder that contains this file. Use root for files saved to the top-level folder.

  • Changed property deliveryOptions (array)

    List of delivery option objects available for distributing this workspace file to recipients. Each object contains an id field with the delivery option UUID.
    Changed items (object):

    • Changed property id (string -> string)

      Unique identifier of a delivery option available for distributing this workspace file to recipients.

  • Changed property applicationUrls (array)

    Named URLs for accessing this workspace file in different application contexts (e.g., viewer, share link).
    Changed items (object):

    • Changed property name (string)

      Label for this application URL (e.g., Default), identifying the viewer context in which the URL is used.

    • Changed property url (string)

      URL to access this workspace file in the specified application context, such as a shareable viewer link.

POST /integration/v2/customDelivery

Parameters:

Changed: Content-Type in header

Media type of the request body. Must be set to application/json.

Request:

Changed content type : application/json

• Changed property deliveryOption (string)

  Legacy name of the delivery option. Prefer using deliveryOptionId for unambiguous identification of the target delivery channel.

• Changed property deliveryOptionId (string)

  Unique identifier of the custom delivery option to use. Obtain from GET /integration/v2/delivery; must reference an enabled custom delivery option.

• Changed property content (array)

  One or more content items to deliver via the specified custom delivery channel.
  Changed items (object):

  • Changed property repository (string)

    The content source repository. Valid values are doccenter (Library), newscenter (News Center), workspace (personal workspace), and library (legacy library items).

  • Changed property name (string)

    Display name for the content item as it will appear in the delivery.

  • Changed property type (string)

    The type of content object being delivered. Valid values are file (documents and media), url (web links), article (news center articles), and livedoc (live documents).

  • Changed property libraryContent (object)

    References the specific library content item and version to deliver.

    • Changed property id (string)

      Unique identifier of the library content item to deliver.

    • Changed property versionId (string)

      Specific version identifier of the content item. Use the latest versionId to deliver the most current version.

    • Changed property teamsiteId (string)

      Identifier of the teamsite (content workspace) that owns this library content item.

  • Changed property contentProfileId (string)

    Identifier of the content profile to apply when personalizing delivery. Leave empty for unfiltered content.

  • Changed property contentProfilePath (array)

    Ordered list of folder names representing the content profile path used to personalize the delivered content.

  • Changed property id (string)

    Base64-encoded full path identifier for the content item, used when repository is workspace.

• Changed property adHocInputs (array)

  Dynamic input values required by the custom delivery form. Field names and types are defined by GET /integration/v2/customDelivery/{deliveryOptionId}.
  Changed items (object):

  • Changed property name (string)

    The variable name matching an adhocInput field returned by GET /integration/v2/customDelivery/{deliveryOptionId}.

  • Changed property value (number)

    The value to supply for this ad-hoc input. Use a scalar for string/integer/date types, or an object with columns and rows arrays for table types.

Return Type:

New response : 400 Bad Request

Bad Request — invalid deliveryOptionId, missing required adHocInput fields, or unsupported repository type.
New response : 401 Unauthorized
Unauthorized — missing or invalid bearer token.
New response : 403 Forbidden
Forbidden — the token lacks the required seismic.delivery scope.
New response : 404 Not Found
Not Found — the specified deliveryOptionId does not exist.

Result

API changes broke backward compatibility