All Reference

CMS Connect REST API

API docs by Redocly
All Reference

CMS Connect REST API

CMS Connect REST API (v67.0)

Download OpenAPI specification:Download

Note: The API Reference has a new three-panel layout. Browse grouped endpoints on the left, review endpoint details in the center, and access examples on the right.

Important: Where possible, we changed noninclusive terms to align with our company value of Equality. We maintained certain terms to avoid any effect on customer implementations.

CMS Managed Content Resources

Get published managed content versions for an Experience Cloud site or a channel. Search managed content in an Experience Cloud site or channel. Get managed content delivery channels for the context user. Get published managed content versions for a channel. Search managed content in a channel. Get the binary stream of published managed content. Get or update the searchable status for managed content types in a channel. Get a piece of managed content. Get a managed content folder.

If you have enhanced CMS workspaces, see Enhanced CMS Workspaces Resources.

CMS Searchable Content Types, Channel

Get the searchable status for managed content types in a channel.

Available in: v49.0

path Parameters
channelId
required
string <Id> ^(0ap)\w*

ID of a channel.

query Parameters
page
integer

Number of the page you want returned. Starts at 0. If you don’t specify a value or if you specify 0, the first page is returned.

Available in: v49.0

pageSize
integer

Specifies the number of items per page. Valid values are from 1 through 250. If you don’t specify a value, the default size is 25.

Available in: v49.0

Responses

Response samples

Content type
application/json
{
  • "currentPageUrl": "string",
  • "items": [
    ],
  • "nextPageUrl": "string",
  • "totalItems": 0
}

CMS Searchable Content Types, Channel

Update the searchable status for managed content types in a channel.

Available in: v49.0

path Parameters
channelId
required
string <Id> ^(0ap)\w*

ID of a channel.

Request Body schema: application/json

Update the searchable status of a managed content type.

isSearchable
required
boolean

Specifies whether to set the managed content type to searchable (true) or not (false).

Available in: v49.0

name
required
string

Developer name of the managed content type. In version 63.0 and later, specify the fully qualified name for content types that are package-installed.

Available in: v49.0

Responses

Request samples

Content type
application/json
{
  • "name": "Media",
  • "isSearchable": "false"
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "isSearchable": true,
  • "label": "string",
  • "name": "string"
}

CMS Delivery Channels

Get managed content delivery channels for the context user.

Available in: v48.0

This resource returns Managed Content Channel Collection response schema in v48.0–61.0.

query Parameters
page
integer

Number of the page you want returned. Starts at 0. If you pass in null or 0, the first page is returned.

Available in: v48.0

pageSize
integer

Specifies the number of items per page. Valid values are from 1 through 250. If you don’t specify a value, the default size is 25.

Available in: v48.0

Responses

Response samples

Content type
application/json
{
  • "channels": [
    ],
  • "currentPageUrl": "string",
  • "nextPageUrl": "string",
  • "previousPageUrl": "string",
  • "totalChannels": 0
}

CMS Delivery, Channel Query

Get published managed content versions for a channel.

Available in: v48.0

path Parameters
channelId
required
string <Id> ^(0ap)\w*

ID of a channel.

query Parameters
contentKeys
Array of strings

List of up to 50 content keys for the managed content. A content key is a universally unique identifier (UUID) such as MCA4CCV5QS2BAB5H7YRCRPTCWGZQ.

Specify either contentKeys or managedContentIds.

Available in: v51.0

endDate
string

Publish end date in ISO 8601 format, for example, 2011-02-25T18:24:31.000Z.

Available in: v48.0

includeMetadata
boolean

Specifies whether to include metadata in the response (true) or not (false). The default value is false.

Available in: v48.0

language
string

Language locale for the managed content, for example, en_US. If the requested translation isn’t available, the language defaults to the context user’s language. If the context user’s language isn’t available, the language defaults to the content type’s original language.

Available in: v48.0

managedContentIds
Array of strings

Comma-separated list of managed content IDs. HTTP/2 clients support up to 200 IDs. HTTP/1.1 clients don’t.

Specify either contentKeys or managedContentIds.

Available in: v48.0

managedContentType
string

Developer name of the content type, such as cms_document or cms_image.

Available in: v48.0

page
integer

Number of the page you want returned. Starts at 0. If you don’t specify a value or if you specify 0, the first page is returned.

Available in: v48.0

pageSize
integer

Specifies the number of items per page. Valid values are from 1 through 250. For performance reasons, we recommend 25 or fewer items per page. If you don’t specify a value, the default size is 25.

Available in: v48.0

showAbsoluteUrl
boolean

Specifies whether to show absolute URLs in the response body (true) or not (false). If you don’t specify a value, the default is false.

Available in: v50.0

startDate
string

Publish start date in ISO 8601 format, for example, 2011-02-25T18:24:31.000Z.

Available in: v48.0

Responses

Response samples

Content type
application/json
{
  • "currentPageUrl": "string",
  • "items": [
    ],
  • "managedContentTypes": {
    },
  • "nextPageUrl": "string",
  • "total": 0,
  • "totalTypes": 0
}

CMS Delivery Search, Channel

Search managed content in a channel.

Note: CMS Delivery Search, Channel doesn’t support enhanced CMS channels. To search in enhanced CMS workspaces, use CMS Search.

Available in: v48.0

path Parameters
channelId
required
string <Id> ^(0ap)\w*

ID of a channel.

query Parameters
page
integer

Number of the page you want returned. Starts at 0. If you don’t specify a value or if you specify 0, the first page is returned.

Available in: v48.0

pageSize
integer

Specifies the number of items per page. Valid values are from 1 through 250. If you don’t specify a value, the default size is 25.

Available in: v48.0

queryTerm
required
string

SOSL query.

Available in: v48.0

scope
string (ConnectManagedContentSearchScopeEnum)
Enum: "All" "TitleOnly"

Scope of the content search. Values are:

  • All —Search all text.
  • TitleOnly —Search only title text.

If you don’t specify a value, the default is All.

Available in: v48.0

Responses

Response samples

Content type
application/json
{
  • "count": 0,
  • "currentPageUri": "string",
  • "items": [
    ],
  • "nextPageUri": "string"
}

CMS Delivery Content, Channel

Get the binary stream of a media node of published content in a channel.

Available in: v49.0

path Parameters
channelId
required
string <Id> ^(0ap)\w*

ID of a channel.

mediaGuid
required
string <Id>

The {mediaGuid} parameter uniquely identifies the media node.

query Parameters
language
string

Language locale for the managed content, for example, en_US. To get content for a channel in the specified language, that language must be added to the channel. If you don’t specify a language or if the requested translation isn’t available, the language defaults to the channel or site’s default language. If the channel or site’s default language isn’t available, the language defaults to the primary language of the content space.

Available in: v54.0

Responses

CMS Folder

Get a managed content folder.

Available in: v53.0

path Parameters
folderId
required
string <Id> ^(9Pu)\w*

ID of the folder.

