All Reference

Experience Cloud Connect REST API

API docs by Redocly
All Reference

Experience Cloud Connect REST API

Experience Cloud 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.

Experience Cloud Microsites Resources

Get, save, and submit marketing integration forms for an Experience Cloud site.

Experience Cloud Microsites resources make calls to the Marketing Cloud Engagement REST API to create, query, and insert data to the data extension object. If the API returns errors, Connect REST API error messages include the error code and message from Marketing Cloud Engagement.

Microsites Marketing Integration Forms

Save a marketing integration form for an Experience Cloud site.

This API attempts to create a read-only data extension in Marketing Cloud Engagement. A Marketing Cloud Engagement admin can change the read-only setting. We recommend keeping the data extension as read-only to maintain schema consistency with the form.

Available in: v53.0

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

ID of an Experience Cloud site.

Request Body schema: application/json

Marketing integration form.

required
Array of objects (FormFieldInput)

Fields for the marketing integration form.

Available in: v53.0

formName
required
string

Name of the marketing integration form.

Available in: v53.0

memberIdentificationCode
required
string

The member identification code (MID) of the Marketing Cloud Engagement account associated with the form.

Available in: v53.0

Responses

Request samples

Content type
application/json
{
  • "formFieldsList": {
    },
  • "formName": "Contact Us Data",
  • "memberIdentificationCode": "marketing-account-id"
}

Response samples

Content type
application/json
{
  • "dataExtensionId": "string",
  • "formFieldsList": {
    },
  • "formId": "string",
  • "formName": "string"
}

Microsites Marketing Integration Form

Get a marketing integration form for an Experience Cloud site.

Available in: v53.0

path Parameters
formId
required
string <Id> ^(8Cm)\w*

ID of the form.

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

ID of an Experience Cloud site.

Responses

Response samples

Content type
application/json
{
  • "dataExtensionId": "string",
  • "formFieldsList": {
    },
  • "formId": "string",
  • "formName": "string"
}

Microsites Marketing Integration Form Data

Submit a marketing integration form for an Experience Cloud site.

Available in: v53.0

path Parameters
formId
required
string <Id> ^(8Cm)\w*

ID of the form.

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

ID of an Experience Cloud site.

Request Body schema: application/json

Marketing integration form submission.

required
Array of objects (FormSubmissionFieldInput)

Fields for the marketing integration form.

Available in: v53.0

Responses

Request samples

Content type
application/json
{
  • "formFieldsList": {
    }
}

Response samples

Content type
application/json
{
  • "formSubmissionId": "string"
}

Experience Cloud Sites Knowledge Resources

Get trending articles for an Experience Cloud site. Get trending and top-viewed articles for a topic in an Experience Cloud site. Increase article view counts.

Experience Cloud Site Trending Articles for a Topic

Get trending articles for a topic in an Experience Cloud site.

Available in: v36.0

path Parameters
communityId
required
string <CommunityId>

ID of an Experience Cloud site.

topicId
required
string <Id> ^(0TO)\w*

ID of the topic.

query Parameters
maxResults
integer

The maximum number of articles returned. Values can be from 0 to 25. Default is 5.

Available in: v36.0

Responses

Response samples

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

Experience Cloud Site Trending Articles

Get trending articles for an Experience Cloud site.

Available in: v36.0

path Parameters
communityId
required
string <CommunityId>

ID of an Experience Cloud site.

query Parameters
maxResults
integer

The maximum number of articles returned. Values can be from 0 to 25. Default is 5.

Available in: v36.0

Responses

Response samples

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

Experience Cloud Sites Moderation Resources

Get information about whether a user has flagged a file as inappropriate. Delete flags on files. Get audit statistics for a user in an Experience Cloud site.

Experience Cloud Sites Moderation User Audit Statistics

Get audit statistics for a user in an Experience Cloud site.

Available in: v40.0

path Parameters
communityId
required
string <CommunityId>

ID of an Experience Cloud site.

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

ID of the user.

Responses

Response samples

Content type
application/json
{
  • "auditActionToCount": {
    }
}

Flagged Files

Files that are flagged.

Available in: v36.0

Note: In version 30.0–35.0, use /connect/communities/{communityId}/chatter/files/moderation.

