Jump to

• Request
• Response
• Examples

Fetch All Email or Push Campaign Schedules

get

/rest/api/v1.3/campaigns/{campaignName}/schedule

Request

Path Parameters

• campaignName: string
  Campaign Name

Back to Top

Response

Supported Media Types

• application/json

Default Response

Body ()

Root Schema : Email or Push Campaign Schedules

Type: object

Title: Email or Push Campaign Schedules

Show Source

• items(optional): array items

{
    "title":"Email or Push Campaign Schedules",
    "type":"object",
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/retrieve-campaignSchedule-response"
            }
        }
    }
}

Nested Schema : items

Type: array

Show Source

• Array of: object Email or Push Campaign Schedule
  Title: Email or Push Campaign Schedule

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/retrieve-campaignSchedule-response"
    }
}

Nested Schema : Email or Push Campaign Schedule

Type: object

Title: Email or Push Campaign Schedule

Show Source

• id(optional): string
  ID of the schedule.
• launchOptions(optional): object launchOptions
  Launch Options for the schedule.
• recurringEndTime(optional): string
  Date in the format yyyy-mm-dd HH:mm
• scheduledTime(optional): string
  Date in the format yyyy-mm-dd HH:mm
• scheduleType(optional): string
  Allowed Values: [ "NOW", "ONCE", "RECURRING" ]

  Schedule Type.

{
    "type":"object",
    "title":"Email or Push Campaign Schedule",
    "properties":{
        "id":{
            "description":"ID of the schedule.",
            "type":"string"
        },
        "launchOptions":{
            "description":"Launch Options for the schedule.",
            "type":"object",
            "properties":{
                "progressChunk":{
                    "enum":[
                        "CHUNK_10K",
                        "CHUNK_50K",
                        "CHUNK_100K",
                        "CHUNK_500K",
                        "CHUNK_1M"
                    ],
                    "type":"string",
                    "description":"Progress Chunk."
                },
                "recipientLimit":{
                    "type":"integer",
                    "description":"Recipient Limit."
                },
                "proofLaunchType":{
                    "enum":[
                        "LAUNCH_TO_ADDRESS",
                        "LAUNCH_TO_PROOFLIST",
                        "LAUNCH_TO_ADDRESS_USING_PROOFLIST"
                    ],
                    "type":"string",
                    "description":"Proof Launch type."
                },
                "progressEmailAddresses":{
                    "type":"array",
                    "description":"Email addresses to inform of progress.",
                    "items":{
                        "type":"string"
                    }
                },
                "samplingNthOffset":{
                    "type":"integer",
                    "description":"Sampling offset."
                },
                "samplingNthInterval":{
                    "type":"integer",
                    "description":"Sampling Interval."
                },
                "proofLaunch":{
                    "type":"boolean",
                    "description":"Should a proof launch be performed."
                },
                "samplingNthSelection":{
                    "type":"integer",
                    "description":"Sampling Selection."
                },
                "proofLaunchEmail":{
                    "type":"string",
                    "description":"Email address for the proof launch."
                }
            }
        },
        "scheduleType":{
            "description":"Schedule Type.",
            "enum":[
                "NOW",
                "ONCE",
                "RECURRING"
            ],
            "type":"string"
        },
        "scheduledTime":{
            "description":"Date in the format yyyy-mm-dd HH:mm",
            "type":"string"
        },
        "recurringEndTime":{
            "description":"Date in the format yyyy-mm-dd HH:mm",
            "type":"string"
        }
    }
}

Nested Schema : launchOptions

Type: object

Launch Options for the schedule.

Show Source

• progressChunk(optional): string
  Allowed Values: [ "CHUNK_10K", "CHUNK_50K", "CHUNK_100K", "CHUNK_500K", "CHUNK_1M" ]

  Progress Chunk.
• progressEmailAddresses(optional): array progressEmailAddresses
  Email addresses to inform of progress.
• proofLaunch(optional): boolean
  Should a proof launch be performed.
• proofLaunchEmail(optional): string
  Email address for the proof launch.
• proofLaunchType(optional): string
  Allowed Values: [ "LAUNCH_TO_ADDRESS", "LAUNCH_TO_PROOFLIST", "LAUNCH_TO_ADDRESS_USING_PROOFLIST" ]

  Proof Launch type.
• recipientLimit(optional): integer
  Recipient Limit.
• samplingNthInterval(optional): integer
  Sampling Interval.
• samplingNthOffset(optional): integer
  Sampling offset.
• samplingNthSelection(optional): integer
  Sampling Selection.

