mailchimp-automations

Mailchimp Automations

Server path: /mailchimp-automations | Type: Application | PCID required: Yes

Tools

Tool	Description
mailchimp_automations_archive_automations	Archive automation
mailchimp_automations_delete_id_emails_id	Delete workflow email
mailchimp_automations_get_automations	List automations
mailchimp_automations_get_id	Get automation info
mailchimp_automations_get_id_emails	List automated emails
mailchimp_automations_get_id_emails_id	Get workflow email info
mailchimp_automations_get_id_emails_id_queue	List automated email subscribers
mailchimp_automations_get_id_emails_id_queue_id	Get automated email subscriber
mailchimp_automations_get_id_removed_subscribers	List subscribers removed from workflow
mailchimp_automations_get_id_removed_subscribers_id	Get subscriber removed from workflow
mailchimp_automations_patch_automation_email_workflow_id	Update workflow email
mailchimp_automations_post_automations	Add automation
mailchimp_automations_post_customer_journeys_journeys_id_steps_id_actions_trigger	Customer Journeys API trigger for a contact
mailchimp_automations_post_id_actions_pause_all_emails	Pause automation emails
mailchimp_automations_post_id_actions_start_all_emails	Start automation emails
mailchimp_automations_post_id_emails_id_actions_pause	Pause automated email
mailchimp_automations_post_id_emails_id_actions_start	Start automated email
mailchimp_automations_post_id_emails_id_queue	Add subscriber to workflow email
mailchimp_automations_post_id_removed_subscribers	Remove subscriber from workflow

---

mailchimp_automations_archive_automations

Archive automation

Parameters:

Parameter	Type	Required	Default	Description
workflow_id	string	Yes	—	The unique id for the Automation workflow.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "workflow_id": {
      "type": "string",
      "description": "The unique id for the Automation workflow."
    }
  },
  "required": [
    "PCID",
    "workflow_id"
  ]
}

---

mailchimp_automations_delete_id_emails_id

Delete workflow email

Parameters:

Parameter	Type	Required	Default	Description
workflow_id	string	Yes	—	The unique id for the Automation workflow.
workflow_email_id	string	Yes	—	The unique id for the Automation workflow email.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "workflow_id": {
      "type": "string",
      "description": "The unique id for the Automation workflow."
    },
    "workflow_email_id": {
      "type": "string",
      "description": "The unique id for the Automation workflow email."
    }
  },
  "required": [
    "PCID",
    "workflow_id",
    "workflow_email_id"
  ]
}

---

mailchimp_automations_get_automations

List automations

Parameters:

Parameter	Type	Required	Default	Description
count	integer	No	—	The number of records to return. Default value is 10. Maximum value is 1000
offset	integer	No	—	Used for pagination, this is the number of records from a collection to skip. Default value is 0.
fields	string[]	No	—	A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.
exclude_fields	string[]	No	—	A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.
before_create_time	string	No	—	Restrict the response to automations created before this time. Uses the ISO 8601 time format: 2015-10-21T15:41:36+00:00.
since_create_time	string	No	—	Restrict the response to automations created after this time. Uses the ISO 8601 time format: 2015-10-21T15:41:36+00:00.
before_start_time	string	No	—	Restrict the response to automations started before this time. Uses the ISO 8601 time format: 2015-10-21T15:41:36+00:00.
since_start_time	string	No	—	Restrict the response to automations started after this time. Uses the ISO 8601 time format: 2015-10-21T15:41:36+00:00.
status	string	No	—	Restrict the results to automations with the specified status.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "count": {
      "type": "integer",
      "description": "The number of records to return. Default value is 10. Maximum value is 1000"
    },
    "offset": {
      "type": "integer",
      "description": "Used for [pagination](https://mailchimp.com/developer/marketing/docs/methods-parameters/#pagination), this is the number of records from a collection to skip. Default value is 0."
    },
    "fields": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation."
    },
    "exclude_fields": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation."
    },
    "before_create_time": {
      "type": "string",
      "description": "Restrict the response to automations created before this time. Uses the ISO 8601 time format: 2015-10-21T15:41:36+00:00."
    },
    "since_create_time": {
      "type": "string",
      "description": "Restrict the response to automations created after this time. Uses the ISO 8601 time format: 2015-10-21T15:41:36+00:00."
    },
    "before_start_time": {
      "type": "string",
      "description": "Restrict the response to automations started before this time. Uses the ISO 8601 time format: 2015-10-21T15:41:36+00:00."
    },
    "since_start_time": {
      "type": "string",
      "description": "Restrict the response to automations started after this time. Uses the ISO 8601 time format: 2015-10-21T15:41:36+00:00."
    },
    "status": {
      "type": "string",
      "description": "Restrict the results to automations with the specified status.",
      "enum": [
        "save",
        "paused",
        "sending"
      ]
    }
  },
  "required": [
    "PCID"
  ]
}

