Queue

Manage list member queues for Automation emails.

Available methods

    • Add a subscriber to a workflow email

      POST /automations/{workflow_id}/emails/{workflow_email_id}/queue

      Manually add a subscriber to a workflow, bypassing the default trigger settings. You can also use this endpoint to trigger a series of automated emails in an API 3.0 workflow type or add subscribers to an automated email queue that uses the API request delay type.

      Path parameters

      workflow_id The unique id for the Automation workflow.
      workflow_email_id The unique id for the Automation workflow email.

      Request body parameters

      email_address Type: String Title: Email Address Read only: false The list member’s email address.

      Response body parameters

      id Type: String Title: Email Hash Read only: true The MD5 hash of the lowercase version of the list member’s email address.
      workflow_id Type: String Title: Workflow ID Read only: true A string that uniquely identifies an Automation workflow.
      email_id Type: String Title: Automation Email ID Read only: true A string that uniquely identifies an email in an Automation workflow.
      list_id Type: String Title: List ID Read only: true A string that uniquely identifies a list.
      email_address Type: String Title: Email Address Read only: false The list member’s email address.
      next_send Type: String Title: Next Send Read only: true The date and time of the next send for the workflow email.
      _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 POST \
      --url 'https://usX.api.mailchimp.com/3.0/automations/b0a1c24f1a/emails/491fec26f1/queue' \
      --user 'anystring:apikey' \
      --header 'content-type: application/json' \
      --data '{"email_address": "urist.mcvankab@freddiesjokes.com"}' \
      --include
                                      

      Example response

      
      HTTP/1.1 204 No Content
      Server: nginx
      Content-Type: application/json; charset=utf-8
      Content-Length: 2
      X-Request-Id: b94db4f1-71ea-43b0-930f-2f1f849145cf
      Date: Thu, 17 Sep 2015 18:46:27 GMT
      Connection: keep-alive
                                      

      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.
    • View queued subscribers for an automated email

      GET /automations/{workflow_id}/emails/{workflow_email_id}/queue

      Get information about an Automation email queue.

      Path parameters

      workflow_id The unique id for the Automation workflow.
      workflow_email_id The unique id for the Automation workflow email.

      Response body parameters

      workflow_id Type: String Title: Workflow ID Read only: true A string that uniquely identifies an Automation workflow.
      email_id Type: String Title: Automation Email ID Read only: true A string that uniquely identifies an email in an Automation workflow.
      queue Type: Array Title: Trigger Read only: true An array of objects, each representing a subscriber queue for an email in an Automation workflow.
      Show properties
      id Type: String Title: Email Hash Read only: true The MD5 hash of the lowercase version of the list member’s email address.
      workflow_id Type: String Title: Workflow ID Read only: true A string that uniquely identifies an Automation workflow.
      email_id Type: String Title: Automation Email ID Read only: true A string that uniquely identifies an email in an Automation workflow.
      list_id Type: String Title: List ID Read only: true A string that uniquely identifies a list.
      email_address Type: String Title: Email Address Read only: false The list member’s email address.
      next_send Type: String Title: Next Send Read only: true The date and time of the next send for the workflow email.
      _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.
      total_items Type: Integer Title: Item Count Read only: false The total number of items matching the query regardless of pagination.
      _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/automations/b0a1c24f1a/emails/491fec26f1/queue' \
      --user 'anystring:apikey' \
      --include
                                      

      Example response

      
      HTTP/1.1 200 OK
      Server: nginx
      Content-Type: application/json; charset=utf-8
      Content-Length: 1584
      Vary: Accept-Encoding
      X-Request-Id: 360b3666-fb7e-4dbd-b85d-9b580c68fd12
      Link: <https://api.mailchimp.com/schema/3.0/Automations/Emails/Queue/Collection.json>; rel="describedBy"
      Date: Tue, 15 Sep 2015 17:28:40 GMT
      Connection: keep-alive
      
      
      {
        "workflow_id": "b0a1c24f1a",
        "email_id": "491fec26f1",
        "queue": [
          {
            "id": "62eeb292278cc15f5817cb78f7790b08",
            "workflow_id": "b0a1c24f1a",
            "email_id": "491fec26f1",
            "list_id": "57afe96172",
            "email_address": "urist.mcvankab@freddiesjokes.com",
            "_links": [
              {
                "rel": "parent",
                "href": "https://usX.api.mailchimp.com/3.0/automations/b0a1c24f1a/emails/491fec26f1/queue",
                "method": "GET",
                "targetSchema": "https://api.mailchimp.com/schema/3.0/Automations/Emails/Queue/Collection.json"
              },
              {
                "rel": "self",
                "href": "https://usX.api.mailchimp.com/3.0/automations/b0a1c24f1a/emails/491fec26f1/queue/62eeb292278cc15f5817cb78f7790b08",
                "method": "GET",
                "targetSchema": "https://api.mailchimp.com/schema/3.0/Automations/Emails/Queue/Instance.json"
              },
              {
                "rel": "member",
                "href": "https://usX.api.mailchimp.com/3.0/lists/57afe96172/members/62eeb292278cc15f5817cb78f7790b08",
                "method": "GET",
                "targetSchema": "https://api.mailchimp.com/schema/3.0/Lists/Members/Instance.json"
              }
            ]
          }
        ],
        "total_items": 1,
        "_links": [
          {
            "rel": "parent",
            "href": "https://usX.api.mailchimp.com/3.0/automations/b0a1c24f1a/emails/491fec26f1",
            "method": "GET",
            "targetSchema": "https://api.mailchimp.com/schema/3.0/Automations/Emails/Instance.json"
          },
          {
            "rel": "self",
            "href": "https://usX.api.mailchimp.com/3.0/automations/b0a1c24f1a/emails/491fec26f1/queue",
            "method": "GET",
            "targetSchema": "https://api.mailchimp.com/schema/3.0/Automations/Emails/Queue/Collection.json"
          },
          {
            "rel": "create",
            "href": "https://usX.api.mailchimp.com/3.0/automations/b0a1c24f1a/emails/491fec26f1/queue",
            "method": "POST",
            "schema": "https://api.mailchimp.com/schema/3.0/Automations/Emails/Queue/Instance.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.

      View specific subscriber in email queue

      GET /automations/{workflow_id}/emails/{workflow_email_id}/queue/{subscriber_hash}

      Get information about a specific subscriber in an Automation email queue.

      Path parameters

      workflow_id The unique id for the Automation workflow.
      workflow_email_id The unique id for the Automation workflow email.
      subscriber_hash The MD5 hash of the lowercase version of the list member’s email address.

      Response body parameters

      id Type: String Title: Email Hash Read only: true The MD5 hash of the lowercase version of the list member’s email address.
      workflow_id Type: String Title: Workflow ID Read only: true A string that uniquely identifies an Automation workflow.
      email_id Type: String Title: Automation Email ID Read only: true A string that uniquely identifies an email in an Automation workflow.
      list_id Type: String Title: List ID Read only: true A string that uniquely identifies a list.
      email_address Type: String Title: Email Address Read only: false The list member’s email address.
      next_send Type: String Title: Next Send Read only: true The date and time of the next send for the workflow email.
      _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/automations/b0a1c24f1a/emails/491fec26f1/queue/62eeb292278cc15f5817cb78f7790b08' \
      --user 'anystring:apikey' \
      --include
                                      

      Example response

      
      HTTP/1.1 200 OK
      Server: nginx
      Content-Type: application/json; charset=utf-8
      Content-Length: 854
      Vary: Accept-Encoding
      X-Request-Id: ed1401cd-8b56-427a-ac12-e38a8bab27c5
      Link: <https://api.mailchimp.com/schema/3.0/Automations/Emails/Queue/Instance.json>; rel="describedBy"
      Date: Tue, 15 Sep 2015 17:47:36 GMT
      Connection: keep-alive
      
      
      {
        "id": "62eeb292278cc15f5817cb78f7790b08",
        "workflow_id": "b0a1c24f1a",
        "email_id": "491fec26f1",
        "list_id": "57afe96172",
        "email_address": "urist.mcvankab@freddiesjokes.com",
        "_links": [
          {
            "rel": "parent",
            "href": "https://usX.api.mailchimp.com/3.0/automations/b0a1c24f1a/emails/491fec26f1/queue",
            "method": "GET",
            "targetSchema": "https://api.mailchimp.com/schema/3.0/Automations/Emails/Queue/Collection.json"
          },
          {
            "rel": "self",
            "href": "https://usX.api.mailchimp.com/3.0/automations/b0a1c24f1a/emails/491fec26f1/queue/62eeb292278cc15f5817cb78f7790b08",
            "method": "GET",
            "targetSchema": "https://api.mailchimp.com/schema/3.0/Automations/Emails/Queue/Instance.json"
          },
          {
            "rel": "member",
            "href": "https://usX.api.mailchimp.com/3.0/lists/57afe96172/members/62eeb292278cc15f5817cb78f7790b08",
            "method": "GET",
            "targetSchema": "https://api.mailchimp.com/schema/3.0/Lists/Members/Instance.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.