Send Checklist

Review the send checklist for your campaign, and resolve any issues before sending.

Available methods

    • GET /campaigns/{campaign_id}/send-checklist Get the send checklist for a campaign

      Get the send checklist for a campaign

      GET /campaigns/{campaign_id}/send-checklist

      Review the send checklist for a campaign, and resolve any issues before sending.

      Path parameters

      campaign_id The unique id for the campaign.

      Query string parameters

      fields Type: Array Title: Fields Read only: false A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.
      exclude_fields Type: Array Title: Exclude Fields Read only: false A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.

      Response body parameters

      is_ready Type: Boolean Title: Ready? Read only: false Whether the campaign is ready to send.
      items Type: Array Title: Items Read only: false A list of feedback items to review before sending your campaign.
      Show properties
      type Type: String Title: Type Read only: false The item type.
      Possible Values:
      • success
      • warning
      • error
      id Type: Integer Title: ID Read only: false The ID for the specific item.
      heading Type: String Title: Heading Read only: false The heading for the specific item.
      details Type: String Title: Details Read only: false Details about the specific feedback item.
      _links Type: Array Title: Links Read only: true A list of link types and descriptions for the API schema documents.
      Show properties
      rel Type: String Title: Rel Read only: true As with an HTML ‘rel’ attribute, this describes the type of link.
      href Type: String Title: Href Read only: true This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action.
      method Type: String Title: Method Read only: true The HTTP method that should be used when accessing the URL defined in ‘href’.
      Possible Values:
      • GET
      • POST
      • PUT
      • PATCH
      • DELETE
      • OPTIONS
      • HEAD
      targetSchema Type: String Title: Target Schema Read only: true For GETs, this is a URL representing the schema that the response should conform to.
      schema Type: String Title: Schema Read only: true For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to.

      Example request

      
      curl --request GET \
      --url 'https://usX.api.mailchimp.com/3.0/campaigns/6325018bde/send-checklist' \
      --user 'anystring:apikey' \
      --include
                                      

      Example response

      
      HTTP/1.1 200 OK
      Server: nginx
      Content-Type: application/json; charset=utf-8
      Content-Length: 1515
      Vary: Accept-Encoding
      X-Request-Id: 4c4dfae3-deaf-4ad3-a2be-ab6b339c61a1
      Link: <https://api.mailchimp.com/schema/3.0/Campaigns/Checklist/Collection.json>; rel="describedBy"
      Date: Fri, 20 Nov 2015 22:23:28 GMT
      Connection: keep-alive
      
      {
        "is_ready": true,
        "items": [
          {
            "type": "success",
            "heading": "List",
            "details": "MailChimp will deliver this to the Orders list. (365 recipients) (#) "
          },
          {
            "type": "success",
            "heading": "Subject line",
            "details": "\"Your Purchase Receipt\" "
          },
          {
            "type": "success",
            "heading": "Replies",
            "details": "All replies will go to Customer Service. "
          },
          {
            "type": "success",
            "heading": "Tracking",
            "details": "You chose to track clicks and opens in the HTML email.\nClicks in the plain-text email will not be tracked. "
          },
          {
            "type": "success",
            "heading": "HTML email",
            "details": "You're sending an HTML email using the 1 Column template. "
          },
          {
            "type": "success",
            "heading": "Plain-text email",
            "details": "A plain-text version of this email will be generated and included automatically. learn more (https://kb.mailchimp.com/quick-answers/campaigns-templates-answers/does-mailchimp-automatically-generate-the-plain-text-version-of-my-campaign?) "
          },
          {
            "type": "success",
            "heading": "Email authentication",
            "details": "Email authentication is enabled for this campaign. "
          },
          {
            "type": "success",
            "heading": "MonkeyRewards",
            "details": "A MailChimp affiliate link is included in your template footer. "
          }
        ],
        "_links": [
          {
            "rel": "parent",
            "href": "https://usX.api.mailchimp.com/3.0/campaigns/2209441",
            "method": "GET",
            "targetSchema": "https://api.mailchimp.com/schema/3.0/Campaigns/Instance.json"
          },
          {
            "rel": "self",
            "href": "https://usX.api.mailchimp.com/3.0/campaigns/2209441/send-checklist",
            "method": "GET",
            "targetSchema": "https://api.mailchimp.com/schema/3.0/Campaigns/Checklist/Collection.json"
          }
        ]
      }
                                      

      Error response

      type Type: String Title: Problem Type Read only: false An absolute URI that identifies the problem type. When dereferenced, it should provide human-readable documentation for the problem type.
      title Type: String Title: Error Title Read only: false A short, human-readable summary of the problem type. It shouldn’t change based on the occurrence of the problem, except for purposes of localization.
      status Type: Integer Title: HTTP Status Code Read only: false The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem.
      detail Type: String Title: Error Message Read only: false A human-readable explanation specific to this occurrence of the problem. Learn more about errors.
      instance Type: String Title: Instance ID Read only: false A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support.