---

mailchimp_automations_get_id

Get automation info

Parameters:

Parameter	Type	Required	Default	Description
fields	string[]	No	—	A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.
exclude_fields	string[]	No	—	A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.
workflow_id	string	Yes	—	The unique id for the Automation workflow.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "fields": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation."
    },
    "exclude_fields": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation."
    },
    "workflow_id": {
      "type": "string",
      "description": "The unique id for the Automation workflow."
    }
  },
  "required": [
    "PCID",
    "workflow_id"
  ]
}

---

mailchimp_automations_get_id_emails

List automated emails

Parameters:

Parameter	Type	Required	Default	Description
workflow_id	string	Yes	—	The unique id for the Automation workflow.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "workflow_id": {
      "type": "string",
      "description": "The unique id for the Automation workflow."
    }
  },
  "required": [
    "PCID",
    "workflow_id"
  ]
}

---

mailchimp_automations_get_id_emails_id

Get workflow email info

Parameters:

Parameter	Type	Required	Default	Description
workflow_id	string	Yes	—	The unique id for the Automation workflow.
workflow_email_id	string	Yes	—	The unique id for the Automation workflow email.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "workflow_id": {
      "type": "string",
      "description": "The unique id for the Automation workflow."
    },
    "workflow_email_id": {
      "type": "string",
      "description": "The unique id for the Automation workflow email."
    }
  },
  "required": [
    "PCID",
    "workflow_id",
    "workflow_email_id"
  ]
}

---

mailchimp_automations_get_id_emails_id_queue

List automated email subscribers

Parameters:

Parameter	Type	Required	Default	Description
workflow_id	string	Yes	—	The unique id for the Automation workflow.
workflow_email_id	string	Yes	—	The unique id for the Automation workflow email.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "workflow_id": {
      "type": "string",
      "description": "The unique id for the Automation workflow."
    },
    "workflow_email_id": {
      "type": "string",
      "description": "The unique id for the Automation workflow email."
    }
  },
  "required": [
    "PCID",
    "workflow_id",
    "workflow_email_id"
  ]
}

---

mailchimp_automations_get_id_emails_id_queue_id

Get automated email subscriber

Parameters:

Parameter	Type	Required	Default	Description
workflow_id	string	Yes	—	The unique id for the Automation workflow.
workflow_email_id	string	Yes	—	The unique id for the Automation workflow email.
subscriber_hash	string	Yes	—	The MD5 hash of the lowercase version of the list member’s email address.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "workflow_id": {
      "type": "string",
      "description": "The unique id for the Automation workflow."
    },
    "workflow_email_id": {
      "type": "string",
      "description": "The unique id for the Automation workflow email."
    },
    "subscriber_hash": {
      "type": "string",
      "description": "The MD5 hash of the lowercase version of the list member's email address."
    }
  },
  "required": [
    "PCID",
    "workflow_id",
    "workflow_email_id",
    "subscriber_hash"
  ]
}

---

mailchimp_automations_get_id_removed_subscribers

List subscribers removed from workflow

Parameters:

Parameter	Type	Required	Default	Description
workflow_id	string	Yes	—	The unique id for the Automation workflow.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "workflow_id": {
      "type": "string",
      "description": "The unique id for the Automation workflow."
    }
  },
  "required": [
    "PCID",
    "workflow_id"
  ]
}

