Skip to content

Publisher API Endpoints

{
  "status": "readyToPublish",
  "message": "Client metadata publish is readyToPublish"
}
{
  "status": "inProgress",
  "message": "Client metadata publish is inProgress"
}
{
  "status": "completed",
  "message": "Client metadata publish is completed"
}
{
  "status": "failed",
  "message": "Client failed but ready to publish"
}


* You can access the possible response codes you may encounter here.


Publish Client Metadata

Endpoint:

POST api/v9/content/publisher/clients/{clientIdentifier}/publish-client

Description:
Initiates the process of publishing Client Metadata for a specified client.

Request:

{
}

Success Response:

{
  "message": "Client metadata publish has been started."
}


* You can access the possible response codes you may encounter here.


Get Client Metadata Publish Status

Endpoint:

GET api/v9/content/publisher/clients/{clientIdentifier}/publish-client-status

Description:
Checks the publish status of the client metadata.

Success Response:

{
  "status": "inProgress",
  "message": "Client metadata publish is in progress.",
  "lastPublishedDate": "2024-12-09T19:51:48Z",
}


* You can access the possible response codes you may encounter here.


Publish Client Content

Endpoint:

POST api/v9/content/publisher/clients/{clientIdentifier}/publish-contents

Description:
Initiates the process of publishing Client Content for a specified client.

Request:

{
}

Success Response:

{
  "message": "Client content publish has been started."
}


* You can access the possible response codes you may encounter here.


Get Client Content Status

Endpoint:

GET api/v9/content/publisher/clients/{clientIdentifier}/publish-contents-status

Description:
Checks the status of the client content publish.

Success Response:

{
  "status": "inProgress",
  "message": "Client content publish status is in progress.",
  "lastPublishedDate": "2024-12-09T19:51:48Z",
}


* You can access the possible response codes you may encounter here.


Publish Site Content

Endpoint:

POST api/v9/content/publisher/clients/{clientIdentifier}/sites/{siteIdentifier}/publish-contents

Description:
Initiates the process of publishing Site Content for a specified site.

Request:

{
}

Success Response:

{
  "message": "Site content publish has been started."
}


* You can access the possible response codes you may encounter here.


Get Site Content Status

Endpoint:

GET api/v9/content/publisher/clients/{clientIdentifier}/sites/{siteIdentifier}/publish-contents-status

Description:
Checks the status of the site content publish.

Success Response:

{
  "status": "completed",
  "message": "Site content publish is completed.",
  "lastPublishedDate": "2024-12-09T19:51:48Z",
}


* You can access the possible response codes you may encounter here.


Publish Global Configurations

Endpoint:

POST api/v9/content/publisher/clients/{clientIdentifier}/publish-configurations

Description:
Initiates the process of publishing Global Configurations for a specified client.

Request:

{
}

Success Response:

{
  "message": "Global configurations publish has been started."
}


* You can access the possible response codes you may encounter here.


Get Global Configurations Publish Status

Endpoint:

GET api/v9/content/publisher/clients/{clientIdentifier}/publish-configurations-status

Description:
Checks the publish status of the global configurations for the client.

Success Response:

{
  "status": "inProgress",
  "message": "Global configurations publish is in progress.",
  "lastPublishedDate": "2024-12-09T19:51:48Z",
}


* You can access the possible response codes you may encounter here.


Publish Site Configurations

Endpoint:

POST api/v9/content/publisher/clients/{clientIdentifier}/sites/{siteIdentifier}/publish-configurations

Description:
Initiates the process of publishing Site Configurations for a specified site.

Request:

{
}

Success Response:

{
  "message": "Site configurations publish has been started."
}


* You can access the possible response codes you may encounter here.


Get Site Configurations Publish Status

Endpoint:

GET api/v9/content/publisher/clients/{clientIdentifier}/sites/{siteIdentifier}/publish-configurations-status

Description:
Checks the publish status of the site configurations.

Success Response:

{
  "status": "inProgress",
  "message": "Site configurations publish is in progress.",
  "lastPublishedDate": "2024-12-09T19:51:48Z",
}


* You can access the possible response codes you may encounter here.


Publish Taxonomies

Endpoint:

POST api/v9/content/publisher/clients/{clientIdentifier}/publish-taxonomies

Description:
Initiates the process of publishing Taxonomies for a specified client.

Request:

{
}

Success Response:

{
  "message": "Taxonomies publish has been started."
}


* You can access the possible response codes you may encounter here.


Get Taxonomies Publish Status

Endpoint:

GET api/v9/content/publisher/clients/{clientIdentifier}/publish-taxonomies-status

Description:
Checks the publish status of the taxonomies for the client.

Success Response:

{
  "status": "inProgress",
  "message": "Taxonomy publish is in progress.",
  "lastPublishedDate": "2024-12-09T19:51:48Z",
}


* You can access the possible response codes you may encounter here.