path Parameters
communityId
required
string <CommunityId>

ID of an Experience Cloud site.

query Parameters
page
integer

Specifies the number of the page you want returned.

Available in: v30.0

pageSize
integer

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

Available in: v30.0

q
string

A query string to filter the results. The string must contain at least two characters, not including wildcards. For information about wildcards, see Wildcards.

Available in: v33.0

Responses

Response samples

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

Moderation Flags on Files

If the context user is a moderator, get the number of times members flagged a file.

If the context user isn’t a moderator, get whether the user flagged a file. Also flag a file for moderation and remove a flag the user previously added.

Available in: v36.0

Note: In versions 30.0–35.0, use /connect/communities/{communityId}/chatter/files/{fileId}/moderation-flags.

path Parameters
communityId
required
string <CommunityId>

ID of an Experience Cloud site.

fileId
required
string <Id> ^(069)\w*

ID of a file.

query Parameters
page
string

Specifies the page token to use to view a page of information. Page tokens are returned as part of the response class, such as currentPageToken or nextPageToken. If you pass in null, the first page is returned.

Available in: v40.0

pageSize
integer

Specifies the number of items per page. Valid values are from 1 through 100. The default size is 0.

Available in: v40.0

visibility
string (ConnectNetworkModerationVisibilityEnum)
Enum: "ModeratorsOnly" "SelfAndModerators"

Visibility behavior of a flag for various user types.

  • ModeratorsOnly — The flag is visible only to users with moderation permissions on the flagged element or item.
  • SelfAndModerators — The flag is visible to the creator of the flag and to users with moderation permissions on the flagged element or item.

Available in: v30.0

Responses

Response samples

Content type
application/json
{
  • "flagCount": 0,
  • "flagCountByReason": {
    },
  • "flaggedByMe": true,
  • "flags": {
    }
}

Moderation Flags on Files

If the context user is or isn’t a moderator, flag a file for moderation.

Available in: v36.0

Note: In versions 30.0–35.0, use /connect/communities/{communityId}/chatter/files/{fileId}/moderation-flags.

path Parameters
communityId
required
string <CommunityId>

ID of an Experience Cloud site.

fileId
required
string <Id> ^(069)\w*

ID of a file.

query Parameters
note
string

A note of up to 4,000 characters about the flag.

Available in: v38.0

type
string (ConnectNetworkModerationTypeEnum)
Enum: "FlagAsInappropriate" "FlagAsSpam"

Type of moderation flag.

  • FlagAsInappropriate — Flag for inappropriate content.
  • FlagAsSpam — Flag for spam.

If not specified, FlagAsInappropriate is the default value.

Available in: v38.0

visibility
string (ConnectNetworkModerationVisibilityEnum)
Enum: "ModeratorsOnly" "SelfAndModerators"

Visibility behavior of a flag for various user types.

  • ModeratorsOnly — The flag is visible only to users with moderation permissions on the flagged element or item.
  • SelfAndModerators — The flag is visible to the creator of the flag and to users with moderation permissions on the flagged element or item.

Available in: v30.0

Request Body schema: application/json

Moderation flag input.

Available in: v38.0

note
string

A note of up to 4,000 characters about the flag.

Available in: v38.0

type
string (ConnectNetworkModerationTypeEnum)
Enum: "FlagAsInappropriate" "FlagAsSpam"

Type of moderation flag.

  • FlagAsInappropriate — Flag for inappropriate content.
  • FlagAsSpam — Flag for spam.

Available in: v38.0

visibility
string (ConnectNetworkModerationVisibilityEnum)
Enum: "ModeratorsOnly" "SelfAndModerators"

Visibility behavior of a flag for various user types.

  • ModeratorsOnly — The flag is visible only to users with moderation permissions on the flagged element or item.
  • SelfAndModerators — The flag is visible to the creator of the flag and to users with moderation permissions on the flagged element or item.

Available in: v30.0

Responses

Request samples

Content type
application/json
{
  • "note": "Flagged by moderator as spam on 6.6.16.",
  • "type": "FlagAsSpam",
  • "visibility": "ModeratorsOnly"
}

Response samples

Content type
application/json
{
  • "flagCount": 0,
  • "flagCountByReason": {
    },
  • "flaggedByMe": true,
  • "flags": {
    }
}

