Class Automations

MailChimp\MailChimp

Extended by

MailChimp\Automations\Automations

Namespace: MailChimp\Automations
Located at Automations/Automations.php

Methods summary

`public object`	# `getAutomations( array $query = [] )` Get a summary of an account’s Automations. Get a summary of an account’s Automations. array["fields"] array list of strings of response fields to return array["exclude_fields"] array list of strings of response fields to exclude (not to be used with "fields") Parameters `$query` (See Above) OPTIONAL associative array of query parameters. Returns object
`public object`	# `getAutomation( string $workflow_id, array $query = [] )` Get a summary of an individual Automation workflow’s settings and content. Get a summary of an individual Automation workflow’s settings and content. array["fields"] array list of strings of response fields to return array["exclude_fields"] array list of strings of response fields to exclude (not to be used with "fields") Parameters `$workflow_id` `$query` (See Above) OPTIONAL associative array of query parameters. Returns object
`public`	# `startAutomation( string $workflow_id )` Start all emails in an Automation workflow. Start all emails in an Automation workflow. Parameters `$workflow_id`
`public`	# `pauseAutomation( string $workflow_id )` Pause all emails in an Automation workflow. Pause all emails in an Automation workflow. Parameters `$workflow_id`
`public object`	# `getWorkflowEmails( string $workflow_id, array $query = [] )` Get a list of automated emails in a workflow Get a list of automated emails in a workflow array["fields"] array list of strings of response fields to return array["exclude_fields"] array list of strings of response fields to exclude (not to be used with "fields") Parameters `$workflow_id` `$query` (See Above) OPTIONAL associative array of query parameters. Returns object
`public object`	# `getWorkflowEmail( string $workflow_id, string $workflow_email_id, array $query = [] )` Get information about a specific workflow email Get information about a specific workflow email array["fields"] array list of strings of response fields to return array["exclude_fields"] array list of strings of response fields to exclude (not to be used with "fields") Parameters `$workflow_id` `$workflow_email_id` `$query` (See Above) OPTIONAL associative array of query parameters. Returns object
`public`	# `startWorkflowEmail( string $workflow_id, string $workflow_email_id )` Start an automated email Start an automated email Parameters `$workflow_id` `$workflow_email_id`
`public`	# `pauseWorkflowEmail( string $workflow_id, string $workflow_email_id )` Pause an automated email Pause an automated email Parameters `$workflow_id` `$workflow_email_id`
`public object`	# `getWorkflowEmailQueue( string $workflow_id, string $workflow_email_id, array $query = [] )` View queued subscribers for an automated email View queued subscribers for an automated email array["fields"] array list of strings of response fields to return array["exclude_fields"] array list of strings of response fields to exclude (not to be used with "fields") Parameters `$workflow_id` `$workflow_email_id` `$query` (See Above) OPTIONAL associative array of query parameters. Returns object
`public object`	# `getWorkflowEmailSubscriber( string $workflow_id, string $workflow_email_id, string $email_address, array $query = [] )` View specific subscriber in email queue View specific subscriber in email queue array["fields"] array list of strings of response fields to return array["exclude_fields"] array list of strings of response fields to exclude (not to be used with "fields") Parameters `$workflow_id` `$workflow_email_id` `$email_address` `$query` (See Above) OPTIONAL associative array of query parameters. Returns object
`public`	# `addWorkflowEmailSubscriber( string $workflow_id, string $workflow_email_id, string $email_address )` Add a subscriber to a workflow email Add a subscriber to a workflow email Parameters `$workflow_id` `$workflow_email_id` `$email_address`
`public`	# `getRemovedWorkflowSubscribers( string $workflow_id, array $query = [] )` View all subscribers removed from a workflow View all subscribers removed from a workflow array["fields"] array list of strings of response fields to return array["exclude_fields"] array list of strings of response fields to exclude (not to be used with "fields") Parameters `$workflow_id` `$query`
`public`	# `removeWorkflowSubscriber( string $workflow_id, string $email_address, string $email_address,… )` Remove subscriber from a workflow Remove subscriber from a workflow Parameters `$workflow_id` `$email_address` $workflow_email_id `$email_address`,…

Methods inherited from MailChimp\MailChimp

__construct(), authorizedApps(), automations(), batchOps(), campaignFolders(), campaigns(), conversations(), createLog(), ecommerce(), execute(), fileManager(), fileManagerFolders(), getAccountInfo(), getMemberHash(), lists(), logData(), optionalFields(), reports(), searchMembers(), templateFolders(), templates()