Action: Update Member

Mailchimp Operation

The List Members action enables users to update an existing member in a specific list in Mailchimp.

Example User Story

As a marketing manager, I want to update a subscriber's status in a Mailchimp list so that I can manage my email campaigns effectively.

Fields

Field Name	Field Type	Required
list_id	String	Yes
subscriber_hash	String	Yes
email_address	String	No
status	String	No
merge_fields	Object	No
interests	Object	No
language	String	No
vip	Boolean	No
location	Object	No
marketing_permissions	Array	No
ip_signup	String	No
timestamp_signup	String	No
ip_opt	String	No
timestamp_opt	String	No

Related Connections

Related Automations

Example link

Code (Apache v2.0): Operation

{
  "handle": "update-list-member",
  "state": "inDev",
  "meta": {
    "short": "Update List Member",
    "description": "Update an existing member in a Mailchimp list."
  },
  "input": [
    {
      "name": "list_id",
      "type": "String",
      "required": true,
      "meta": {
        "description": "The unique ID for the list."
      }
    },
    {
      "name": "subscriber_hash",
      "type": "String",
      "required": true,
      "meta": {
        "description": "The MD5 hash of the lowercase version of the list member's email address."
      }
    },
    {
      "name": "email_address",
      "type": "String",
      "required": false,
      "meta": {
        "description": "Email address for a subscriber."
      }
    },
    {
      "name": "status",
      "type": "String",
      "required": false,
      "meta": {
        "description": "Subscriber's current status.",
        "options": ["subscribed", "unsubscribed", "cleaned", "pending"]
      }
    },
    {
      "name": "merge_fields",
      "type": "Object",
      "required": false,
      "meta": {
        "description": "An individual merge var and value for a list member."
      }
    },
    {
      "name": "interests",
      "type": "Object",
      "required": false,
      "meta": {
        "description": "The key of this object is the interest's ID, and the value is a boolean indicating whether the member is interested in the topic."
      }
    },
    {
      "name": "language",
      "type": "String",
      "required": false,
      "meta": {
        "description": "If language information is not included, the list's default language is used."
      }
    },
    {
      "name": "vip",
      "type": "Boolean",
      "required": false,
      "meta": {
        "description": "VIP status for subscriber."
      }
    },
    {
      "name": "location",
      "type": "Object",
      "required": false,
      "meta": {
        "description": "Subscriber's location information."
      }
    },
    {
      "name": "marketing_permissions",
      "type": "Array",
      "required": false,
      "meta": {
        "description": "The marketing permissions for the subscriber."
      }
    },
    {
      "name": "ip_signup",
      "type": "String",
      "required": false,
      "meta": {
        "description": "IP address the subscriber signed up from."
      }
    },
    {
      "name": "timestamp_signup",
      "type": "String",
      "required": false,
      "meta": {
        "description": "The date and time the subscriber signed up for the list in ISO 8601 format."
      }
    },
    {
      "name": "ip_opt",
      "type": "String",
      "required": false,
      "meta": {
        "description": "The IP address the subscriber used to confirm their opt-in status."
      }
    },
    {
      "name": "timestamp_opt",
      "type": "String",
      "required": false,
      "meta": {
        "description": "The date and time the subscriber confirmed their opt-in status in ISO 8601 format."
      }
    }
  ],
  "output": [
    {
      "name": "id",
      "type": "String",
      "selector": ["id"],
      "meta": {
        "description": "The unique identifier for the list member."
      }
    },
    {
      "name": "email_address",
      "type": "String",
      "selector": ["email_address"],
      "meta": {
        "description": "Email address for a subscriber."
      }
    },
    {
      "name": "unique_email_id",
      "type": "String",
      "selector": ["unique_email_id"],
      "meta": {
        "description": "An identifier for the address across all of Mailchimp."
      }
    },
    {
      "name": "status",
      "type": "String",
      "selector": ["status"],
      "meta": {
        "description": "Subscriber's current status."
      }
    }
  ],
  "steps": [
    {
      "type": "http",
      "http": {
        "method": "PATCH",
        "path": "/lists/{{list_id}}/members/{{subscriber_hash}}",
        "headers": {
          "Content-Type": "application/json"
        },
        "bodyTemplate": {
          "value": "{\"email_address\": \"{{email_address}}\", \"status\": \"{{status}}\", \"merge_fields\": {{merge_fields}}, \"interests\": {{interests}}, \"language\": \"{{language}}\", \"vip\": {{vip}}, \"location\": {{location}}, \"marketing_permissions\": {{marketing_permissions}}, \"ip_signup\": \"{{ip_signup}}\", \"timestamp_signup\": \"{{timestamp_signup}}\", \"ip_opt\": \"{{ip_opt}}\", \"timestamp_opt\": \"{{timestamp_opt}}\"}",
          "placeholders": [
            {
              "name": "email_address",
              "type": "String",
              "description": "Email address for a subscriber.",
              "required": false
            },
            {
              "name": "status",
              "type": "String",
              "description": "Subscriber's current status.",
              "required": false,
              "options": ["subscribed", "unsubscribed", "cleaned", "pending"]
            },
            {
              "name": "merge_fields",
              "type": "Object",
              "description": "An individual merge var and value for a list member.",
              "required": false
            },
            {
              "name": "interests",
              "type": "Object",
              "description": "The key of this object is the interest's ID, and the value is a boolean indicating whether the member is interested in the topic.",
              "required": false
            },
            {
              "name": "language",
              "type": "String",
              "description": "If language information is not included, the list's default language is used.",
              "required": false
            },
            {
              "name": "vip",
              "type": "Boolean",
              "description": "VIP status for subscriber.",
              "required": false
            },
            {
              "name": "location",
              "type": "Object",
              "description": "Subscriber's location information.",
              "required": false
            },
            {
              "name": "marketing_permissions",
              "type": "Array",
              "description": "The marketing permissions for the subscriber.",
              "required": false
            },
            {
              "name": "ip_signup",
              "type": "String",
              "description": "IP address the subscriber signed up from.",
              "required": false
            },
            {
              "name": "timestamp_signup",
              "type": "String",
              "description": "The date and time the subscriber signed up for the list in ISO 8601 format.",
              "required": false
            },
            {
              "name": "ip_opt",
              "type": "String",
              "description": "The IP address the subscriber used to confirm their opt-in status.",
              "required": false
            },
            {
              "name": "timestamp_opt",
              "type": "String",
              "description": "The date and time the subscriber confirmed their opt-in status in ISO 8601 format.",
              "required": false
            }
          ]
        }
      }
    }
  ]
}