Moderation Flags on Files

Delete all flags on a file.

Available in: v36.0

Note: In versions 30.0–35.0, use /connect/communities/{communityId}/chatter/files/{fileId}/moderation-flags.

path Parameters
communityId
required
string <CommunityId>

ID of an Experience Cloud site.

fileId
required
string <Id> ^(069)\w*

ID of a file.

query Parameters
userId
string

The ID of the context user. If specified, removes the flag the user previously added to the file. If not specified and the context user is a moderator, removes all flags on the file.

Available in: v30.0

Responses

Experience Cloud Sites Personalization Resources

Get a list of assigned audiences that match the user context. Get audience information for a batch of audience IDs. Create, get, update, and delete an audience. Get a list of targets that match the user context, based on the assigned audiences that include the user. Create and update targets. Get target information for a batch of target IDs. Get and delete a target.

Note: Personalization varies what the user can see in the browser but doesn’t secure data in any way. To prevent users accessing sensitive data, use standard Salesforce security features, such as sharing rules and permission sets.

Personalization Audiences

Get a list of assigned audiences that match the user context.

Available in: v47.0

path Parameters
communityId
required
string <CommunityId>

ID of an Experience Cloud site.

query Parameters
domain
string

Name of the user’s Salesforce custom domain. If not specified, no audiences with domain criteria are returned.

Available in: v47.0

includeAudienceCriteria
boolean

Specifies whether to include audience criteria (true) or not (false). If unspecified, defaults to false.

Available in: v47.0

ipAddress
string

IP address of the user. If not specified, no audiences with location criteria are returned.

Available in: v47.0

publishStatus
string (ConnectPublishStatusEnum)
Enum: "Draft" "Live"

Publish status of the audience.

If not specified, the default is Live.

Available in: v47.0

recordId
string

ID of the record for field based criteria. If not specified, all applicable audiences with field based criteria are returned.

Available in: v51.0

targetTypes
Array of strings

Comma-separated list of target types to filter the results. Supported values include:

  • ExperienceVariation (version 47.0 and later)
  • Custom object API names, such as {CustomObjectName}__c (version 47.0 and later)
  • NavigationLinkSet (version 49.0 and later)
  • Topic (version 49.0 and later)
  • CollaborationGroup (version 49.0 and later)
  • KnowledgeArticle (version 49.0 and later)
  • ContentDocument (version 49.0 and later)
  • ManagedContent (version 49.0 and later)
  • Report (version 49.0 and later)
  • Dashboard (version 49.0 and later)

If not specified, all target types are returned.

Available in: v47.0

userId
string

ID of the user. If not specified, the default is the ID of the context user.

Available in: v47.0

Responses

Response samples

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

Personalization Audiences

Create an audience.

Available in: v47.0

path Parameters
communityId
required
string <CommunityId>

ID of an Experience Cloud site.

Request Body schema: application/json

An audience.

Array of objects (AudienceCriterionInput)

List of audience criteria to update or add. An audience can have up to 100 criteria.

Required when creating an audience. Optional when updating an audience

Available in: v47.0

customFormula
string

Custom formula for the audience criteria. For example, (1 AND 2) OR 3.

Required when creating an audience with the formulaFilterType set to CustomLogicMatches. Optional, otherwise

Available in: v47.0

formulaFilterType
string (FormulaFilterTypeEnum)
Enum: "AllCriteriaMatch" "AnyCriterionMatches" "CustomLogicMatches"

Formula filter type for the personalization audience. Values are:

  • AllCriteriaMatch — All audience criteria are true (AND operation).
  • AnyCriterionMatches — Any audience criterion is true (OR operation).
  • CustomLogicMatches — Audience criteria match the custom formula (for example, (1 AND 2) OR 3).

Required when creating an audience. Optional when updating an audience

Available in: v47.0

name
string

Name of the audience.

Required when creating an audience. Optional when updating an audience

Available in: v47.0

Responses

Request samples

Content type
application/json
{
  • "criteria": [
    ],
  • "customFormula": "string",
  • "formulaFilterType": "AllCriteriaMatch",
  • "name": "string"
}

Response samples