query Parameters
contextContentSpaceId
string

ID of the context workspace. Specify to get folder hierarchy information starting from the root of the context workspace.

Available in: v61.0

Responses

Response samples

Content type
application/json
{
  • "createdBy": "string",
  • "createdDate": "2019-08-24T14:15:22Z",
  • "folderHierarchy": [
    ],
  • "folderType": "SharedWithSpace",
  • "id": "string",
  • "isShared": true,
  • "lastModifiedBy": "string",
  • "lastModifiedDate": "2019-08-24T14:15:22Z",
  • "name": "string",
  • "parentFolderId": "string"
}

Managed Content Delivery, Experience Cloud Site

Get published managed content versions for an Experience Cloud site.

Available in: v47.0

path Parameters
communityId
required
string <CommunityId>

ID of an Experience Cloud site.

query Parameters
contentKeys
Array of strings

List of up to 50 content keys for the managed content. A content key is a universally unique identifier (UUID) such as MCA4CCV5QS2BAB5H7YRCRPTCWGZQ.

Specify either contentKeys or managedContentIds.

Available in: v51.0

language
string

Language locale for the managed content, for example, en_US. If the requested translation isn’t available, the language defaults to the context user’s language. If the context user’s language isn’t available, the language defaults to the content type’s original language.

Available in: v47.0

managedContentIds
Array of strings

Comma-separated list of managed content IDs. HTTP/2 clients support up to 200 IDs. HTTP/1.1 clients don’t.

Specify either contentKeys or managedContentIds.

Available in: v47.0

managedContentType
string

Developer name of the content type, such as cms_document or cms_image.

Available in: v47.0

page
integer

Number of the page you want returned. Starts at 0. If you don’t specify a value or if you specify 0, the first page is returned.

Available in: v47.0

pageSize
integer

Specifies the number of items per page. Valid values are from 1 through 250. For performance reasons, we recommend 25 or fewer items per page. If you don’t specify a value, the default size is 25.

Available in: v47.0

showAbsoluteUrl
boolean

Specifies whether to show absolute URLs in the response body (true) or not (false). If you don’t specify a value, the default is false.

Available in: v50.0

topics
Array of strings

Comma-separated list of up to 15 content topic names.

Available in: v47.0

Responses

Response samples

Content type
application/json
{
  • "currentPageUrl": "string",
  • "items": [
    ],
  • "managedContentTypes": {
    },
  • "nextPageUrl": "string",
  • "total": 0,
  • "totalTypes": 0
}

Managed Content Delivery Search, Experience Cloud Site

Search managed content in an Experience Cloud site.

Available in: v48.0

path Parameters
communityId
required
string <CommunityId>

ID of an Experience Cloud site.

query Parameters
page
integer

Number of the page you want returned. Starts at 0. If you don’t specify a value or if you specify 0, the first page is returned.

Available in: v48.0

pageSize
integer

Specifies the number of items per page. Valid values are from 1 through 250. If you don’t specify a value, the default size is 25.

Available in: v48.0

queryTerm
required
string

SOSL query.

Available in: v48.0

scope
string (ConnectManagedContentSearchScopeEnum)
Enum: "All" "TitleOnly"

Scope of the content search. Values are:

  • All —Search all text.
  • TitleOnly —Search only title text.

If you don’t specify a value, the default is All.

Available in: v48.0

Responses

Response samples

Content type
application/json
{
  • "count": 0,
  • "currentPageUri": "string",
  • "items": [
    ],
  • "nextPageUri": "string"
}

Content Workspace Permissions Resources

Content Workspace Permissions

Get a user's permissions for a content workspace.

Available in: v39.0

path Parameters
userId
required
string <IdOrMe> ^(005)\w*|me

ID of the user.

workspaceId
required
string <Id> ^(058)\w*

ID of the workspace.

Responses

Response samples

Content type
application/json
{
  • "canAddFileComments": true,
  • "canAddFiles": true,
  • "canAddFilesOnBehalfOfOthers": true,
  • "canArchiveFiles": true,
  • "canAttachOrShareFilesToFeed": true,
  • "canDeleteFiles": true,
  • "canDeliverContent": true,
  • "canFeatureFiles": true,
  • "canManageWorkspace": true,
  • "canModifyFileComments": true,
  • "canOrganizeFilesAndFolders": true,
  • "canTagFiles": true,
  • "canViewFileComments": true
}

Enhanced CMS Workspaces Resources

Get managed content channels. Create a managed content channel. Get, update, or delete a managed content channel. Get managed content delivery channels. Get collection items for a channel or Experience Cloud site. Get a collection of published contents for a channel or Experience Cloud site. Get a piece of published content for a channel or Experience Cloud site. Search for content in a channel or Experience Cloud site. Get the binary stream of a media node of published content in a channel. Get or update the searchable status for managed content types in a channel. Get search indexes or trigger search indexing for a channel. Create managed content. Get a version of a piece of content. Clone a piece of managed content. Get, add, or remove taxonomy term associations from managed content. Get digital asset management (DAM) providers. Create, update, or delete a DAM provider instance. Publish and unpublish content. Create, update, get, or delete a managed content variant. Get a managed content folder. Get targets that a managed content space folder can be shared with. Get or update the targets that a managed content space folder is shared with. Search for managed content items, including variants and folders, in spaces and folders. Get managed content spaces. Create, get, or update a managed content space. Get channels for a managed content space. Add or remove channels from a managed content space.

These resources are available for enhanced CMS workspaces. If you don’t have enhanced CMS workspaces, see CMS Managed Content Resources.

CMS Channels

Get managed content channels.

To get managed content delivery channels, see CMS Delivery Channels.

Available in: v62.0

query Parameters
page
integer

Number of the page you want returned. Starts at 0. If you don’t specify a value or if you specify 0, the first page is returned.

Available in: v62.0

pageSize
integer

Specifies the number of items per page. Valid values are from 1 through 250. If you don’t specify a value, the default size is 25.

Available in: v62.0

showDetails
boolean

Specifies whether to show the channels’ detailed information ( true ) or summary information only ( false ). If you don't specify a value, the default is false .

Available in: v62.0

Responses

Response samples

Content type
application/json
{
  • "channels": {
    },
  • "currentPageUrl": "string",
  • "nextPageUrl": "string",
  • "previousPageUrl": "string",
  • "totalChannels": 0
}

CMS Channels

Create managed content channels.

To get managed content delivery channels, see CMS Delivery Channels.

Available in: v62.0

Request Body schema: application/json

Input body to create a managed content channel.

cacheControlMaxAge
integer <int64>

Cache control max age value in seconds.

Available in: v62.0

domain
string

ID or name of the domain assigned to the public channel.

Available in: v62.0

isCrossApi
boolean

Optional, set to signify that the channel is able to support both 1.0 and 2.0 contents

isDedicatedContentDelivery
boolean

Specifies whether the channel has off-core dedicated content delivery enabled (true) or not (false). Orgs hosted on Hyperforce use off-core dedicated content delivery to deliver content in public channels with high performance and low latency.

