Publish API endpoint

Calling the Publish API creates a publishing operation for entities retrieved by the selected identifiers. If you provide ids instead, they will be converted to their corresponding identifiers.

RequestResponse
POST https://<CONTENT_HUB_INSTANCE>/api/publish/entities

Example request

RequestResponse
POST https://<CONTENT_HUB_INSTANCE>/api/publish/entities
{
    "identifiers": [
       "Content.FruitfulCocktails",
       "Content.HealthIsHappiness"
   ],
   "skipNotification": true
}

You can also use:

RequestResponse
POST https://<contenthub-instance>/api/publish/entities
{
     "ids": [
          30033,
          30034
     ],
   "skipNotification": true
}

Body parameters

Name

Type

Description

Mandatory

identifiers

String

Names or labels used to uniquely identify entities.

No

ids

String

Numerical values used to uniquely identify entities.

No

skipNotification

Boolean

If this is true, the request immediately updates the publishing status of entities, without refreshing the page. The recommended value is true, but if not specified, this value defaults to false.

No

Choose either id or identifier for your API call, but don't use them simultaneously. If you have numerous identifiers to publish, it's best to split them into batches. We recommend sending batches of no more than 1000 identifiers per request.

Do you have some feedback for us?

If you have suggestions for improving this article,