---

mailchimp_automations_get_id_removed_subscribers_id

Get subscriber removed from workflow

Parameters:

Parameter	Type	Required	Default	Description
workflow_id	string	Yes	—	The unique id for the Automation workflow.
subscriber_hash	string	Yes	—	The MD5 hash of the lowercase version of the list member’s email address.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "workflow_id": {
      "type": "string",
      "description": "The unique id for the Automation workflow."
    },
    "subscriber_hash": {
      "type": "string",
      "description": "The MD5 hash of the lowercase version of the list member's email address."
    }
  },
  "required": [
    "PCID",
    "workflow_id",
    "subscriber_hash"
  ]
}

---

mailchimp_automations_patch_automation_email_workflow_id

Update workflow email

Parameters:

Parameter	Type	Required	Default	Description
workflow_id	string	Yes	—	The unique id for the Automation workflow.
workflow_email_id	string	Yes	—	The unique id for the Automation workflow email.
delay	object	No	—	The delay settings for an automation email.
settings	object	No	—	Settings for the campaign including the email subject, from name, and from email address.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "workflow_id": {
      "type": "string",
      "description": "The unique id for the Automation workflow."
    },
    "workflow_email_id": {
      "type": "string",
      "description": "The unique id for the Automation workflow email."
    },
    "delay": {
      "type": "object",
      "description": "The delay settings for an automation email.",
      "properties": {
        "amount": {
          "type": "integer",
          "description": "The delay amount for an automation email."
        },
        "type": {
          "type": "string",
          "description": "The type of delay for an automation email.",
          "enum": [
            "now",
            "day",
            "hour",
            "week"
          ]
        },
        "direction": {
          "type": "string",
          "description": "Whether the delay settings describe before or after the delay action of an automation email.",
          "enum": [
            "after"
          ]
        },
        "action": {
          "type": "string",
          "description": "The action that triggers the delay of an automation emails.",
          "enum": [
            "signup",
            "ecomm_abandoned_browse",
            "ecomm_abandoned_cart"
          ]
        }
      },
      "required": [
        "action"
      ]
    },
    "settings": {
      "type": "object",
      "description": "Settings for the campaign including the email subject, from name, and from email address.",
      "properties": {
        "subject_line": {
          "type": "string",
          "description": "The subject line for the campaign."
        },
        "preview_text": {
          "type": "string",
          "description": "The preview text for the campaign."
        },
        "title": {
          "type": "string",
          "description": "The title of the Automation."
        },
        "from_name": {
          "type": "string",
          "description": "The 'from' name for the Automation (not an email address)."
        },
        "reply_to": {
          "type": "string",
          "description": "The reply-to email address for the Automation."
        }
      }
    }
  },
  "required": [
    "PCID",
    "workflow_id",
    "workflow_email_id"
  ]
}

---

mailchimp_automations_post_automations

Add automation

Parameters:

Parameter	Type	Required	Default	Description
recipients	object	Yes	—	List settings for the Automation.
settings	object	No	—	The settings for the Automation workflow.
trigger_settings	object	Yes	—	Trigger settings for the Automation.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "recipients": {
      "type": "object",
      "description": "List settings for the Automation.",
      "properties": {
        "list_id": {
          "type": "string",
          "description": "The id of the List."
        },
        "store_id": {
          "type": "string",
          "description": "The id of the store."
        }
      }
    },
    "settings": {
      "type": "object",
      "description": "The settings for the Automation workflow.",
      "properties": {
        "from_name": {
          "type": "string",
          "description": "The 'from' name for the Automation (not an email address)."
        },
        "reply_to": {
          "type": "string",
          "description": "The reply-to email address for the Automation."
        }
      }
    },
    "trigger_settings": {
      "type": "object",
      "description": "Trigger settings for the Automation.",
      "properties": {
        "workflow_type": {
          "type": "string",
          "description": "The type of Automation workflow. Currently only supports 'abandonedCart'."
        }
      },
      "required": [
        "workflow_type"
      ]
    }
  },
  "required": [
    "PCID",
    "recipients",
    "trigger_settings"
  ]
}