Available in: v63.0

isDomainLocked
boolean

Specifies whether the domain is locked and can’t be changed (true) or not (false).

Available in: v62.0

isSearchable
boolean

Specifies whether the text contents of the channel are searchable (true) or not (false).

Available in: v62.0

object (ManagedContentOffCoreLocationInput)

The input representation for creating or updating an offcore location

mediaCacheControlMaxAge
integer <int64>

Media cache control max age value in seconds.

Available in: v62.0

name
required
string

Name of the managed content channel.

Available in: v62.0

targetId
string

ID of the target associated with the managed content channel.

Required for all channel types except PublicUnauthenticated

Available in: v62.0

type
required
string (ConnectManagedContentChannelTypeEnum)
Enum: "CloudToCloud" "Community" "ConnectedApp" "PublicUnauthenticated" "UserPermission"

Type of managed content channel. Values are:

  • CloudToCloud —Cloud-to-Cloud integrated channel.
  • Community —Experience Cloud site channel.
  • ConnectedApp —Channel served by a connected app.
  • PublicUnauthenticated —Public channel. All published content is publicly available.
  • UserPermission —Channel backed by a system permission. All published content is available only to users with the permission.

Available in: v62.0

Responses

Request samples

Content type
application/json
{
  • "name": "New Channel",
  • "targetId": "0DBxx0000004ExEGAU",
  • "type": "Community"
}

Response samples

Content type
application/json
{
  • "cacheControlMaxAge": 0,
  • "channelId": "string",
  • "channelName": "string",
  • "channelType": "CloudToCloud",
  • "domain": "string",
  • "domainId": "string",
  • "domainName": "string",
  • "id": "string",
  • "isChannelSearchable": true,
  • "isDedicatedContentDelivery": true,
  • "isDomainLocked": true,
  • "isSearchable": true,
  • "managedContentChannelDomain": {
    },
  • "mediaCacheControlMaxAge": 0,
  • "name": "string",
  • "targetId": "string",
  • "type": "CloudToCloud"
}

CMS Channel

Get a managed content channel.

To get a managed content delivery channel, see CMS Delivery Channel.

Available in: v62.0

path Parameters
channelId
required
string <Id> ^(0ap)\w*

ID of a channel.

Responses

Response samples

Content type
application/json
{
  • "cacheControlMaxAge": 0,
  • "channelId": "string",
  • "channelName": "string",
  • "channelType": "CloudToCloud",
  • "domain": "string",
  • "domainId": "string",
  • "domainName": "string",
  • "id": "string",
  • "isChannelSearchable": true,
  • "isDedicatedContentDelivery": true,
  • "isDomainLocked": true,
  • "isSearchable": true,
  • "managedContentChannelDomain": {
    },
  • "mediaCacheControlMaxAge": 0,
  • "name": "string",
  • "targetId": "string",
  • "type": "CloudToCloud"
}

CMS Channel

Update a managed content channel.

To get a managed content delivery channel, see CMS Delivery Channel.

Available in: v62.0

path Parameters
channelId
required
string <Id> ^(0ap)\w*

ID of a channel.

Request Body schema: application/json

Input body to update a managed content channel.

cacheControlMaxAge
integer <int64>

Cache control max age value in seconds.

Available in: v62.0

domain
string

ID or name of the domain assigned to the public channel.

Available in: v62.0

isDedicatedContentDelivery
boolean

Specifies whether the channel has off-core dedicated content delivery enabled (true) or not (false). Orgs hosted on Hyperforce use off-core dedicated content delivery to deliver content in public channels with high performance and low latency.

Available in: v63.0

isDomainLocked
boolean

Specifies whether the domain is locked and can’t be changed (true) or not (false).

Available in: v62.0

isSearchable
boolean

Specifies whether the text contents of the channel are searchable (true) or not (false).

Available in: v62.0

object (ManagedContentOffCoreLocationInput)

The input representation for creating or updating an offcore location

mediaCacheControlMaxAge
integer <int64>

Media cache control max age value in seconds.

Available in: v62.0

name
required
string

Name of the managed content channel.

Available in: v62.0

targetId
string

ID of the target associated with the managed content channel.

Required for all channel types except PublicUnauthenticated

Available in: v62.0

Responses

Request samples

Content type
application/json
{
  • "name": "New Channel Name"
}

Response samples

Content type
application/json
{
  • "cacheControlMaxAge": 0,
  • "channelId": "string",
  • "channelName": "string",
  • "channelType": "CloudToCloud",
  • "domain": "string",
  • "domainId": "string",
  • "domainName": "string",
  • "id": "string",
  • "isChannelSearchable": true,
  • "isDedicatedContentDelivery": true,
  • "isDomainLocked": true,
  • "isSearchable": true,
  • "managedContentChannelDomain": {
    },
  • "mediaCacheControlMaxAge": 0,
  • "name": "string",
  • "targetId": "string",
  • "type": "CloudToCloud"
}

CMS Channel

Delete a managed content channel.

To get a managed content delivery channel, see CMS Delivery Channel.

Available in: v62.0

path Parameters
channelId
required
string <Id> ^(0ap)\w*

ID of a channel.

Responses

CMS Channel Search Indexes

Get the latest live and non-live search indexes.

Available in: v54.0

path Parameters
channelId
required
string <Id> ^(0ap)\w*

ID of a channel.

Responses

Response samples

Content type
application/json
{
  • "indexes": [
    ]
}

CMS Channel Search Indexes

Trigger incremental or full search indexing for a channel.

Available in: v54.0

After you index your content, use the Experience Cloud CMS Content Search Resource to search your site.

path Parameters
channelId
required
string <Id> ^(0ap)\w*

ID of a channel.

query Parameters
fallbackToFullIndex
boolean

Specifies whether to perform a full index in cases where incremental indexes aren’t possible ( true ) or not ( false ). If unspecified, defaults to true . This parameter has no effect if isIncremental is unspecified or set to false .

Available in: v59.0

isIncremental
boolean

Specifies whether to update the index only with changes that have happened since the last full index was performed ( true ) or perform a full index ( false ). If unspecified, the default is false .

Available in: v59.0

Responses

Response samples

Content type
application/json
{
  • "completionDate": "2019-08-24T14:15:22Z",
  • "createdDate": "2019-08-24T14:15:22Z",
  • "creationType": "Manual",
  • "id": "string",
  • "indexStatus": "Expired",
  • "message": "string"
}

CMS Contents

Create managed content.

Available in: v54.0

Note: In version 56.0 and later, you can upload binary files to create managed content. To upload a binary file, you must send it in a multipart/form-data request. For information about how to create the multipart/form-data message, see Uploading Binary Files.

Request Body schema:

Managed content.

apiName
string

API name of the managed content.

Available in: v61.0

required
object (ManagedContentBodyInputRep)

Body of the managed content.

Available in: v54.0

contentKey
string