Content type
application/json
{
  • "criteria": [
    ],
  • "customFormula": "string",
  • "formulaFilterType": "AllCriteriaMatch",
  • "id": "string",
  • "name": "string",
  • "targets": [
    ],
  • "url": "string"
}

Personalization Audiences, Batch

Get audience information for a comma-separated list of audience IDs.

Available in: v48.0

path Parameters
audienceIds
required
Array of strings <Id> [ items <Id > ]

Comma-separated list of audience IDs.

communityId
required
string <CommunityId>

ID of an Experience Cloud site.

Responses

Response samples

Content type
application/json
{
  • "hasErrors": true,
  • "results": [
    ]
}

Personalization Audience

Get an audience.

Available in: v47.0

path Parameters
audienceId
required
string <Id> ^(6Au)\w*

ID of the audience.

communityId
required
string <CommunityId>

ID of an Experience Cloud site.

query Parameters
includeAudienceCriteria
boolean

Specifies whether to include audience criteria (true) or not (false). If unspecified, defaults to false.

Available in: v47.0

Responses

Response samples

Content type
application/json
{
  • "criteria": [
    ],
  • "customFormula": "string",
  • "formulaFilterType": "AllCriteriaMatch",
  • "id": "string",
  • "name": "string",
  • "targets": [
    ],
  • "url": "string"
}

Personalization Audience

Update an audience.

Available in: v47.0

path Parameters
audienceId
required
string <Id> ^(6Au)\w*

ID of the audience.

communityId
required
string <CommunityId>

ID of an Experience Cloud site.

Request Body schema: application/json

An audience.

Array of objects (AudienceCriterionInput)

List of audience criteria to update or add. An audience can have up to 100 criteria.

Required when creating an audience. Optional when updating an audience

Available in: v47.0

customFormula
string

Custom formula for the audience criteria. For example, (1 AND 2) OR 3.

Required when creating an audience with the formulaFilterType set to CustomLogicMatches. Optional, otherwise

Available in: v47.0

formulaFilterType
string (FormulaFilterTypeEnum)
Enum: "AllCriteriaMatch" "AnyCriterionMatches" "CustomLogicMatches"

Formula filter type for the personalization audience. Values are:

  • AllCriteriaMatch — All audience criteria are true (AND operation).
  • AnyCriterionMatches — Any audience criterion is true (OR operation).
  • CustomLogicMatches — Audience criteria match the custom formula (for example, (1 AND 2) OR 3).

Required when creating an audience. Optional when updating an audience

Available in: v47.0

name
string

Name of the audience.

Required when creating an audience. Optional when updating an audience

Available in: v47.0

Responses

Request samples

Content type
application/json
{
  • "criteria": [
    ],
  • "customFormula": "string",
  • "formulaFilterType": "AllCriteriaMatch",
  • "name": "string"
}

Response samples

Content type
application/json
{
  • "criteria": [
    ],
  • "customFormula": "string",
  • "formulaFilterType": "AllCriteriaMatch",
  • "id": "string",
  • "name": "string",
  • "targets": [
    ],
  • "url": "string"
}

Personalization Audience

Delete an audience.

Available in: v47.0

path Parameters
audienceId
required
string <Id> ^(6Au)\w*

ID of the audience.

communityId
required
string <CommunityId>

ID of an Experience Cloud site.

Responses

Personalization Targets

Get a list of targets that match the user context, based on the assigned audiences that include the user.

Available in: v47.0

path Parameters
communityId
required
string <CommunityId>

ID of an Experience Cloud site.

query Parameters
domain
string

Name of the user’s Salesforce custom domain. If not specified, no audience targets with domain criteria are returned.

Available in: v47.0

groupNames
Array of strings

A comma-separated list of group names. Groups bundle related target and audience pairs. If you’re specifying group names, you must also specify a single targetTypes value.

Available in: v48.0

includeAllMatchingTargetsWithinGroup
boolean

Specifies whether to include all the matching targets within a target group ( true ) or not ( false ). If not specified, the default is false. If false, the first matching target within each group, based on priority within the group, is returned.

Available in: v47.0

includeAudience
boolean

Specifies whether to include the matching audience ( true ) or not ( false ). If not specified, the default is false.

Available in: v47.0

ipAddress
string

IP address of the user. If not specified, no audience targets with location criteria are returned.

