Update workflow email

PATCH

https://api.mailchimp.com/3.0/automations/:workflow_id/emails/:workflow_email_id

PATCH

/3.0/automations/:workflow_id/emails/:workflow_email_id

curl -X PATCH https://api.mailchimp.com/3.0/automations/workflow_id/emails/workflow_email_id \
     -H "Authorization: Bearer <token>" \
     -H "Content-Type: application/json" \
     -d '{}'

200Updated

{
  "_links": [
    {
      "href": "string",
      "method": "GET",
      "rel": "string",
      "schema": "string",
      "targetSchema": "string"
    }
  ],
  "archive_url": "string",
  "content_type": "string",
  "create_time": "2024-01-15T09:30:00Z",
  "delay": {
    "action": "previous_campaign_sent",
    "action_description": "subscribers purchase anything from your store",
    "amount": 1,
    "direction": "before",
    "full_description": "1 day after subscribers purchase anything from your store",
    "type": "now"
  },
  "emails_sent": 1,
  "has_logo_merge_tag": true,
  "id": "string",
  "needs_block_refresh": true,
  "position": 1,
  "recipients": {
    "list_id": "string",
    "list_is_active": true,
    "list_name": "string",
    "recipient_count": 1,
    "segment_opts": {
      "conditions": [
        {
          "condition_type": "Aim",
          "field": "aim",
          "op": "open",
          "value": "any"
        }
      ],
      "match": "any",
      "prebuilt_segment_id": "subscribers-female",
      "saved_segment_id": 1
    },
    "segment_text": "string"
  },
  "report_summary": {
    "click_rate": 1.1,
    "clicks": 1,
    "open_rate": 1.1,
    "opens": 1,
    "subscriber_clicks": 1,
    "unique_opens": 1
  },
  "send_time": "2024-01-15T09:30:00Z",
  "settings": {
    "authenticate": true,
    "auto_fb_post": [
      "string"
    ],
    "auto_footer": true,
    "auto_tweet": true,
    "drag_and_drop": true,
    "fb_comments": true,
    "from_name": "string",
    "inline_css": true,
    "preview_text": "string",
    "reply_to": "string",
    "subject_line": "string",
    "template_id": 1,
    "title": "string"
  },
  "social_card": {
    "description": "string",
    "image_url": "string",
    "title": "string"
  },
  "start_time": "2024-01-15T09:30:00Z",
  "status": "save",
  "tracking": {
    "capsule": {
      "notes": true
    },
    "clicktale": "string",
    "ecomm360": true,
    "goal_tracking": true,
    "google_analytics": "string",
    "html_clicks": true,
    "opens": true,
    "salesforce": {
      "campaign": true,
      "notes": true
    },
    "text_clicks": true
  },
  "trigger_settings": {
    "workflow_type": "abandonedBrowse",
    "runtime": {
      "days": [
        "sunday"
      ],
      "hours": {
        "type": "send_asap"
      }
    },
    "workflow_emails_count": 1,
    "workflow_title": "string"
  },
  "web_id": 33345484,
  "workflow_id": "string"
}

Update settings for a classic automation workflow email. Only works with workflows of type: abandonedBrowse, abandonedCart, emailFollowup, or singleWelcome.

Authentication

AuthorizationBearer

Authorization using a Mailchimp API key (a.k.a. Bearer token)

AuthorizationBearer

Authorization using OAuth

Path parameters

workflow_idstringRequired

The unique id for the Automation workflow.

workflow_email_idstringRequired

The unique id for the Automation workflow email.

Request

Update information about an individual Automation workflow email.

delayobjectOptional

The delay settings for an automation email.

settingsobjectOptional

Settings for the campaign including the email subject, from name, and from email address.

Response

This endpoint returns an object.

_linkslist of objectsOptionalRead-only

A list of link types and descriptions for the API schema documents.

archive_urlstringOptionalRead-only

The link to the campaign's archive version in ISO 8601 format.

content_typestringOptionalRead-only

How the campaign's content is put together ('template', 'drag_and_drop', 'html', 'url').

create_timedatetimeOptionalRead-only

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

delayobjectOptional

The delay settings for an Automation email.

emails_sentintegerOptionalRead-only

The total number of emails sent for this campaign.

has_logo_merge_tagbooleanOptionalRead-only

Determines if the campaign contains the |BRAND:LOGO| merge tag.

idstringOptionalRead-only

A string that uniquely identifies the Automation email.

needs_block_refreshbooleanOptionalRead-only

Determines if the automation email needs its blocks refreshed by opening the web-based campaign editor.

positionintegerOptionalRead-only

The position of an Automation email in a workflow.

recipientsobjectOptional

List settings for the campaign.

report_summaryobjectOptional

For sent campaigns, a summary of opens and clicks.

send_timedatetimeOptionalRead-only

The date and time a campaign was sent in ISO 8601 format

settingsobjectOptional

Settings for the campaign including the email subject, from name, and from email address.

social_cardobjectOptional

The preview for the campaign, rendered by social networks like Facebook and Twitter. Learn more.

start_timedatetimeOptionalRead-only

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

statusenumOptionalRead-only

The current status of the campaign.

Allowed values:

trackingobjectOptional

The tracking options for a campaign.

trigger_settingsobjectOptional

Available triggers for Automation workflows.

web_idintegerOptionalRead-only

The ID used in the Mailchimp web application. View this automation in your Mailchimp account at https://{dc}.admin.mailchimp.com/campaigns/show/?id={web_id}.

workflow_idstringOptionalRead-only

A string that uniquely identifies an Automation workflow.