Content key to assign to the managed content. A content key is a universally unique identifier (UUID) such as MCA4CCV5QS2BAB5H7YRCRPTCWGZQ.

Available in: v56.0

contentSpaceOrFolderId
required
string

Content space or folder ID where the content is created.

Available in: v54.0

contentType
required
string

Fully qualified name of the content type to create.

If you’re uploading a binary file using a multipart/form-data message, contentType must be sfdc_cms__image or sfdc_cms__doc.

You can't create a Form using sfdc_cms__form. The sfdc_cms__form content type isn't supported.

Available in: v54.0

externalId
string

External ID of the managed content.

Available in: v58.0

object (ManagedContentExternalSourceInput)

Input representation for a managed content external source

title
required
string

Title of the managed content.

Available in: v54.0

urlName
string

URL name of the managed content within the org.

Available in: v54.0

Responses

Request samples

Content type
Example

Version 60.0 and later

{
  • "contentSpaceOrFolderId": "0Zuxx00000003M5CAI",
  • "title": "Title of Document",
  • "contentType": "sfdc_cms__news",
  • "urlName": "test-url",
  • "contentBody": {
    }
}

Response samples

Content type
application/json
{
  • "apiName": "string",
  • "contentBody": {
    },
  • "contentFqn": "string",
  • "contentKey": "string",
  • "contentSpace": {
    },
  • "contentType": {
    },
  • "contentVersion": 0,
  • "createdBy": {
    },
  • "createdDate": "2019-08-24T14:15:22Z",
  • "externalId": "string",
  • "folder": {
    },
  • "isPublished": true,
  • "language": "string",
  • "lastModifiedBy": {
    },
  • "lastModifiedDate": "2019-08-24T14:15:22Z",
  • "managedContentId": "string",
  • "managedContentVariantId": "string",
  • "managedContentVersionId": "string",
  • "status": {
    },
  • "title": "string",
  • "urlName": "string",
  • "variantVersion": 0,
  • "versionNumber": "string"
}

CMS Contents Publish

Publish content.

Available in: v55.0

Request Body schema: application/json

Managed content publish.

contentIds
Array of strings

IDs of content to publish. All variants of the content are published.

Required if variantIds isn’t specified

Available in: v55.0

contextContentSpaceId
string

ID of the context workspace. If specified, content from other workspaces is published if it is shared to the specified workspace. If unspecified, the context workspace is derived from the content’s origin workspace. All content in the request should belong to the same origin workspace.

Available in: v61.0

description
string

Description for publish action.

Available in: v55.0

includeContentReferences
boolean

Specifies whether to include content references (true) or not (false).

Available in: v57.0

variantIds
Array of strings

IDs of variants to publish. All variants must be from the same content space.

Required if contentIds isn’t specified

Available in: v57.0

Responses

Request samples

Content type
application/json
{
  • "description": "Test Description",
  • "contentIds": [
    ]
}

Response samples

Content type
application/json
{
  • "deploymentId": "string",
  • "description": "string",
  • "publishDate": "2019-08-24T14:15:22Z"
}

CMS Contents Unpublish

Unpublish content.

Available in: v55.0

Request Body schema: application/json

Managed content unpublish.

contentIds
Array of strings

IDs of content to unpublish. All variants of the content are unpublished.

Required if variantIds isn’t specified

Available in: v55.0

contextContentSpaceId
string

ID of the context workspace. If specified, content from other workspaces is unpublished if it is shared to the specified workspace. If unspecified, the context workspace is derived from the content’s origin workspace. All content in the request should belong to the same origin workspace.

Available in: v61.0

description
string

Description for unpublish action.

Available in: v55.0

variantIds
Array of strings

IDs of variants to unpublish. All variants must be from the same content space.

Required if contentIds isn’t specified

Available in: v57.0

Responses

Request samples

Content type
application/json
{
  • "description": "Test Description",
  • "contentIds": [
    ]
}

Response samples

Content type
application/json
{
  • "deploymentId": "string",
  • "description": "string",
  • "unpublishDate": "2019-08-24T14:15:22Z"
}

CMS Contents Variants

Create a managed content variant.

Available in: v58.0

Request Body schema: application/json

Input used to create a managed content variant.

required
object

Body of the managed content variant.

Available in: v58.0

language
required
string

Language of the managed content variant.

Available in: v58.0

managedContentKeyOrId
required
string

Managed content key or ID of the content associated to the variant to be created.

Available in: v58.0

title
string

Title of the managed content variant.

Available in: v58.0

urlName
string

URL name of the managed content variant within the org.

Available in: v58.0

Responses

Request samples

Content type
application/json
{
  • "managedContentKeyorId": "MCWWQJDO2BUZAX7FITHQVAGIASAE",
  • "language": "fr",
  • "title": "French title",
  • "urlName": "my_url_name",
  • "contentBody": {
    }
}

Response samples

Content type
application/json
{
  • "apiName": "string",
  • "contentBody": {
    },
  • "contentFqn": "string",
  • "contentKey": "string",
  • "contentSpace": {
    },
  • "contentType": {
    },
  • "createdBy": {
    },
  • "createdDate": "2019-08-24T14:15:22Z",
  • "externalId": "string",
  • "folder": {
    },
  • "isPublished": true,
  • "language": "string",
  • "lastModifiedBy": {
    },
  • "lastModifiedDate": "2019-08-24T14:15:22Z",
  • "managedContentId": "string",
  • "managedContentVariantId": "string",
  • "managedContentVersionId": "string",
  • "status": {
    },
  • "title": "string",
  • "urlName": "string"
}

CMS Contents Variant

Get a managed content variant.

Available in: v54.0

path Parameters
variantId
required
string <Id> ^(9Ps)\w*

ID of the variant.

Responses

Response samples

Content type
application/json
{
  • "apiName": "string",
  • "contentBody": {
    },
  • "contentFqn": "string",
  • "contentKey": "string",
  • "contentSpace": {
    },
  • "contentType": {
    },
  • "createdBy": {
    },
  • "createdDate": "2019-08-24T14:15:22Z",
  • "externalId": "string",
  • "folder": {
    },
  • "isPublished": true,
  • "language": "string",
  • "lastModifiedBy": {
    },
  • "lastModifiedDate": "2019-08-24T14:15:22Z",
  • "managedContentId": "string",
  • "managedContentVariantId": "string",
  • "managedContentVersionId": "string",
  • "status": {
    },
  • "title": "string",
  • "urlName": "string"
}

CMS Contents Variant

Update a managed content variant.

Available in: v54.0

Note: In version 56.0 and later, you can upload binary files. To upload a binary file, you must send it in a multipart/form-data request. For information about how to create the multipart/form-data message, see Uploading Binary Files.

path Parameters
variantId
required
string <Id> ^(9Ps)\w*

ID of the variant.

Request Body schema: multipart/form-data

Managed content variant update.

contentData
string <binary>
apiName
string

API name of the managed content variant.

Available in: v63.0

contentBody
string

Body of the managed content variant.