Available in: v47.0

publishStatus
string (ConnectPublishStatusEnum)
Enum: "Draft" "Live"

Publish status of the target.

If not specified, the default is Live.

Available in: v47.0

recordId
string

ID of the record, if you want to specify field based criteria in audiences.

Available in: v47.0

targetTypes
Array of strings

Comma-separated list of target types to filter the results. Supported values include:

  • ExperienceVariation (version 47.0 and later)
  • Custom object API names, such as {CustomObjectName}__c (version 47.0 and later)
  • NavigationLinkSet (version 49.0 and later)
  • Topic (version 49.0 and later)
  • CollaborationGroup (version 49.0 and later)
  • KnowledgeArticle (version 49.0 and later)
  • ContentDocument (version 49.0 and later)
  • ManagedContent (version 49.0 and later)
  • Report (version 49.0 and later)
  • Dashboard (version 49.0 and later)

If not specified, all target types are returned.

Required if specifying groupNames ; otherwise optional

Available in: v47.0

userId
string

ID of the user. If not specified, the default is the ID of the context user.

Available in: v47.0

Responses

Response samples

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

Personalization Targets

Create targets.

Available in: v47.0

path Parameters
communityId
required
string <CommunityId>

ID of an Experience Cloud site.

Request Body schema: application/json
required
Array of objects (TargetInput)

List of targets to create.

Available in: v47.0

Responses

Request samples

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

Response samples

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

Personalization Targets

Update targets.

Available in: v47.0

path Parameters
communityId
required
string <CommunityId>

ID of an Experience Cloud site.

Request Body schema: application/json
required
Array of objects (TargetUpdateInput)

List of targets to update.

Available in: v47.0

Responses

Request samples

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

Response samples

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

Personalization Targets, Batch

Get target information for a comma-separated list of target IDs.

Available in: v47.0

path Parameters
communityId
required
string <CommunityId>

ID of an Experience Cloud site.

targetIds
required
Array of strings <Id> [ items <Id > ]

Comma-separated list of target IDs.

Responses

Response samples

Content type
application/json
{
  • "hasErrors": true,
  • "results": [
    ]
}

Personalization Target

Get a target.

Available in: v47.0

path Parameters
communityId
required
string <CommunityId>

ID of an Experience Cloud site.

targetId
required
string <Id> ^(6At)\w*

ID of the target.

Responses

Response samples

Content type
application/json
{
  • "audience": {
    },
  • "formulaScope": {
    },
  • "groupName": "string",
  • "id": "string",
  • "priority": 0,
  • "publishStatus": "Draft",
  • "targetType": "string",
  • "targetValue": "string",
  • "url": "string",
  • "scope": [
    ]
}

Personalization Target

Delete a target.

Available in: v47.0

path Parameters
communityId
required
string <CommunityId>

ID of an Experience Cloud site.

targetId
required
string <Id> ^(6At)\w*

ID of the target.

Responses

Experience Cloud Sites Resources

Get information about Experience Cloud sites, create a site, and publish a site. Get the Experience Builder templates available to the context user. Get externally managed accounts for sites.

Experience Cloud Sites List

Get a list of all Experience Cloud sites available to the context user.

Available in: v28.0

query Parameters
status
string (ConnectNetworkStatusEnum)
Enum: "Inactive" "Live" "UnderConstruction"

Returns only sites with the specified status.

Only users with the Manage Experiences permission can see sites with an Inactive status.

Available in: v28.0

Responses

Response samples

Content type
application/json
{
  • "communities": [
    ],
  • "total": 0
}

Experience Cloud Sites List

Create an Experience Cloud site.

Available in: v46.0

Request Body schema: application/json
description
string

Description of the site.

Available in: v46.0

name
required
string

Name of the site.

Available in: v46.0

templateName
required
string

Name of the Experience Builder template for the site.

Use the Experience Builder Templates resource to get a list of available templates and their names.

Available in: v46.0

object

Map of template-specific parameters. Valid values are:

  • " AuthenticationType " : " AUTHENTICATED "
  • " AuthenticationType " : " UNAUTHENTICATED " (version 52.0–55.0)
  • " AuthenticationType " : " AUTHENTICATED_WITH_PUBLIC_ACCESS "
  • " CreateStoreDefaults " : " ALL "
  • " CreateStoreDefaults " : " NONE "
  • " WebstoreId " : " {WebstoreId} "

