automations

Get automation info

Get a summary of an individual classic automation workflow's settings and content. The trigger_settings object returns information for the first email in the workflow.

get/3.0/automations/{workflow_id}

Request

Base URL
https://api.mailchimp.com
Auth
- HTTP bearer
- or OAuth 2
  Authorization codehttps://login.mailchimp.com/oauth2/authorize
  Token URLhttps://login.mailchimp.com/oauth2/token
TypeScript
https://skmtc.dev/mailchimp/apis/mailchimp-api/docs/3.0/automations/:workflow_id/get.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

workflow_idstring required

The unique id for the Automation workflow.

Query parameters

fieldsstring[]

A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.

exclude_fieldsstring[]

A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.

Response

create_timestring date-time

The date and time the Automation was created in ISO 8601 format.

emails_sentinteger

The total number of emails sent for the Automation.

idstring

A string that identifies the Automation.

start_timestring date-time

The date and time the Automation was started in ISO 8601 format.

status'save' | 'paused' | 'sending'

The current status of the Automation.

Example response

{
  "recipients": {
    "segment_opts": [
      {
        "field": "aim",
        "op": "open",
        "value": "any"
      }
    ],
    "store_id": "1a2df69xxx"
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.