Available in: v54.0

title
string

Title of the managed content variant.

Available in: v54.0

urlName
string

URL name of the managed content variant within the org.

Available in: v54.0

Responses

Request samples

Content type
multipart/form-data
Example

Version 60.0 and later

{
  "title": "Title of Document",
  "urlName": "test-url",
  "contentBody": {
    "bannerImage": {
      "source": {
        "type": "imageReference",
        "ref": {
          "contentKey": "MCZOCY2AM5PFBADN5UDRB53TLXR4"
        }
      }
    },
    "excerpt": "this is test excerpt",
    "body": "&lt;p&gt;Test body&lt;/p&gt;"
  }
}

Response samples

Content type
application/json
{
  • "apiName": "string",
  • "contentBody": {
    },
  • "contentFqn": "string",
  • "contentKey": "string",
  • "contentSpace": {
    },
  • "contentType": {
    },
  • "createdBy": {
    },
  • "createdDate": "2019-08-24T14:15:22Z",
  • "externalId": "string",
  • "folder": {
    },
  • "isPublished": true,
  • "language": "string",
  • "lastModifiedBy": {
    },
  • "lastModifiedDate": "2019-08-24T14:15:22Z",
  • "managedContentId": "string",
  • "managedContentVariantId": "string",
  • "managedContentVersionId": "string",
  • "status": {
    },
  • "title": "string",
  • "urlName": "string"
}

CMS Contents Variant

Delete a managed content variant.

Available in: v54.0

path Parameters
variantId
required
string <Id> ^(9Ps)\w*

ID of the variant.

Responses

CMS Content

Get a piece of managed content. In enhanced CMS workspaces, get a version of a piece of managed content.

Available in: v57.0

path Parameters
contentKeyOrId
required
string

A unique identifier or ID of a content.

query Parameters
contentVersion
string

Content version of the managed content.

Available in: v66.0

language
string

Language locale of the managed content, for example, en_US. If you don't specify version or if you specify a version corresponding to the latest version, the document is returned in the fallback language, if available, or in the primary language of the workspace. If you specify a version which isn’t the latest version and isn’t available for the language, an error is returned. If you don’t specify a language, the document is returned in the primary language of the workspace.

Available in: v57.0

variantVersion
string

Variant version of the managed content.

Available in: v66.0

version
string

In non-enhanced workspaces, the 18-character ID of the content version. In enhanced workspaces, the version number ID.

Available in: v57.0

Responses

Response samples

Content type
application/json
{
  • "apiName": "string",
  • "contentBody": {
    },
  • "contentFqn": "string",
  • "contentKey": "string",
  • "contentSpace": {
    },
  • "contentType": {
    },
  • "contentVersion": 0,
  • "createdBy": {
    },
  • "createdDate": "2019-08-24T14:15:22Z",
  • "externalId": "string",
  • "folder": {
    },
  • "isPublished": true,
  • "language": "string",
  • "lastModifiedBy": {
    },
  • "lastModifiedDate": "2019-08-24T14:15:22Z",
  • "managedContentId": "string",
  • "managedContentVariantId": "string",
  • "managedContentVersionId": "string",
  • "status": {
    },
  • "title": "string",
  • "urlName": "string",
  • "variantVersion": 0,
  • "versionNumber": "string"
}

CMS Content Clone

Clone a piece of managed content.

Available in: v61.0

path Parameters
contentKeyOrId
required
string

Content key or ID of the managed content.

Request Body schema: application/json

Managed content clone input.

apiName
string

API name of the cloned content.

Available in: v61.0

contentSpaceOrFolderId
string

ID of the target folder for the cloned content. If unspecified, defaults to the folder of the source content.

Available in: v61.0

includeVariants
boolean

Specifies whether to include variants (true) or not (false) when cloning the content. If unspecified, default is false.

Available in: v61.0

title
string

Title of the cloned content. If unspecified, “clone of” is appended to the source content’s title.

Available in: v61.0

Responses

Request samples

Content type
application/json
{
  • "includeVariants": true,
  • "contentSpaceOrFolderId": "9Puxx0000004M92CAE",
  • "title": "Cloned Content",
  • "apiName": "new_api_name"
}

Response samples

Content type
application/json
{
  • "apiName": "string",
  • "cloneStatus": {
    },
  • "contentKey": "string",
  • "errorMessage": "string",
  • "failedVariants": [
    ],
  • "folder": {
    },
  • "managedContentId": "string",
  • "resourceURL": "string",
  • "sourceContentKeyOrId": "string",
  • "title": "string",
  • "variants": [
    ]
}

CMS Content Taxonomy Terms

Get taxonomy terms that are associated with managed content.

Content admins use this resource to work with taxonomy term associations with CMS managed content. Content taxonomists use Content Taxonomy Resources to create, get, update, delete, and search content taxonomy terms.

Available in: v63.0

path Parameters
contentKeyOrId
required
string

A unique identifier or ID of a content.

Responses

Response samples

Content type
application/json
{
  • "contentKey": "string",
  • "managedContentId": "string",
  • "taxonomyTerms": [
    ]
}

CMS Content Taxonomy Terms

Add or remove taxonomy term associations from managed content.

Content admins use this resource to work with taxonomy term associations with CMS managed content. Content taxonomists use Content Taxonomy Resources to create, get, update, delete, and search content taxonomy terms.

Available in: v63.0

path Parameters
contentKeyOrId
required
string

A unique identifier or ID of a content.

query Parameters
publish
boolean

Specifies whether to publish the taxonomy term associations ( true ) or not ( false ). If unspecified, defaults to false .

If content is published and has no outstanding changes, setting true publishes the taxonomy term association changes. Setting false saves the taxonomy term association changes and those changes are published along with the next content publish.

Available in: v63.0

Request Body schema: application/json

Add or remove taxonomy term associations from managed content.

Available in: v63.0

termsToAdd
Array of strings <Id> [ items <Id > ]

List of IDs of the taxonomy terms to associate with managed content.

Required if termsToRemove isn't specified

Available in: v63.0

termsToRemove
Array of strings <Id> [ items <Id > ]

List of IDs of the taxonomy terms to remove their association with managed content.

Required if termsToAdd isn't specified

Available in: v63.0

Responses

Request samples

Content type
application/json
{
  • "termsToAdd": [
    ],
  • "termsToRemove": [
    ]
}

Response samples

Content type
application/json
{
  • "contentKey": "string",
  • "managedContentId": "string",
  • "taxonomyTerms": [
    ]
}

CMS Delivery Channel

Get a managed content delivery channel.

Available in: v54.0

This resource returns Managed Content Channel Detail in v54.0–61.0.

path Parameters
channelId
required
string <Id> ^(0ap)\w*

ID of a channel.

Responses

Response samples

Content type
application/json
{
  • "domain": "string",
  • "domainName": "string",
  • "id": "string",
  • "isDedicatedContentDelivery": true,
  • "isDomainLocked": true,
  • "isSearchable": true,
  • "name": "string",
  • "type": "CloudToCloud"
}

