Removed Subscribers

Remove subscribers from an Automation workflow.

Available methods

    • Remove subscriber from a workflow

      POST /automations/{workflow_id}/removed-subscribers

      Remove a subscriber from a specific Automation workflow. You can remove a subscriber at any point in an Automation workflow, regardless of how many emails they’ve been sent from that workflow. Once they’re removed, they can never be added back to the same workflow.

      Path parameters

      workflow_id The unique id for the Automation workflow.

      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.
      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.
      _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/removed-subscribers' \
      --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: 328d37c0-01b3-4c57-a2ea-d0223cc45ab3
      Date: Thu, 17 Sep 2015 18:49:44 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.
    • GET /automations/{workflow_id}/removed-subscribers View all subscribers removed from a workflow

      View all subscribers removed from a workflow

      GET /automations/{workflow_id}/removed-subscribers

      Get information about subscribers who were removed from an Automation workflow.

      Path parameters

      workflow_id The unique id for the Automation workflow.

      Response body parameters

      workflow_id Type: String Title: Workflow ID Read only: true A string that uniquely identifies an Automation workflow.
      subscribers Type: Array Title: Trigger Read only: true An array of objects, each representing a subscriber who was removed from 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.
      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.
      _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/removed-subscribers' \
      --user 'anystring:apikey' \
      --include
                                      

      Example response

      
      HTTP/1.1 200 OK
      Server: nginx
      Content-Type: application/json; charset=utf-8
      Content-Length: 4093
      Vary: Accept-Encoding
      X-Request-Id: 8f0f92ff-0184-4afa-9f3a-5400969f7259
      Link: <https://api.mailchimp.com/schema/3.0/Automations/RemovedSubscribers/Collection.json>; rel="describedBy"
      Date: Tue, 26 Jan 2016 19:58:00 GMT
      Connection: keep-alive
      
      
      {
        "workflow_id": "b0a1c24f1a",
        "subscribers": [
          {
            "id": "1b3cff16d4902c6cecdc65100a9fa3e8",
            "workflow_id": "b0a1c24f1a",
            "list_id": "57afe96172",
            "email_address": "urist.mcvankab+13@freddiesjokes.com",
            "_links": [
              {
                "rel": "parent",
                "href": "https://usX.api.mailchimp.com/3.0/automations/b0a1c24f1a/removed-subscribers",
                "method": "GET",
                "targetSchema": "https://api.mailchimp.com/schema/3.0/Automations/RemovedSubscribers/Collection.json"
              },
              {
                "rel": "self",
                "href": "https://usX.api.mailchimp.com/3.0/automations/b0a1c24f1a/removed-subscribers/1b3cff16d4902c6cecdc65100a9fa3e8",
                "method": "GET",
                "targetSchema": "https://api.mailchimp.com/schema/3.0/Automations/RemovedSubscribers/Instance.json"
              },
              {
                "rel": "member",
                "href": "https://usX.api.mailchimp.com/3.0/lists/57afe96172/members/1b3cff16d4902c6cecdc65100a9fa3e8",
                "method": "GET",
                "targetSchema": "https://api.mailchimp.com/schema/3.0/Lists/Members/Instance.json"
              }
            ]
          },
          {
            "id": "10c74d70c433f3d743ceecfff5f274e2",
            "workflow_id": "b0a1c24f1a",
            "list_id": "57afe96172",
            "email_address": "urist.mcvankab+6@freddiesjokes.com",
            "_links": [
              {
                "rel": "parent",
                "href": "https://usX.api.mailchimp.com/3.0/automations/b0a1c24f1a/removed-subscribers",
                "method": "GET",
                "targetSchema": "https://api.mailchimp.com/schema/3.0/Automations/RemovedSubscribers/Collection.json"
              },
              {
                "rel": "self",
                "href": "https://usX.api.mailchimp.com/3.0/automations/b0a1c24f1a/removed-subscribers/10c74d70c433f3d743ceecfff5f274e2",
                "method": "GET",
                "targetSchema": "https://api.mailchimp.com/schema/3.0/Automations/RemovedSubscribers/Instance.json"
              },
              {
                "rel": "member",
                "href": "https://usX.api.mailchimp.com/3.0/lists/57afe96172/members/10c74d70c433f3d743ceecfff5f274e2",
                "method": "GET",
                "targetSchema": "https://api.mailchimp.com/schema/3.0/Lists/Members/Instance.json"
              }
            ]
          },
          {
            "id": "6babaa896c435ec48847bca70f0fb237",
            "workflow_id": "b0a1c24f1a",
            "list_id": "57afe96172",
            "email_address": "urist.mcvankab+10@freddiesjokes.com",
            "_links": [
              {
                "rel": "parent",
                "href": "https://usX.api.mailchimp.com/3.0/automations/b0a1c24f1a/removed-subscribers",
                "method": "GET",
                "targetSchema": "https://api.mailchimp.com/schema/3.0/Automations/RemovedSubscribers/Collection.json"
              },
              {
                "rel": "self",
                "href": "https://usX.api.mailchimp.com/3.0/automations/b0a1c24f1a/removed-subscribers/6babaa896c435ec48847bca70f0fb237",
                "method": "GET",
                "targetSchema": "https://api.mailchimp.com/schema/3.0/Automations/RemovedSubscribers/Instance.json"
              },
              {
                "rel": "member",
                "href": "https://usX.api.mailchimp.com/3.0/lists/57afe96172/members/6babaa896c435ec48847bca70f0fb237",
                "method": "GET",
                "targetSchema": "https://api.mailchimp.com/schema/3.0/Lists/Members/Instance.json"
              }
            ]
          },
          {
            "id": "b39fde63a36cd0ef56a129c8cda3bc47",
            "workflow_id": "b0a1c24f1a",
            "list_id": "57afe96172",
            "email_address": "urist.mcvankab+12@freddiesjokes.com",
            "_links": [
              {
                "rel": "parent",
                "href": "https://usX.api.mailchimp.com/3.0/automations/b0a1c24f1a/removed-subscribers",
                "method": "GET",
                "targetSchema": "https://api.mailchimp.com/schema/3.0/Automations/RemovedSubscribers/Collection.json"
              },
              {
                "rel": "self",
                "href": "https://usX.api.mailchimp.com/3.0/automations/b0a1c24f1a/removed-subscribers/b39fde63a36cd0ef56a129c8cda3bc47",
                "method": "GET",
                "targetSchema": "https://api.mailchimp.com/schema/3.0/Automations/RemovedSubscribers/Instance.json"
              },
              {
                "rel": "member",
                "href": "https://usX.api.mailchimp.com/3.0/lists/57afe96172/members/b39fde63a36cd0ef56a129c8cda3bc47",
                "method": "GET",
                "targetSchema": "https://api.mailchimp.com/schema/3.0/Lists/Members/Instance.json"
              }
            ]
          }
        ],
        "total_items": 4,
        "_links": [
          {
            "rel": "parent",
            "href": "https://usX.api.mailchimp.com/3.0/automations/b0a1c24f1a",
            "method": "GET",
            "targetSchema": "https://api.mailchimp.com/schema/3.0/Automations/Instance.json"
          },
          {
            "rel": "self",
            "href": "https://usX.api.mailchimp.com/3.0/automations/b0a1c24f1a/removed-subscribers",
            "method": "GET",
            "targetSchema": "https://api.mailchimp.com/schema/3.0/Automations/RemovedSubscribers/Collection.json"
          },
          {
            "rel": "create",
            "href": "https://usX.api.mailchimp.com/3.0/automations/b0a1c24f1a/removed-subscribers",
            "method": "POST",
            "schema": "https://api.mailchimp.com/schema/3.0/Automations/RemovedSubscribers/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.