{
    "description":"Launch Options for the schedule.",
    "type":"object",
    "properties":{
        "progressChunk":{
            "enum":[
                "CHUNK_10K",
                "CHUNK_50K",
                "CHUNK_100K",
                "CHUNK_500K",
                "CHUNK_1M"
            ],
            "type":"string",
            "description":"Progress Chunk."
        },
        "recipientLimit":{
            "type":"integer",
            "description":"Recipient Limit."
        },
        "proofLaunchType":{
            "enum":[
                "LAUNCH_TO_ADDRESS",
                "LAUNCH_TO_PROOFLIST",
                "LAUNCH_TO_ADDRESS_USING_PROOFLIST"
            ],
            "type":"string",
            "description":"Proof Launch type."
        },
        "progressEmailAddresses":{
            "type":"array",
            "description":"Email addresses to inform of progress.",
            "items":{
                "type":"string"
            }
        },
        "samplingNthOffset":{
            "type":"integer",
            "description":"Sampling offset."
        },
        "samplingNthInterval":{
            "type":"integer",
            "description":"Sampling Interval."
        },
        "proofLaunch":{
            "type":"boolean",
            "description":"Should a proof launch be performed."
        },
        "samplingNthSelection":{
            "type":"integer",
            "description":"Sampling Selection."
        },
        "proofLaunchEmail":{
            "type":"string",
            "description":"Email address for the proof launch."
        }
    }
}

Nested Schema : progressEmailAddresses

Type: array

Email addresses to inform of progress.

Show Source

• Array of: string

{
    "type":"array",
    "description":"Email addresses to inform of progress.",
    "items":{
        "type":"string"
    }
}

Back to Top

Examples

The following example shows how to retrieve all the schedules for an Email campaign or a Push campaign. The response includes all schedule IDs for the active launches for the campaign.

NOTES:

• A Responsys user must create the campaign in Responsys, and the campaign must not have validation errors.
• For Email campaigns, the interfaces apply for only Email Message Designer (EMD) campaigns; the interfaces do not support classic campaigns.
• For Push campaigns, your Push campaign must have the "From address" set in the Launch Options of the campaign workbook. If the "From address" is not set, the campaign will be scheduled successfully, but the campaign launch will fail.
• The APIs support Push campaigns only for the Mobile App channel. The API does not support In-app Message campaigns.

A successful request requires the following headers:

FIELDS	DESCRIPTION
Authorization	<AUTH_TOKEN>

Example Request URL:

      /rest/api/v1.3/campaigns/test/schedule
	

Sample Response: Success

The following successful response is for a campaign named testCampaign that has two active launches. The active launch with Scheduled ID 307357 is of type RECURRING, which occurs daily, starting on February 9, 2019 and ending on February 23, 2019. The active launch with Schedule ID 307377 is of type ONCE, which will occur only on February 3, 2019 at noon.

 {
  "schedules": [
    {
      "id": 307357,
      "scheduleType": "RECURRING",
      "scheduledTime": "2019-02-09 10:00 AM",
      "recurringEndTime": "2019-02-23 12:00 PM",
      "recurringInterval": "DAILY",
      "launchOptions": {
        "proofLaunch": false
      },
      "links": [
        {
          "rel": "self",
          "href": "/rest/api/v1.3/campaigns/testCampaign/schedule/307357",
          "method": "GET"
        },
        {
          "rel": "deleteSchedule",
          "href": "/rest/api/v1.3/campaigns/testCampaign/schedule/307357",
          "method": "DELETE"
        },
        {
          "rel": "updateSchedule",
          "href": "/rest/api/v1.3/campaigns/testCampaign/schedule/307357",
          "method": "PUT"
        },
        {
          "rel": "createSchedule",
          "href": "/rest/api/v1.3/campaigns/testCampaign/schedule",
          "method": "POST"
        }
      ]
    },
    {
      "id": 307377,
      "scheduleType": "ONCE",
      "scheduledTime": "2019-02-03 12:00 PM",
      "launchOptions": {
        "proofLaunch": false
      },
      "links": [
        {
          "rel": "self",
          "href": "/rest/api/v1.3/campaigns/testCampaign/schedule/307377",
          "method": "GET"
        },
        {
          "rel": "deleteSchedule",
          "href": "/rest/api/v1.3/campaigns/testCampaign/schedule/307377",
          "method": "DELETE"
        },
        {
          "rel": "updateSchedule",
          "href": "/rest/api/v1.3/campaigns/testCampaign/schedule/307377",
          "method": "PUT"
        },
        {
          "rel": "createSchedule",
          "href": "/rest/api/v1.3/campaigns/testCampaign/schedule",
          "method": "POST"
        }
      ]
    }
  ],
  "links": [
    {
      "rel": "self",
      "href": "/rest/api/v1.3/campaigns/testCampaign/schedule",
      "method": "GET"
    }
  ]
 }

Sample Response: Failure

 {
    "title": "Campaign not found",
    "errorCode": "CAMPAIGN_NOT_FOUND",
    "detail": "Campaign not found with name [campaignName]" 
 }

Back to Top