CMS Delivery Collection

Get collection items for a channel or Experience Cloud site.

Experience Cloud site path

/connect/sites/{siteId}/cms/delivery/collections/{collectionKeyOrId}

Available in: v56.0

path Parameters
channelId
required
string <Id> ^(0ap)\w*

ID of a channel.

collectionKeyOrId
required
string

Collection key or ID of the collection. A collection key is a unique identifier such as MCA4CCV5QS2BAB5H7YRCRPTCWGZQ.

query Parameters
language
string

Language locale for the managed content, for example, en_US. If you don’t specify a language or if the requested translation isn’t available, the language defaults to the channel or site’s default language. If the channel or site’s default language isn’t available, the language defaults to the primary language of the content space.

Available in: v56.0

pageSize
integer

Number of items per page. Valid values are from 1 through 250. If you don't specify a value, the default size is 50.

Available in: v63.0

pageToken
integer

Integer specifying a page token of items. If you don't specify a value, the default value is 0, which returns the first page token.

Available in: v63.0

Responses

Response samples

Content type
application/json
{
  • "channelSummary": {
    },
  • "collectionKey": "string",
  • "collectionType": {
    },
  • "currentPageUrl": "string",
  • "id": "string",
  • "items": [
    ],
  • "language": "string",
  • "nextPageUrl": "string",
  • "previousPageUrl": "string",
  • "publishedDate": "2019-08-24T14:15:22Z",
  • "title": "string",
  • "total": 0,
  • "urlName": "string",
  • "channelInfo": {
    }
}

CMS Delivery Contents

Get a collection of published contents for a channel or Experience Cloud site.

Experience Cloud site path

/connect/sites/{siteId}/cms/delivery/contents

Available in: v55.0

path Parameters
channelId
required
string <Id> ^(0ap)\w*

ID of a channel.

query Parameters
contentKeys
Array of strings

Comma-separated list of up to 50 content keys. Specify either managed content IDs or content keys.

Available in: v55.0

contentTypeFQN
string

Fully qualified name of the managed content type.

Available in: v55.0

expandReferences
boolean

Specifies whether to include details of references ( true ) or summaries of references ( false ) in the response body. If unspecified, the default value is false .

Available in: v55.0

includeContentBody
boolean

Specifies whether to return the content body (true) or the content summary (false). If unspecified, the default value is false.

Available in: v55.0

language
string

Language locale for the managed content, for example, en_US. If the requested translation isn’t available, the language defaults to the configured fallback language or the channel’s default language. If the content isn’t available in the fallback language and the channel’s default language, we return an error.

Available in: v55.0

managedContentIds
Array of strings

Comma-separated list of up to 100 managed content IDs. Specify either managed content IDs or content keys.

Available in: v55.0

page
integer

Number of the page you want returned. Starts at 0. If you don’t specify a value or if you specify 0, the first page is returned.

Available in: v55.0

pageSize
integer

Specifies the number of items per page. Valid values are from 1 through 250. If unspecified, the default size is 25. If you specify true for expandReferences or includeContentBody , the maximum page size you can specify is 25.

Available in: v55.0

publishEndDate
string

ISO 8601 formatted publish end date.

Available in: v55.0

publishStartDate
string

ISO 8601 formatted publish start date.

Available in: v55.0

referenceDepth
integer

An integer 0–3 specifying the depth of references. If you specify 0, the references property of the Managed Content Delivery Document Collection response body is null. If unspecified, the default value is 0.

Available in: v55.0

referencesAsList
boolean

Specifies whether to return the references as a list in the referencesList property of the Managed Content Delivery Document Collection response body ( true ). If you specify false , the references are returned as key value pairs in the references property. If unspecified, the default value is false .

Available in: v55.0

showAbsoluteUrl
boolean

Specifies whether to show absolute URLs in the response body (true) or not (false). If you don’t specify a value, the default is false.

Available in: v58.0

Responses

Response samples

Content type
application/json
{
  • "channelSummary": {
    },
  • "contents": {
    },
  • "currentPageUrl": "string",
  • "nextPageUrl": "string",
  • "previousPageUrl": "string",
  • "references": {
    },
  • "referencesList": {
    },
  • "channelInfo": {
    }
}

CMS Delivery Channel Contents Search

Search for content in a channel or an Experience Cloud site.

Experience Cloud site path

/connect/sites/{siteId}/cms/delivery/contents/enhanced-search

Available in: v64.0

path Parameters
channelId
required
string <Id> ^(0ap)\w*

ID of a channel.

Request Body schema: application/json

Search managed content in a channel.

object (ManagedContentDeliverySearchFiltersInputRequest)

Filters used to search managed content.

Available in: v64.0

page
integer

Number of the page you want returned. Starts at 0. If you don't specify a value or if you specify 0, the first page is returned.

Available in: v64.0

pageSize
integer

Number of items per page. Valid values are from 1 to 250. If you don't specify a value, the default is 25.

Available in: v64.0

queryTerm
required
string

Query term used as key word to search managed content.

Available in: v64.0

Responses

Request samples

Content type
application/json
{
  • "queryTerm": "BMW",
  • "filters": {
    },
  • "page": 1,
  • "pageSize": 10
}

Response samples

Content type
application/json
{
  • "count": 0,
  • "isNextPageAvailable": true,
  • "items": [
    ]
}

CMS Delivery Content

Get a piece of published content for a channel or Experience Cloud site.

Experience Cloud site path

/connect/sites/{siteId}/cms/delivery/contents/{contentKeyOrId}

Available in: v54.0

path Parameters
channelId
required
string <Id> ^(0ap)\w*

ID of a channel.

contentKeyOrId
required
string

Content key or ID of the managed content.

query Parameters
contentVersion
integer
expandReferences
boolean

Specifies whether to include details of references ( true ) or summaries of references ( false ) in the response body. If unspecified, the default value is false .

Available in: v54.0

language
string

Language locale for the managed content, for example, en_US. To get content for a channel in the specified language, that language must be added to the channel. If you don’t specify a language or if the requested translation isn’t available, the language defaults to the channel or site’s default language. If the channel or site’s default language isn’t available, the language defaults to the primary language of the content space.

Available in: v54.0

referenceDepth
integer

An integer 0–3 specifying the depth of references. If you specify 0, the references property of the Managed Content Delivery Document response body is null. If unspecified, the default value is 0.

Available in: v54.0

referencesAsList
boolean

Specifies whether to return the references as a list in the referencesList property of the Managed Content Delivery Document response body ( true ). If you specify false , the references are returned as key value pairs in the references property. If unspecified, the default value is false .

Available in: v54.0

showAbsoluteUrl
boolean

For public channels only, specifies whether to return the absolute unauthenticatedUrl in the response body. If you don’t specify a value, the default is false.

Available in: v54.0

Responses

Response samples

