Publish one or more documents

Immediately publishes or schedules publication of up to 10 unpublished Library documents within the specified teamsite. Each document in the content array is identified by its library content id. The endpoint always publishes the latest version of each document, transitioning its status from Draft to Published.

To schedule a future publish, supply a publishAt value in YYYY-MM-DD HH:MM AM|PM or YYYY-MM-DD format. All times are processed in UTC. When publishAt is omitted, the documents are published immediately.

Set IsSendNotification to true to notify subscribers when the content is published.

📘

Where do documents get published?

Documents are published to the profiles with Dynamic Folders that automatically detect the content based on the content's metadata and content properties. This endpoint does not currently support a parameter to publish to specific profiles.
To create a dynamic folder from within your tenant:

  1. Navigate to Profile Builder
  2. Select the teamsite from the dropdown list
  3. Click on the profile
  4. Click on the + sign on the top right side - add dynamic folder(if this folder does not exist)
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

Identifier of the teamsite context for the request. Depending on API behavior, it may be a GUID-formatted value or a documented special value such as 1.

Body Params

JSON object containing the list of documents to publish, an optional scheduled publish date, an optional comment, and a notification flag.

Request body for publishing one or more Library documents. Supports immediate publishing or scheduled publishing with an optional notification flag.

string

An optional comment to associate with the publish action, visible in content history.

string

Optional scheduled publish date. Accepts either YYYY-MM-DD HH:MM AM|PM (date with time) or YYYY-MM-DD (date only). All times are processed in UTC. Omit to publish immediately.

boolean
Defaults to true

Whether to send a notification to subscribers when the content is published. Defaults to true when omitted, matching the backend PublishRequest.IsSendNotification default. Set to false to publish silently without notifying subscribers.

content
array of objects
length between 1 and 10

An array of content items to publish. Each item must include a valid library content id. The documented maximum of 10 items per request applies to immediate (unscheduled) publishing; when publishAt is supplied for scheduled publishing the backend accepts up to 50 items. The array is required and must contain at least one item.

content

A reference to a single library content item to publish.

string

The unique identifier of the library content item to publish.

Responses

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json