---

mailchimp_automations_post_customer_journeys_journeys_id_steps_id_actions_trigger

Customer Journeys API trigger for a contact

Parameters:

Parameter	Type	Required	Default	Description
journey_id	integer	Yes	—	The id for the flow.
step_id	integer	Yes	—	The id for the Step.
email_address	string	Yes	—	The list member’s email address.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "journey_id": {
      "type": "integer",
      "description": "The id for the flow."
    },
    "step_id": {
      "type": "integer",
      "description": "The id for the Step."
    },
    "email_address": {
      "type": "string",
      "description": "The list member's email address."
    }
  },
  "required": [
    "PCID",
    "journey_id",
    "step_id",
    "email_address"
  ]
}

---

mailchimp_automations_post_id_actions_pause_all_emails

Pause automation emails

Parameters:

Parameter	Type	Required	Default	Description
workflow_id	string	Yes	—	The unique id for the Automation workflow.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "workflow_id": {
      "type": "string",
      "description": "The unique id for the Automation workflow."
    }
  },
  "required": [
    "PCID",
    "workflow_id"
  ]
}

---

mailchimp_automations_post_id_actions_start_all_emails

Start automation emails

Parameters:

Parameter	Type	Required	Default	Description
workflow_id	string	Yes	—	The unique id for the Automation workflow.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "workflow_id": {
      "type": "string",
      "description": "The unique id for the Automation workflow."
    }
  },
  "required": [
    "PCID",
    "workflow_id"
  ]
}

---

mailchimp_automations_post_id_emails_id_actions_pause

Pause automated email

Parameters:

Parameter	Type	Required	Default	Description
workflow_id	string	Yes	—	The unique id for the Automation workflow.
workflow_email_id	string	Yes	—	The unique id for the Automation workflow email.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "workflow_id": {
      "type": "string",
      "description": "The unique id for the Automation workflow."
    },
    "workflow_email_id": {
      "type": "string",
      "description": "The unique id for the Automation workflow email."
    }
  },
  "required": [
    "PCID",
    "workflow_id",
    "workflow_email_id"
  ]
}

---

mailchimp_automations_post_id_emails_id_actions_start

Start automated email

Parameters:

Parameter	Type	Required	Default	Description
workflow_id	string	Yes	—	The unique id for the Automation workflow.
workflow_email_id	string	Yes	—	The unique id for the Automation workflow email.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "workflow_id": {
      "type": "string",
      "description": "The unique id for the Automation workflow."
    },
    "workflow_email_id": {
      "type": "string",
      "description": "The unique id for the Automation workflow email."
    }
  },
  "required": [
    "PCID",
    "workflow_id",
    "workflow_email_id"
  ]
}

---

mailchimp_automations_post_id_emails_id_queue

Add subscriber to workflow email

Parameters:

Parameter	Type	Required	Default	Description
workflow_id	string	Yes	—	The unique id for the Automation workflow.
workflow_email_id	string	Yes	—	The unique id for the Automation workflow email.
email_address	string	Yes	—	The list member’s email address.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "workflow_id": {
      "type": "string",
      "description": "The unique id for the Automation workflow."
    },
    "workflow_email_id": {
      "type": "string",
      "description": "The unique id for the Automation workflow email."
    },
    "email_address": {
      "type": "string",
      "description": "The list member's email address."
    }
  },
  "required": [
    "PCID",
    "workflow_id",
    "workflow_email_id",
    "email_address"
  ]
}

---

mailchimp_automations_post_id_removed_subscribers

Remove subscriber from workflow

Parameters:

Parameter	Type	Required	Default	Description
workflow_id	string	Yes	—	The unique id for the Automation workflow.
email_address	string	Yes	—	The list member’s email address.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "workflow_id": {
      "type": "string",
      "description": "The unique id for the Automation workflow."
    },
    "email_address": {
      "type": "string",
      "description": "The list member's email address."
    }
  },
  "required": [
    "PCID",
    "workflow_id",
    "email_address"
  ]
}