Content type
application/json
{
  • "channelInfo": {
    },
  • "channelSummary": {
    },
  • "contentBody": {
    },
  • "contentKey": "string",
  • "contentType": {
    },
  • "contentVersion": 0,
  • "isLatest": true,
  • "language": "string",
  • "managedContentId": "string",
  • "publishedDate": "2019-08-24T14:15:22Z",
  • "references": {
    },
  • "referencesList": {
    },
  • "resourceUrl": "string",
  • "title": "string",
  • "unauthenticatedUrl": "string",
  • "urlName": "string"
}

CMS Digital Asset Management Providers

Get digital asset management (DAM) providers.

Available in: v65.0

query Parameters
contentSpaceId
string

ID of the managed content space.

Available in: v66.0

Responses

Response samples

Content type
application/json
{
  • "contentSpaceId": "string",
  • "currentPageUrl": "string",
  • "nextPageUrl": "string",
  • "providers": [
    ],
  • "total": 0
}

CMS Digital Asset Management Providers

Create a DAM provider instance.

Available in: v65.0

Request Body schema: application/json

Create or update a managed content provider instance.

instanceKey
string

Provider instance key.

Required for POST. At least one property is required for PATCH

Available in: v65.0

isDefault
boolean

Specifies whether the instance is the default instance ( true ) or not ( false ).

Required for POST. At least one property is required for PATCH.

Available in: v65.0

name
string

Name of the provider instance.

Required for POST. At least one property is required for PATCH.

Available in: v65.0

providerLightningComponentId
string <Id>

ID of the provider lightning component.

Required for POST. This property isn’t supported for PATCH.

Available in: v65.0

Responses

Request samples

Content type
application/json

Creating a managed content provider instance

{
  • "instanceKey": "https://xxxxxx.com",
  • "isDefault": "true",
  • "name": "Bynder-Brand-1",
  • "providerLightningComponentId": "106xxxxxxxxxxx"
}

Response samples

Content type
application/json
{
  • "instanceKey": "string",
  • "isDefault": true,
  • "isEnabledForSpace": true,
  • "name": "string",
  • "providerInstanceId": "string"
}

CMS Digital Asset Management Provider

Update a digital asset management (DAM) provider instance.

Available in: v66.0

path Parameters
providerInstanceId
required
string <Id> ^(1QX)\w*

ID of the provider instance.

Request Body schema: application/json

Create or update a managed content provider instance.

instanceKey
string

Provider instance key.

Required for POST. At least one property is required for PATCH

Available in: v65.0

isDefault
boolean

Specifies whether the instance is the default instance ( true ) or not ( false ).

Required for POST. At least one property is required for PATCH.

Available in: v65.0

name
string

Name of the provider instance.

Required for POST. At least one property is required for PATCH.

Available in: v65.0

providerLightningComponentId
string <Id>

ID of the provider lightning component.

Required for POST. This property isn’t supported for PATCH.

Available in: v65.0

Responses

Request samples

Content type
application/json
Example

Creating a managed content provider instance

{
  • "instanceKey": "https://xxxxxx.com",
  • "isDefault": "true",
  • "name": "Bynder-Brand-1",
  • "providerLightningComponentId": "106xxxxxxxxxxx"
}

Response samples

Content type
application/json
{
  • "instanceKey": "string",
  • "isDefault": true,
  • "isEnabledForSpace": true,
  • "name": "string",
  • "providerInstanceId": "string"
}

CMS Digital Asset Management Provider

Delete a digital asset management (DAM) provider instance.

Available in: v65.0

Note: You can’t delete a DAM provider instance that’s in use. Delete managed content that’s associated with a DAM provider instance before deleting the instance.

path Parameters
providerInstanceId
required
string <Id> ^(1QX)\w*

ID of the provider instance.

Responses

CMS Folder Share Targets

Get targets that a managed content space folder can be shared with.

To get targets that a managed content space folder is shared with, use CMS Folder Shares.

Available in: v63.0

path Parameters
folderId
required
string <Id> ^(9Pu)\w*

ID of the folder.

Responses

Response samples

Content type
application/json
{
  • "shareTargets": [
    ]
}

CMS Folder Shares

Get the targets that a managed content space folder is shared with.

Workspaces are the only supported sharing targets. To get targets that a managed content space folder can be shared with, use CMS Folder Share Targets.

Available in: v63.0

path Parameters
folderId
required
string <Id> ^(9Pu)\w*

ID of the folder.

Responses

Response samples

Content type
application/json
{
  • "folderId": "string",
  • "shares": [
    ]
}

CMS Folder Shares

Update the targets that a managed content space folder is shared with.

Workspaces are the only supported sharing targets. To get targets that a managed content space folder can be shared with, use CMS Folder Share Targets.

Available in: v63.0

path Parameters
folderId
required
string <Id> ^(9Pu)\w*

ID of the folder.

Request Body schema: application/json

Update the targets that a managed content space folder is shared with.

Array of objects (MCSFolderShareInput)

List of target IDs to share the managed content space folder with.

Supported target IDs are the root folder IDs of workspaces. To get the root folder ID of a space, use the CMS Space resource.

Required if unshareWith isn’t specified

Available in: v63.0

unshareWith
Array of strings

Comma-separated list of target IDs to unshare the managed content space folder with.

Required if shareWith isn’t specified

Available in: v63.0

Responses

Request samples

Content type
application/json
{
  • "shareWith": [
    ],
  • "unshareWith": [
    ]
}

Response samples

Content type
application/json
{
  • "folderId": "string",
  • "shares": [
    ]
}

CMS Search

Search for managed content items, including variants, in spaces and folders.

Available in: v57.0

query Parameters
contentSpaceOrFolderIds
required
Array of strings <Id> [ items <Id > ]

IDs of managed content spaces (key prefix 0Zu) and folders (key prefix 9Pu) in which to search. In version 57.0, exactly one space is required and one folder in that space is allowed.

Available in: v57.0

contentTypeFQN
string

Fully qualified name of the content type used to restrict the search.

Available in: v57.0

languages
Array of strings

List of up to 10 languages or All to search for all languages. Specify each language as a language only, such as en , or as a language and locale, such as en_US . Search returns only exact matches and only languages that are supported by the workspace. If unspecified, the workspace default language is used.

In version 57.0, search returns all languages by default. In version 58.0 and later, use languages=All to get all the languages.

Available in: v58.0

page
integer

Number of the page you want returned. Starts at 0. If you don’t specify a value or if you specify 0, the first page is returned.

Available in: v57.0

pageSize
integer

Specifies the number of items per page. Valid values are from 1 through 250. If you don’t specify a value, the default size is 25.

Available in: v57.0

queryTerm
required
string

List of up to 50 space separated search terms. The search terms must contain at least two characters that aren’t wildcards .

Available in: v57.0

scope
string (ConnectManagedContentSearchScopeEnum)
Enum: "All" "TitleOnly"

Text search scope for items.

If unspecified, defaults to All .

If you specify a folder ID, you can’t restrict the search scope.

Available in: v57.0

Responses

