--- title: "Unpublish In-Page Experience" method: POST path: "/accounts/{{account_id}}/experiences/{experience_id}/actions/unpublish" tags: ["Experiences"] --- # Unpublish In-Page Experience `POST /accounts/{{account_id}}/experiences/{experience_id}/actions/unpublish` Takes the specified In-Page Experience offline. If this In-Page Experience is embedded anywhere, it will be replaced with text notifying the end user that it is offline. This will initiate an unpublish, you can poll the GET endpoint for fetching the In-Page Experience to check its published status to see when unpublishing completes ## Response `200` SUCCESS - Experience — In-Page Experience document - `id` string — ID of the In-Page Experience - `accountId` number — Video Cloud account ID - `name` string, required — Name of the In-Page Experience - `description` string — Description for the In-Page Experience - `inactive` boolean — Whether the In-Page Experience is offline (inactive) - `height` number — Fixed height of the In-Page Experience (null for responsive height) - `width` number — Fixed width of the In-Page Experience (null for responsive width) - `template` string, required — ID of the template - `templateVersion` string — Version of the template - `locale` 'en_US' | 'es_ES' | 'fr_FR' | 'ja_JP' | 'ko_KO' | 'zh_HK' | 'zh_TW' — The locale of the In-Page Experience - `videos` ExperienceVideos — Properties defining the videos in the In-Page Experience and behavior related to videos - `type` 'manual' | 'playlist' — How videos are defined - `videoIds` string[] — IDs of videos which are included in the In-Page Experience when type is set to manual. For Video Cloud videos this is just the numeric ID. For YouTube videos, a prefix of `youtube:` must be added to the ID. - `playlistId` string — ID of the playlist to pull videos from when type is set to playlist - `showRelatedLinks` boolean — Whether related links for videos should be displayed - `useLongDescriptions` boolean — Whether to display the long description of a video (if it exists) while it is being watched - `allowDownloads` 'none' | 'all' | 'custom-field' — Criteria for displaying a download link for videos. `none` disables downloads, `all` enables downloads for all videos which have an mp4 source, and `custom-field` will enable downloads for videos which have a matching custom field. YouTube videos cannot be downloaded. - `downloadCustomField` string — Custom field to check whether to display a download link for videos when `allowDownloads` is set to `custom-field` - `downloadCustomFieldValue` string — Custom field value to check whether to display a download link for videos when `allowDownloads` is set to `custom-field` - `watchedIndicator` boolean — Whether to show an indicator that a video has been watched on its thumbnail after it has finished playing - `player` ExperiencePlayer — Properties defining the player and its behavior - `id` string — ID of the player to use - `autoAdvance` boolean — Whether to automatically advance to the next video when the current one finishes playing - `autoAdvanceTime` number — Number of seconds to wait before advancing to the next video when autoAdvance is true - `playsInline` boolean — Whether the video plays inline on iOS devices - `endBehavior` 'after' | 'during' — Whether the In-Page Experience advances to the After Play state (after), or stays on the Playing state (during) after the current video finishes playing - `playbackApiBaseUrl` string — Base URL for fetching video information from the [Playback API](https://apis.support.brightcove.com/playback/). For IP restricted accounts this should be set to https://edge-elb.api.brightcove.com/playback/v1, otherwise this should be null - `policyKey` string — Policy key for fetching video information from the [Playback API](https://apis.support.brightcove.com/playback/). - `youtubeKey` string — Auto-generated key for fetching YouTube video information from Gallery. - `assets` ExperienceAssets — Assets used by the In-Page Experience - `customCss` string — Inline custom CSS - `customCssUrl` string — External custom CSS URL - `customJavaScript` string — Inline custom JavaScript - `customJavaScriptUrl` string — External custom JavaScript URL - `headerAdCode` string — Global advertising code which gets inlined into the `` of the page - `fonts` FontBase[] — Fonts which are included in the In-Page Experience - `name` string, required — Font name - `css` string, required — CSS required to import the font - `social` ExperienceSocial — Properties describing social sharing behavior - `display` 'button' | 'icons' — How social sharing should be displayed - `deepLinkParameter` string — Query-string parameter used for deep-linking to a specific video in the In-Page Experience when it is shared - `sharingOptions` ExperienceSharingOptions — Platform-specific sharing options - `facebook` ExperienceSharingOption - `enabled` boolean — Whether sharing is enabled for the specified platform - `useCustomMessage` boolean — Whether custom messaging should be enabled for the specified platform (if the platform supports it) - `customMessage` string — Custom message to use for the specified platform if `useCustomMessage` is `true` - `googlePlus` ExperienceSharingOption - `enabled` boolean — Whether sharing is enabled for the specified platform - `useCustomMessage` boolean — Whether custom messaging should be enabled for the specified platform (if the platform supports it) - `customMessage` string — Custom message to use for the specified platform if `useCustomMessage` is `true` - `linkedIn` ExperienceSharingOption - `enabled` boolean — Whether sharing is enabled for the specified platform - `useCustomMessage` boolean — Whether custom messaging should be enabled for the specified platform (if the platform supports it) - `customMessage` string — Custom message to use for the specified platform if `useCustomMessage` is `true` - `pinterest` ExperienceSharingOption - `enabled` boolean — Whether sharing is enabled for the specified platform - `useCustomMessage` boolean — Whether custom messaging should be enabled for the specified platform (if the platform supports it) - `customMessage` string — Custom message to use for the specified platform if `useCustomMessage` is `true` - `twitter` ExperienceSharingOption - `enabled` boolean — Whether sharing is enabled for the specified platform - `useCustomMessage` boolean — Whether custom messaging should be enabled for the specified platform (if the platform supports it) - `customMessage` string — Custom message to use for the specified platform if `useCustomMessage` is `true` - `email` ExperienceSharingOption - `enabled` boolean — Whether sharing is enabled for the specified platform - `useCustomMessage` boolean — Whether custom messaging should be enabled for the specified platform (if the platform supports it) - `customMessage` string — Custom message to use for the specified platform if `useCustomMessage` is `true` - `styles` Styles — Style overrides - `global` Style - `anchor` Style - `navigation` Style - `videoInfo` Style - `videoTitle` Style - `videoDescription` Style - `overlay` Style - `overlayTitle` Style - `overlayDescription` Style - `overlayBanner` Style - `nowPlaying` Style - `playButton` Style - `sharing` Style - `overlaySharing` Style - `eventCountdown` Style - `calendarReminder` Style - `layouts` ExperienceLayouts — Collection of layout options for the In-Page Experience. The keys for this can be found in the template layouts metadata - `content` ExperienceContent — Experience content - `top` ExperienceComponent[] — Components which are displayed on top of the In-Page Experience - `id` string — ID of the component (auto-generated) - `name` string — Name of the component, used for analytics - `views` string[], required — Views that this component will be visible during - `type` 'text' | 'image' | 'advertisement' | 'chat' | 'heroImage' | 'html' | 'threePlay' | 'twitter' — Type of component - `value` union — Value of the component. This is dependent on the value of `type`. `image` and `heroImage` have extended properties, whereas the other component types simply take a string value. `text`, `advertisement`, `chat`, `html`, and `twitter` all take an HTML string, while `threePlay` takes the 3Play project ID - ExperienceComponentImageValue — Image component value - `image` string — URL of the image - `display` 'responsive' | 'fixed' — How the image will be sized - `alignment` 'left' | 'center' | 'right' — How the image will be horizontally aligned - `width` number — Width of the image when `display` is `fixed` - `height` number — Height of the image when `display` is `fixed` - `clickThroughUrl` string — URL to navigate to when the image is clicked - `openNewWindow` boolean — Whether to open the `clickThroughUrl` in a new window - ExperienceComponentHeroImageValue — Hero image component value - `image` string — URL of the image - `size` 'cover' | 'contain' | 'stretch' | 'none' — How the image will be sized within the hero image container. `cover` will crop the image, `contain` will contain the image within the bounds of the container, `stretch` will stretch the image to fill the container ignoring aspect ratio, and `none` will use the original image size - string - `left` ExperienceComponent[] — Components which are displayed to the left of the In-Page Experience - `id` string — ID of the component (auto-generated) - `name` string — Name of the component, used for analytics - `views` string[], required — Views that this component will be visible during - `type` 'text' | 'image' | 'advertisement' | 'chat' | 'heroImage' | 'html' | 'threePlay' | 'twitter' — Type of component - `value` union — Value of the component. This is dependent on the value of `type`. `image` and `heroImage` have extended properties, whereas the other component types simply take a string value. `text`, `advertisement`, `chat`, `html`, and `twitter` all take an HTML string, while `threePlay` takes the 3Play project ID - ExperienceComponentImageValue — Image component value - `image` string — URL of the image - `display` 'responsive' | 'fixed' — How the image will be sized - `alignment` 'left' | 'center' | 'right' — How the image will be horizontally aligned - `width` number — Width of the image when `display` is `fixed` - `height` number — Height of the image when `display` is `fixed` - `clickThroughUrl` string — URL to navigate to when the image is clicked - `openNewWindow` boolean — Whether to open the `clickThroughUrl` in a new window - ExperienceComponentHeroImageValue — Hero image component value - `image` string — URL of the image - `size` 'cover' | 'contain' | 'stretch' | 'none' — How the image will be sized within the hero image container. `cover` will crop the image, `contain` will contain the image within the bounds of the container, `stretch` will stretch the image to fill the container ignoring aspect ratio, and `none` will use the original image size - string - `right` ExperienceComponent[] — Components which are displayed to the right of the In-Page Experience - `id` string — ID of the component (auto-generated) - `name` string — Name of the component, used for analytics - `views` string[], required — Views that this component will be visible during - `type` 'text' | 'image' | 'advertisement' | 'chat' | 'heroImage' | 'html' | 'threePlay' | 'twitter' — Type of component - `value` union — Value of the component. This is dependent on the value of `type`. `image` and `heroImage` have extended properties, whereas the other component types simply take a string value. `text`, `advertisement`, `chat`, `html`, and `twitter` all take an HTML string, while `threePlay` takes the 3Play project ID - ExperienceComponentImageValue — Image component value - `image` string — URL of the image - `display` 'responsive' | 'fixed' — How the image will be sized - `alignment` 'left' | 'center' | 'right' — How the image will be horizontally aligned - `width` number — Width of the image when `display` is `fixed` - `height` number — Height of the image when `display` is `fixed` - `clickThroughUrl` string — URL to navigate to when the image is clicked - `openNewWindow` boolean — Whether to open the `clickThroughUrl` in a new window - ExperienceComponentHeroImageValue — Hero image component value - `image` string — URL of the image - `size` 'cover' | 'contain' | 'stretch' | 'none' — How the image will be sized within the hero image container. `cover` will crop the image, `contain` will contain the image within the bounds of the container, `stretch` will stretch the image to fill the container ignoring aspect ratio, and `none` will use the original image size - string - `bottom` ExperienceComponent[] — Components which are displayed below the In-Page Experience - `id` string — ID of the component (auto-generated) - `name` string — Name of the component, used for analytics - `views` string[], required — Views that this component will be visible during - `type` 'text' | 'image' | 'advertisement' | 'chat' | 'heroImage' | 'html' | 'threePlay' | 'twitter' — Type of component - `value` union — Value of the component. This is dependent on the value of `type`. `image` and `heroImage` have extended properties, whereas the other component types simply take a string value. `text`, `advertisement`, `chat`, `html`, and `twitter` all take an HTML string, while `threePlay` takes the 3Play project ID - ExperienceComponentImageValue — Image component value - `image` string — URL of the image - `display` 'responsive' | 'fixed' — How the image will be sized - `alignment` 'left' | 'center' | 'right' — How the image will be horizontally aligned - `width` number — Width of the image when `display` is `fixed` - `height` number — Height of the image when `display` is `fixed` - `clickThroughUrl` string — URL to navigate to when the image is clicked - `openNewWindow` boolean — Whether to open the `clickThroughUrl` in a new window - ExperienceComponentHeroImageValue — Hero image component value - `image` string — URL of the image - `size` 'cover' | 'contain' | 'stretch' | 'none' — How the image will be sized within the hero image container. `cover` will crop the image, `contain` will contain the image within the bounds of the container, `stretch` will stretch the image to fill the container ignoring aspect ratio, and `none` will use the original image size - string - `main` ExperienceComponent[] — Live event hero image (only applies to the ee-live-event template) - `id` string — ID of the component (auto-generated) - `name` string — Name of the component, used for analytics - `views` string[], required — Views that this component will be visible during - `type` 'text' | 'image' | 'advertisement' | 'chat' | 'heroImage' | 'html' | 'threePlay' | 'twitter' — Type of component - `value` union — Value of the component. This is dependent on the value of `type`. `image` and `heroImage` have extended properties, whereas the other component types simply take a string value. `text`, `advertisement`, `chat`, `html`, and `twitter` all take an HTML string, while `threePlay` takes the 3Play project ID - ExperienceComponentImageValue — Image component value - `image` string — URL of the image - `display` 'responsive' | 'fixed' — How the image will be sized - `alignment` 'left' | 'center' | 'right' — How the image will be horizontally aligned - `width` number — Width of the image when `display` is `fixed` - `height` number — Height of the image when `display` is `fixed` - `clickThroughUrl` string — URL to navigate to when the image is clicked - `openNewWindow` boolean — Whether to open the `clickThroughUrl` in a new window - ExperienceComponentHeroImageValue — Hero image component value - `image` string — URL of the image - `size` 'cover' | 'contain' | 'stretch' | 'none' — How the image will be sized within the hero image container. `cover` will crop the image, `contain` will contain the image within the bounds of the container, `stretch` will stretch the image to fill the container ignoring aspect ratio, and `none` will use the original image size - string - `preEventDetails` ExperienceComponent[] — Live event pre-event details text (only applies to the ee-live-event template) - `id` string — ID of the component (auto-generated) - `name` string — Name of the component, used for analytics - `views` string[], required — Views that this component will be visible during - `type` 'text' | 'image' | 'advertisement' | 'chat' | 'heroImage' | 'html' | 'threePlay' | 'twitter' — Type of component - `value` union — Value of the component. This is dependent on the value of `type`. `image` and `heroImage` have extended properties, whereas the other component types simply take a string value. `text`, `advertisement`, `chat`, `html`, and `twitter` all take an HTML string, while `threePlay` takes the 3Play project ID - ExperienceComponentImageValue — Image component value - `image` string — URL of the image - `display` 'responsive' | 'fixed' — How the image will be sized - `alignment` 'left' | 'center' | 'right' — How the image will be horizontally aligned - `width` number — Width of the image when `display` is `fixed` - `height` number — Height of the image when `display` is `fixed` - `clickThroughUrl` string — URL to navigate to when the image is clicked - `openNewWindow` boolean — Whether to open the `clickThroughUrl` in a new window - ExperienceComponentHeroImageValue — Hero image component value - `image` string — URL of the image - `size` 'cover' | 'contain' | 'stretch' | 'none' — How the image will be sized within the hero image container. `cover` will crop the image, `contain` will contain the image within the bounds of the container, `stretch` will stretch the image to fill the container ignoring aspect ratio, and `none` will use the original image size - string - `postEventDetails` ExperienceComponent[] — Live event post-event details text (only applies to the ee-live-event template) - `id` string — ID of the component (auto-generated) - `name` string — Name of the component, used for analytics - `views` string[], required — Views that this component will be visible during - `type` 'text' | 'image' | 'advertisement' | 'chat' | 'heroImage' | 'html' | 'threePlay' | 'twitter' — Type of component - `value` union — Value of the component. This is dependent on the value of `type`. `image` and `heroImage` have extended properties, whereas the other component types simply take a string value. `text`, `advertisement`, `chat`, `html`, and `twitter` all take an HTML string, while `threePlay` takes the 3Play project ID - ExperienceComponentImageValue — Image component value - `image` string — URL of the image - `display` 'responsive' | 'fixed' — How the image will be sized - `alignment` 'left' | 'center' | 'right' — How the image will be horizontally aligned - `width` number — Width of the image when `display` is `fixed` - `height` number — Height of the image when `display` is `fixed` - `clickThroughUrl` string — URL to navigate to when the image is clicked - `openNewWindow` boolean — Whether to open the `clickThroughUrl` in a new window - ExperienceComponentHeroImageValue — Hero image component value - `image` string — URL of the image - `size` 'cover' | 'contain' | 'stretch' | 'none' — How the image will be sized within the hero image container. `cover` will crop the image, `contain` will contain the image within the bounds of the container, `stretch` will stretch the image to fill the container ignoring aspect ratio, and `none` will use the original image size - string - `analytics` ExperienceAnalytics — Analytics settings - `googleAnalyticsId` string — Google Analytics project ID for sending events to Google Analytics - `event` ExperienceEvent — Live event information (only available for the ee-live-event template) - `showCountdown` boolean — Whether to show the event countdown - `showAddToCalendar` boolean — Whether to show the Add to Calendar button - `startTime` string — Event start time as an ISO-8601 string - `endTime` string — Event end time as an ISO-8601 string - `timezone` string — Timezone of the event - `title` string — Event title used in the calendar event - `description` string — Event description used in the calendar event - `location` string — Event location used in the calendar event - `transitionMessage` string — Message to use in the countdown after the time remaining has reached 0 - `social` ExperienceEventSocial - `display` 'button' | 'icon' — How to display event sharing - `title` string — Title of the event used when it is shared - `description` string — Description of the event used when it is shared - `image` string — URL to an image which is used when the event is shared - `sharingOptions` ExperienceSharingOptions — Platform-specific sharing options - `facebook` ExperienceSharingOption - `enabled` boolean — Whether sharing is enabled for the specified platform - `useCustomMessage` boolean — Whether custom messaging should be enabled for the specified platform (if the platform supports it) - `customMessage` string — Custom message to use for the specified platform if `useCustomMessage` is `true` - `googlePlus` ExperienceSharingOption - `enabled` boolean — Whether sharing is enabled for the specified platform - `useCustomMessage` boolean — Whether custom messaging should be enabled for the specified platform (if the platform supports it) - `customMessage` string — Custom message to use for the specified platform if `useCustomMessage` is `true` - `linkedIn` ExperienceSharingOption - `enabled` boolean — Whether sharing is enabled for the specified platform - `useCustomMessage` boolean — Whether custom messaging should be enabled for the specified platform (if the platform supports it) - `customMessage` string — Custom message to use for the specified platform if `useCustomMessage` is `true` - `pinterest` ExperienceSharingOption - `enabled` boolean — Whether sharing is enabled for the specified platform - `useCustomMessage` boolean — Whether custom messaging should be enabled for the specified platform (if the platform supports it) - `customMessage` string — Custom message to use for the specified platform if `useCustomMessage` is `true` - `twitter` ExperienceSharingOption - `enabled` boolean — Whether sharing is enabled for the specified platform - `useCustomMessage` boolean — Whether custom messaging should be enabled for the specified platform (if the platform supports it) - `customMessage` string — Custom message to use for the specified platform if `useCustomMessage` is `true` - `email` ExperienceSharingOption - `enabled` boolean — Whether sharing is enabled for the specified platform - `useCustomMessage` boolean — Whether custom messaging should be enabled for the specified platform (if the platform supports it) - `customMessage` string — Custom message to use for the specified platform if `useCustomMessage` is `true` - `configurations` ExperienceConfigurations — Experience configurations - `preEvent` ExperienceConfiguration — Experience configuration - `videos` ExperienceVideos — Properties defining the videos in the In-Page Experience and behavior related to videos - `type` 'manual' | 'playlist' — How videos are defined - `videoIds` string[] — IDs of videos which are included in the In-Page Experience when type is set to manual. For Video Cloud videos this is just the numeric ID. For YouTube videos, a prefix of `youtube:` must be added to the ID. - `playlistId` string — ID of the playlist to pull videos from when type is set to playlist - `showRelatedLinks` boolean — Whether related links for videos should be displayed - `useLongDescriptions` boolean — Whether to display the long description of a video (if it exists) while it is being watched - `allowDownloads` 'none' | 'all' | 'custom-field' — Criteria for displaying a download link for videos. `none` disables downloads, `all` enables downloads for all videos which have an mp4 source, and `custom-field` will enable downloads for videos which have a matching custom field. YouTube videos cannot be downloaded. - `downloadCustomField` string — Custom field to check whether to display a download link for videos when `allowDownloads` is set to `custom-field` - `downloadCustomFieldValue` string — Custom field value to check whether to display a download link for videos when `allowDownloads` is set to `custom-field` - `watchedIndicator` boolean — Whether to show an indicator that a video has been watched on its thumbnail after it has finished playing - `live` ExperienceConfiguration — Experience configuration - `videos` ExperienceVideos — Properties defining the videos in the In-Page Experience and behavior related to videos - `type` 'manual' | 'playlist' — How videos are defined - `videoIds` string[] — IDs of videos which are included in the In-Page Experience when type is set to manual. For Video Cloud videos this is just the numeric ID. For YouTube videos, a prefix of `youtube:` must be added to the ID. - `playlistId` string — ID of the playlist to pull videos from when type is set to playlist - `showRelatedLinks` boolean — Whether related links for videos should be displayed - `useLongDescriptions` boolean — Whether to display the long description of a video (if it exists) while it is being watched - `allowDownloads` 'none' | 'all' | 'custom-field' — Criteria for displaying a download link for videos. `none` disables downloads, `all` enables downloads for all videos which have an mp4 source, and `custom-field` will enable downloads for videos which have a matching custom field. YouTube videos cannot be downloaded. - `downloadCustomField` string — Custom field to check whether to display a download link for videos when `allowDownloads` is set to `custom-field` - `downloadCustomFieldValue` string — Custom field value to check whether to display a download link for videos when `allowDownloads` is set to `custom-field` - `watchedIndicator` boolean — Whether to show an indicator that a video has been watched on its thumbnail after it has finished playing - `postEvent` ExperienceConfiguration — Experience configuration - `videos` ExperienceVideos — Properties defining the videos in the In-Page Experience and behavior related to videos - `type` 'manual' | 'playlist' — How videos are defined - `videoIds` string[] — IDs of videos which are included in the In-Page Experience when type is set to manual. For Video Cloud videos this is just the numeric ID. For YouTube videos, a prefix of `youtube:` must be added to the ID. - `playlistId` string — ID of the playlist to pull videos from when type is set to playlist - `showRelatedLinks` boolean — Whether related links for videos should be displayed - `useLongDescriptions` boolean — Whether to display the long description of a video (if it exists) while it is being watched - `allowDownloads` 'none' | 'all' | 'custom-field' — Criteria for displaying a download link for videos. `none` disables downloads, `all` enables downloads for all videos which have an mp4 source, and `custom-field` will enable downloads for videos which have a matching custom field. YouTube videos cannot be downloaded. - `downloadCustomField` string — Custom field to check whether to display a download link for videos when `allowDownloads` is set to `custom-field` - `downloadCustomFieldValue` string — Custom field value to check whether to display a download link for videos when `allowDownloads` is set to `custom-field` - `watchedIndicator` boolean — Whether to show an indicator that a video has been watched on its thumbnail after it has finished playing - `publishAttemptedAt` string — ISO-8601 date when the last publish was attempted - `publishedAt` string — ISO-8601 date when the last successful publish happened - `publishFailedAt` string — ISO-8601 date when the last failed publish happened - `updatedAt` string — ISO-8601 date when the In-Page Experience was last updated - `createdAt` string — ISO-8601 date when the In-Page Experience was created - `publishedUrl` string — URL to the published In-Page Experience. `null` if the Experience has never been published - `previewUrl` string — URL for previewing the In-Page Experience. This URL is valid for 24 hours and is re-generated for each request to the API - `theme` string — ID of the theme to use for styling this In-Page Experience. Can also be `light` or `dark` to use the built-in light and dark themes - `hasChanges` boolean — Whether the In-Page Experience has been modified since the last time it was published - `publishedStatus` 'unpublished' | 'success' | 'publishing' | 'unpublishing' | 'inactive' | 'failed' — The current published status of the In-Page Experience ## Other responses - `401` — UNAUTHORIZED: Authentication failed - check to make sure your client credentials were correct for the access token - `404` — NOT_FOUND: The specified In-Page Experience does not exist --- [API](https://skmtc.net/brightcovelearning/apis/brightcove-in-page-experiences-api-reference.md) · [All operations](https://skmtc.net/brightcovelearning/apis/brightcove-in-page-experiences-api-reference/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/brightcovelearning/brightcove-in-page-experiences-api-reference/revisions/4ba1a5bb9017/schema)