Collection.Publish
  • 25 May 2021
  • 1 Minute to read
  • Contributors
  • Dark
    Light
  • PDF

Collection.Publish

  • Dark
    Light
  • PDF

Description

Publishes the collection according to the publishing information setup for the collection. Publish information can be entered via the Web Console or using the Collection.SetPublisher call.

URL parameters

URL parameter ordering

The URL parameters below are listed in the order they should be entered in the API URL.

Name Required Type Description
CollectionID True numeric Unique identifier of the collection.
Job.StatusURL False string URL requested by Mozenda when the job finishes processing.
Job.StatusURL

The URL needs to begin with either the http:// or https:// protocol and needs to be URL encoded.
It can contain any of the following replacement values anywhere in the querystring.
To include a replacement value enclose it in percentage signs (e.g. %JobID%).

  • JobID
  • Job.Status
  • Job.Ended

The status URL may be requested multiple time for the Running status.

Responses

Name Type Description
Result string Success if the operation was successful.
JobID numeric A unique identifier of the job.

Sample Request

curl -X GET 'https://api.mozenda.com/rest?WebServiceKey=XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX&Service=Mozenda10&Operation=Collection.Publish&CollectionID=1005'

Sample responses

XML

<?xml version="1.0" encoding="utf-8" ?>
<CollectionPublishResponse
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:xsd="http://www.w3.org/2001/XMLSchema">
	<Result>Success</Result> 
	<JobID>XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX</JobID>
</CollectionPublishResponse>

JSON

{
    "JobID": 114586401,
    "JobType": "EmailPublish",
    "JsonResult": {
        "Command": "Collection.Publish",
        "AutoLoggedIn": false,
        "WebConsoleKey": "",
        "Result": "Success",
        "ErrorCode": "",
        "ErrorDescription": "",
        "ErrorList": [],
        "ExecutionTime": {
            "Ticks": 0,
            "Days": 0,
            "Hours": 0,
            "Milliseconds": 0,
            "Minutes": 0,
            "Seconds": 0,
            "TotalDays": 0,
            "TotalHours": 0,
            "TotalMilliseconds": 0,
            "TotalMinutes": 0,
            "TotalSeconds": 0
        }
    }
}

Was this article helpful?