Response samples

Content type
application/json
{
  • "count": 0,
  • "currentPageUri": "string",
  • "items": {
    },
  • "nextPageUri": "string"
}

CMS Spaces

Get managed content spaces.

Available in: v64.0

query Parameters
nameFragment
string

Name fragment to filter spaces that contain the value in the workspace name.

Available in: v64.0

page
integer

Number of the page you want returned. Starts at 0. If you don’t specify a value or if you specify 0, the first page is returned.

Available in: v64.0

pageSize
integer

Specifies the number of items per page. Valid values are from 1 through 250. If you don't specify a value, the default size is 25.

Available in: v64.0

Responses

Response samples

Content type
application/json
{
  • "spaces": [
    ]
}

CMS Spaces

Create a managed content space.

Available in: v64.0

Request Body schema: application/json

Create a managed content space.

apiName
string

API name of the managed content space.

Available in: v64.0

defaultLanguage
string

Default language of the managed content space.

Available in: v64.0

description
string

Description of the managed content space.

Available in: v64.0

name
required
string

Name of the managed content space.

Available in: v64.0

spaceType
string (ConnectManagedContentSpaceTypeEnum)
Enum: "App_Dev" "Content" "Enablement" "Experience" "ExperienceContainer" "Fragment_Space" "Gen_AI" "Library" "Marketing" "SalesEngagement"

Type of managed content space.

Available in: v64.0

Responses

Request samples

Content type
application/json
{
  • "name": "ShoeStoreWorkspace",
  • "description": "To serve shoe store content.",
  • "defaultLanguage": "en_US",
  • "spacetype": "Content",
  • "apiName": "shoe_store_workspace"
}

Response samples

Content type
application/json
{
  • "apiName": "string",
  • "createdBy": "string",
  • "createdDate": "2019-08-24T14:15:22Z",
  • "defaultLanguage": "string",
  • "description": "string",
  • "fullyQualifiedName": "string",
  • "id": "string",
  • "isEnhancedSpace": true,
  • "isFlowOrchestrationEnabled": true,
  • "lastModifiedBy": "string",
  • "lastModifiedDate": "2019-08-24T14:15:22Z",
  • "name": "string",
  • "rootFolderId": "string",
  • "spaceType": {
    }
}

CMS Space

Get a managed content space.

Available in: v55.0

path Parameters
contentSpaceId
required
string <Id> ^(0Zu)\w*

ID of the content space.

Responses

Response samples

Content type
application/json
{
  • "apiName": "string",
  • "createdBy": "string",
  • "createdDate": "2019-08-24T14:15:22Z",
  • "defaultLanguage": "string",
  • "description": "string",
  • "fullyQualifiedName": "string",
  • "id": "string",
  • "isEnhancedSpace": true,
  • "isFlowOrchestrationEnabled": true,
  • "lastModifiedBy": "string",
  • "lastModifiedDate": "2019-08-24T14:15:22Z",
  • "name": "string",
  • "rootFolderId": "string",
  • "spaceType": {
    }
}

CMS Space

Update a managed content space.

Available in: v64.0

path Parameters
contentSpaceId
required
string <Id> ^(0Zu)\w*

ID of the content space.

Request Body schema: application/json

Update the name or description of a managed content space.

description
string

Description of the managed content space.

Available in: v64.0

name
string

Name of the managed content space.

Available in: v64.0

Responses

Request samples

Content type
application/json
{
  • "name": "ShoeStoreWorkspaceUpdated",
  • "description": "To serve shoe store content. Updated."
}

Response samples

Content type
application/json
{
  • "apiName": "string",
  • "createdBy": "string",
  • "createdDate": "2019-08-24T14:15:22Z",
  • "defaultLanguage": "string",
  • "description": "string",
  • "fullyQualifiedName": "string",
  • "id": "string",
  • "isEnhancedSpace": true,
  • "isFlowOrchestrationEnabled": true,
  • "lastModifiedBy": "string",
  • "lastModifiedDate": "2019-08-24T14:15:22Z",
  • "name": "string",
  • "rootFolderId": "string",
  • "spaceType": {
    }
}

CMS Space Channels

Get channels for a managed content space.

Available in: v62.0

path Parameters
contentSpaceId
required
string <Id> ^(0Zu)\w*

ID of the content space.

query Parameters
page
integer

Number of the page you want returned. Starts at 0. If you don’t specify a value or if you specify 0, the first page is returned.

Available in: v62.0

pageSize
integer

Number of items per page. Valid values are from 1 through 250. If you don't specify a value, the default size is 25.

Available in: v62.0

Responses

Response samples

Content type
application/json
{
  • "currentPageUrl": "string",
  • "nextPageUrl": "string",
  • "previousPageUrl": "string",
  • "spaceChannels": [
    ],
  • "totalSpaceChannels": 0
}

CMS Space Channels

Add or remove channels from a managed content space.

Available in: v62.0

path Parameters
contentSpaceId
required
string <Id> ^(0Zu)\w*

ID of the content space.

Request Body schema: application/json

Channels to add or remove from a managed content space.

required
Array of objects (ManagedContentSpaceChannelInput)

List of channels to add or remove from the managed content space.

Available in: v62.0

Responses

Request samples

Content type
application/json
{
  • "spaceChannels": [
    ]
}

Response samples

Content type
application/json
{
  • "currentPageUrl": "string",
  • "nextPageUrl": "string",
  • "previousPageUrl": "string",
  • "spaceChannels": [
    ],
  • "totalSpaceChannels": 0
}

Experience Cloud CMS Content Search Resources

Experience Cloud CMS Content Search

Search an Experience Cloud site.

This resource is available only for sites with Enhanced CMS Workspaces. Make sure your content is indexed with the CMS Channel Search Indexes resource before searching your site.

Available in: v54.0

path Parameters
siteId
required
string <Id> ^(0DM)\w*

ID of an Experience Cloud site.

query Parameters
language
string

Language locale for the context user. If unspecified or if the specified language locale isn’t available, the default value is en_US.

Available in: v54.0

pageSize
integer

Specifies the number of items per page. Valid values are from 1 through 240. If unspecified, defaults to 25.

Available in: v54.0

pageToken
string

Specifies the base64 encoded page token. Page tokens are returned as part of the response. If unspecified, the first page is returned.

Available in: v54.0

queryTerm
required
string

White-space separated words used to search for relevant content. Provide a maximum of 1024 characters, composed of up to 32 words and white spaces. Logical operators aren’t supported.

Available in: v54.0

Responses

Response samples

Content type
application/json
{
  • "currentPageToken": "string",
  • "currentPageUrl": "string",
  • "items": [
    ],
  • "language": "string",
  • "nextPageToken": "string",
  • "nextPageUrl": "string",
  • "pageSize": 0,
  • "previousPageToken": "string",
  • "previousPageUrl": "string",
  • "totalItems": 0
}

DID THIS ARTICLE SOLVE YOUR ISSUE?
Let us know so we can improve!