AuthenticationType values are valid when creating an Experience Cloud site using the Build Your Own (LWR) template.

CreateStoreDefaults values are valid when creating an Experience Cloud site using the B2B or D2C store template.

The WebstoreId value is valid when creating an Experience Cloud site using the B2B Aura, B2B LWR, and D2C templates. The store can't already be associated to a site, and the store type field must match the template. The B2B store type can be used with the B2B Aura and B2B LWR templates, and the D2C store type can be used with the D2C template.

Available in: v52.0

urlPathPrefix
string

URL prefix for the site. For example, in the site URL {MyDomainName}.my.site.com/customers, customers is the urlPathPrefix.

Required if you already have a site that doesn't have a urlPathPrefix.

Available in: v46.0

Responses

Request samples

Content type
application/json
{
  • "name": "The Capricorn Cafe",
  • "urlPathPrefix": "capricorncafe",
  • "templateName": "B2B Commerce Template",
  • "templateParams": {
    },
  • "description": "Coffee and coffee products for the most discerning tastes."
}

Response samples

Content type
application/json
{
  • "jobId": "string",
  • "message": "string",
  • "name": "string"
}

Experience Builder Templates

Get the Experience Builder templates available to the context user.

Available in: v46.0

Responses

Response samples

Content type
application/json
{
  • "templates": [
    ],
  • "total": 0
}

Experience Cloud Site

Get information about an Experience Cloud site.

Available in: v26.0

path Parameters
communityId
required
string <CommunityId>

ID of an Experience Cloud site.

Responses

Response samples

Content type
application/json
{
  • "allowChatterAccessWithoutLogin": true,
  • "allowMembersToFlag": true,
  • "builderBasedSnaEnabled": true,
  • "builderUrl": "string",
  • "contentSpaceId": "string",
  • "description": "string",
  • "guestMemberVisibilityEnabled": true,
  • "id": "string",
  • "imageOptimizationCDNEnabled": true,
  • "invitationsEnabled": true,
  • "knowledgeableEnabled": true,
  • "loginUrl": "string",
  • "memberVisibilityEnabled": true,
  • "name": "string",
  • "nicknameDisplayEnabled": true,
  • "privateMessagesEnabled": true,
  • "reputationEnabled": true,
  • "sendWelcomeEmail": true,
  • "siteAsContainerEnabled": true,
  • "siteUrl": "string",
  • "status": "Inactive",
  • "templateName": "string",
  • "url": "string",
  • "urlPathPrefix": "string"
}

Experience Cloud Site Preview URL

Get a preview URL for an Experience Cloud site page.

Available in: v61.0

path Parameters
communityId
required
string <CommunityId>

ID of an Experience Cloud site.

pageApiName
required
string

The {pageApiName} is the API name of a page, such as Product_Detail or Home.

query Parameters
urlParameters
string

URL-encoded string of key-value pairs, such as recordName%3Example-record-name%26recordId%3D01txx0000006i7IAAQ.

Optional unless required by the page URL

Available in: v61.0

Responses

Response samples

Content type
application/json
{
  • "previewUrl": "string"
}

Experience Cloud Site, Publish

Publish an Experience Cloud site.

Available in: v46.0

Note: POST doesn’t take request parameters or a request body.

path Parameters
communityId
required
string <CommunityId>

ID of an Experience Cloud site.

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "jobId": "string",
  • "message": "string",
  • "name": "string",
  • "url": "string"
}

Experience Cloud Sites Externally Managed Accounts

Get externally managed accounts available to the context user across all Experience Cloud sites.

Available in: v50.0

path Parameters
communityId
required
string <CommunityId>

ID of an Experience Cloud site.

Regardless of the ID specified, this resource returns all the externally managed accounts available to the context user across all sites.

query Parameters
includeMyAccount
boolean

Specifies whether to return the context user’s account (true) or not (false). The default value is false.

Available in: v53.0

Responses

Response samples

Content type
application/json
{
  • "externalManagedAccounts": [
    ],
  • "totalExternalManagedAccounts": 0
}

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