Skip to main content
Server path: /mailchimp-automations | Type: Application | PCID required: Yes

Tools


mailchimp_automations_archive_automations

Archive automation Parameters:
ParameterTypeRequiredDefaultDescription
workflow_idstringYesThe unique id for the Automation workflow.

mailchimp_automations_delete_id_emails_id

Delete workflow email Parameters:
ParameterTypeRequiredDefaultDescription
workflow_idstringYesThe unique id for the Automation workflow.
workflow_email_idstringYesThe unique id for the Automation workflow email.

mailchimp_automations_get_automations

List automations Parameters:
ParameterTypeRequiredDefaultDescription
countintegerNoThe number of records to return. Default value is 10. Maximum value is 1000
offsetintegerNoUsed for pagination, this is the number of records from a collection to skip. Default value is 0.
fieldsstring[]NoA comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.
exclude_fieldsstring[]NoA comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.
before_create_timestringNoRestrict the response to automations created before this time. Uses the ISO 8601 time format: 2015-10-21T15:41:36+00:00.
since_create_timestringNoRestrict the response to automations created after this time. Uses the ISO 8601 time format: 2015-10-21T15:41:36+00:00.
before_start_timestringNoRestrict the response to automations started before this time. Uses the ISO 8601 time format: 2015-10-21T15:41:36+00:00.
since_start_timestringNoRestrict the response to automations started after this time. Uses the ISO 8601 time format: 2015-10-21T15:41:36+00:00.
statusstringNoRestrict the results to automations with the specified status.

mailchimp_automations_get_id

Get automation info Parameters:
ParameterTypeRequiredDefaultDescription
fieldsstring[]NoA comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.
exclude_fieldsstring[]NoA comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.
workflow_idstringYesThe unique id for the Automation workflow.

mailchimp_automations_get_id_emails

List automated emails Parameters:
ParameterTypeRequiredDefaultDescription
workflow_idstringYesThe unique id for the Automation workflow.

mailchimp_automations_get_id_emails_id

Get workflow email info Parameters:
ParameterTypeRequiredDefaultDescription
workflow_idstringYesThe unique id for the Automation workflow.
workflow_email_idstringYesThe unique id for the Automation workflow email.

mailchimp_automations_get_id_emails_id_queue

List automated email subscribers Parameters:
ParameterTypeRequiredDefaultDescription
workflow_idstringYesThe unique id for the Automation workflow.
workflow_email_idstringYesThe unique id for the Automation workflow email.

mailchimp_automations_get_id_emails_id_queue_id

Get automated email subscriber Parameters:
ParameterTypeRequiredDefaultDescription
workflow_idstringYesThe unique id for the Automation workflow.
workflow_email_idstringYesThe unique id for the Automation workflow email.
subscriber_hashstringYesThe MD5 hash of the lowercase version of the list member’s email address.

mailchimp_automations_get_id_removed_subscribers

List subscribers removed from workflow Parameters:
ParameterTypeRequiredDefaultDescription
workflow_idstringYesThe unique id for the Automation workflow.

mailchimp_automations_get_id_removed_subscribers_id

Get subscriber removed from workflow Parameters:
ParameterTypeRequiredDefaultDescription
workflow_idstringYesThe unique id for the Automation workflow.
subscriber_hashstringYesThe MD5 hash of the lowercase version of the list member’s email address.

mailchimp_automations_patch_automation_email_workflow_id

Update workflow email Parameters:
ParameterTypeRequiredDefaultDescription
workflow_idstringYesThe unique id for the Automation workflow.
workflow_email_idstringYesThe unique id for the Automation workflow email.
delayobjectNoThe delay settings for an automation email.
settingsobjectNoSettings for the campaign including the email subject, from name, and from email address.

mailchimp_automations_post_automations

Add automation Parameters:
ParameterTypeRequiredDefaultDescription
recipientsobjectYesList settings for the Automation.
settingsobjectNoThe settings for the Automation workflow.
trigger_settingsobjectYesTrigger settings for the Automation.

mailchimp_automations_post_customer_journeys_journeys_id_steps_id_actions_trigger

Customer Journeys API trigger for a contact Parameters:
ParameterTypeRequiredDefaultDescription
journey_idintegerYesThe id for the flow.
step_idintegerYesThe id for the Step.
email_addressstringYesThe list member’s email address.

mailchimp_automations_post_id_actions_pause_all_emails

Pause automation emails Parameters:
ParameterTypeRequiredDefaultDescription
workflow_idstringYesThe unique id for the Automation workflow.

mailchimp_automations_post_id_actions_start_all_emails

Start automation emails Parameters:
ParameterTypeRequiredDefaultDescription
workflow_idstringYesThe unique id for the Automation workflow.

mailchimp_automations_post_id_emails_id_actions_pause

Pause automated email Parameters:
ParameterTypeRequiredDefaultDescription
workflow_idstringYesThe unique id for the Automation workflow.
workflow_email_idstringYesThe unique id for the Automation workflow email.

mailchimp_automations_post_id_emails_id_actions_start

Start automated email Parameters:
ParameterTypeRequiredDefaultDescription
workflow_idstringYesThe unique id for the Automation workflow.
workflow_email_idstringYesThe unique id for the Automation workflow email.

mailchimp_automations_post_id_emails_id_queue

Add subscriber to workflow email Parameters:
ParameterTypeRequiredDefaultDescription
workflow_idstringYesThe unique id for the Automation workflow.
workflow_email_idstringYesThe unique id for the Automation workflow email.
email_addressstringYesThe list member’s email address.

mailchimp_automations_post_id_removed_subscribers

Remove subscriber from workflow Parameters:
ParameterTypeRequiredDefaultDescription
workflow_idstringYesThe unique id for the Automation workflow.
email_addressstringYesThe list member’s email address.