Query structured spec data via REST or MCP. Get exactly what your agent needs.
https://server.api.mailchimp.com/3.0
/account-exports/{export_id}
Get information about a specific account export.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| fields | query | optional | array | A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation. |
| exclude_fields | query | optional | array | A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation. |
| export_id | path | required | string | The unique id for the account export. |
An error generated by the Mailchimp API.
GET /account-exports/{export_id}
/account-exports
Get a list of account exports for a given account.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| fields | query | optional | array | A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation. |
| exclude_fields | query | optional | array | A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation. |
| count | query | optional | integer | The number of records to return. Default value is 10. Maximum value is 1000 |
| offset | query | optional | integer | Used for pagination, this it the number of records from a collection to skip. Default value is 0. |
An error generated by the Mailchimp API.
GET /account-exports
/activity-feed/chimp-chatter
Return the Chimp Chatter for this account ordered by most recent.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| count | query | optional | integer | The number of records to return. Default value is 10. Maximum value is 1000 |
| offset | query | optional | integer | Used for pagination, this it the number of records from a collection to skip. Default value is 0. |
An error generated by the Mailchimp API.
ChimpChatter Collection
GET /activity-feed/chimp-chatter
/authorized-apps
Get a list of an account’s registered, connected applications.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| fields | query | optional | array | A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation. |
| exclude_fields | query | optional | array | A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation. |
| count | query | optional | integer | The number of records to return. Default value is 10. Maximum value is 1000 |
| offset | query | optional | integer | Used for pagination, this it the number of records from a collection to skip. Default value is 0. |
An error generated by the Mailchimp API.
GET /authorized-apps
/authorized-apps/{app_id}
Get information about a specific authorized application.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| fields | query | optional | array | A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation. |
| exclude_fields | query | optional | array | A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation. |
| app_id | path | required | string | The unique id for the connected authorized application. |
An error generated by the Mailchimp API.
GET /authorized-apps/{app_id}
/automations
Get a summary of an account’s classic automations.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| count | query | optional | integer | The number of records to return. Default value is 10. Maximum value is 1000 |
| offset | query | optional | integer | Used for pagination, this it the number of records from a collection to skip. Default value is 0. |
| fields | query | optional | array | A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation. |
| exclude_fields | query | optional | array | A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation. |
| before_create_time | query | optional | string | 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 | query | optional | string | 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 | query | optional | string | 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 | query | optional | string | Restrict the response to automations started after this time. Uses the ISO 8601 time format: 2015-10-21T15:41:36+00:00. |
| status | query | optional | string | Restrict the results to automations with the specified status. |
An error generated by the Mailchimp API.
GET /automations
/automations/{workflow_id}
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.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| fields | query | optional | array | A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation. |
| exclude_fields | query | optional | array | A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation. |
| workflow_id | path | required | string | The unique id for the Automation workflow. |
An error generated by the Mailchimp API.
GET /automations/{workflow_id}
/automations/{workflow_id}/emails
Get a summary of the emails in a classic automation workflow.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| workflow_id | path | required | string | The unique id for the Automation workflow. |
An error generated by the Mailchimp API.
GET /automations/{workflow_id}/emails
/automations/{workflow_id}/emails/{workflow_email_id}
Get information about an individual classic automation workflow email.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| workflow_id | path | required | string | The unique id for the Automation workflow. |
| workflow_email_id | path | required | string | The unique id for the Automation workflow email. |
An error generated by the Mailchimp API.
GET /automations/{workflow_id}/emails/{workflow_email_id}
/automations/{workflow_id}/emails/{workflow_email_id}/queue
Get information about a classic automation email queue.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| workflow_id | path | required | string | The unique id for the Automation workflow. |
| workflow_email_id | path | required | string | The unique id for the Automation workflow email. |
An error generated by the Mailchimp API.
GET /automations/{workflow_id}/emails/{workflow_email_id}/queue
/automations/{workflow_id}/emails/{workflow_email_id}/queue/{subscriber_hash}
Get information about a specific subscriber in a classic automation email queue.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| workflow_id | path | required | string | The unique id for the Automation workflow. |
| workflow_email_id | path | required | string | The unique id for the Automation workflow email. |
| subscriber_hash | path | required | string | The MD5 hash of the lowercase version of the list member’s email address. |
An error generated by the Mailchimp API.
GET /automations/{workflow_id}/emails/{workflow_email_id}/queue/{subscriber_hash}
/automations/{workflow_id}/removed-subscribers
Get information about subscribers who were removed from a classic automation workflow.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| workflow_id | path | required | string | The unique id for the Automation workflow. |
An error generated by the Mailchimp API.
GET /automations/{workflow_id}/removed-subscribers
/automations/{workflow_id}/removed-subscribers/{subscriber_hash}
Get information about a specific subscriber who was removed from a classic automation workflow.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| workflow_id | path | required | string | The unique id for the Automation workflow. |
| subscriber_hash | path | required | string | The MD5 hash of the lowercase version of the list member’s email address. |
An error generated by the Mailchimp API.
GET /automations/{workflow_id}/removed-subscribers/{subscriber_hash}
/batch-webhooks
Get all webhooks that have been configured for batches.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| fields | query | optional | array | A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation. |
| exclude_fields | query | optional | array | A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation. |
| count | query | optional | integer | The number of records to return. Default value is 10. Maximum value is 1000 |
| offset | query | optional | integer | Used for pagination, this it the number of records from a collection to skip. Default value is 0. |
An error generated by the Mailchimp API.
GET /batch-webhooks
/batch-webhooks/{batch_webhook_id}
Get information about a specific batch webhook.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| fields | query | optional | array | A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation. |
| exclude_fields | query | optional | array | A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation. |
| batch_webhook_id | path | required | string | The unique id for the batch webhook. |
An error generated by the Mailchimp API.
GET /batch-webhooks/{batch_webhook_id}
/batches
Get a summary of batch requests that have been made.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| fields | query | optional | array | A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation. |
| exclude_fields | query | optional | array | A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation. |
| count | query | optional | integer | The number of records to return. Default value is 10. Maximum value is 1000 |
| offset | query | optional | integer | Used for pagination, this it the number of records from a collection to skip. Default value is 0. |
An error generated by the Mailchimp API.
GET /batches
/batches/{batch_id}
Get the status of a batch request.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| fields | query | optional | array | A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation. |
| exclude_fields | query | optional | array | A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation. |
| batch_id | path | required | string | The unique id for the batch operation. |
An error generated by the Mailchimp API.
GET /batches/{batch_id}
/campaign-folders
Get all folders used to organize campaigns.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| fields | query | optional | array | A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation. |
| exclude_fields | query | optional | array | A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation. |
| count | query | optional | integer | The number of records to return. Default value is 10. Maximum value is 1000 |
| offset | query | optional | integer | Used for pagination, this it the number of records from a collection to skip. Default value is 0. |
An error generated by the Mailchimp API.
GET /campaign-folders
/campaign-folders/{folder_id}
Get information about a specific folder used to organize campaigns.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| fields | query | optional | array | A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation. |
| exclude_fields | query | optional | array | A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation. |
| folder_id | path | required | string | The unique id for the campaign folder. |
An error generated by the Mailchimp API.
GET /campaign-folders/{folder_id}
/campaigns
Get all campaigns in an account.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| fields | query | optional | array | A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation. |
| exclude_fields | query | optional | array | A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation. |
| count | query | optional | integer | The number of records to return. Default value is 10. Maximum value is 1000 |
| offset | query | optional | integer | Used for pagination, this it the number of records from a collection to skip. Default value is 0. |
| type | query | optional | string | The campaign type. |
| status | query | optional | string | The status of the campaign. |
| before_send_time | query | optional | string | Restrict the response to campaigns sent before the set time. Uses ISO 8601 time format: 2015-10-21T15:41:36+00:00. |
| since_send_time | query | optional | string | Restrict the response to campaigns sent after the set time. Uses ISO 8601 time format: 2015-10-21T15:41:36+00:00. |
| before_create_time | query | optional | string | Restrict the response to campaigns created before the set time. Uses ISO 8601 time format: 2015-10-21T15:41:36+00:00. |
| since_create_time | query | optional | string | Restrict the response to campaigns created after the set time. Uses ISO 8601 time format: 2015-10-21T15:41:36+00:00. |
| list_id | query | optional | string | The unique id for the list. |
| folder_id | query | optional | string | The unique folder id. |
| member_id | query | optional | string | Retrieve campaigns sent to a particular list member. Member ID is The MD5 hash of the lowercase version of the list member’s email address. |
| sort_field | query | optional | string | Returns files sorted by the specified field. |
| sort_dir | query | optional | string | Determines the order direction for sorted results. |
| include_resend_shortcut_eligibility | query | optional | boolean | Return the |
An error generated by the Mailchimp API.
GET /campaigns
/campaigns/{campaign_id}
Get information about a specific campaign.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| fields | query | optional | array | A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation. |
| exclude_fields | query | optional | array | A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation. |
| campaign_id | path | required | string | The unique id for the campaign. |
| include_resend_shortcut_eligibility | query | optional | boolean | Return the |
An error generated by the Mailchimp API.
GET /campaigns/{campaign_id}
/campaigns/{campaign_id}/content
Get the the HTML and plain-text content for a campaign.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| fields | query | optional | array | A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation. |
| exclude_fields | query | optional | array | A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation. |
| campaign_id | path | required | string | The unique id for the campaign. |
An error generated by the Mailchimp API.
GET /campaigns/{campaign_id}/content
/campaigns/{campaign_id}/feedback
Get team feedback while you’re working together on a Mailchimp campaign.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| fields | query | optional | array | A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation. |
| exclude_fields | query | optional | array | A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation. |
| campaign_id | path | required | string | The unique id for the campaign. |
An error generated by the Mailchimp API.
GET /campaigns/{campaign_id}/feedback
/campaigns/{campaign_id}/feedback/{feedback_id}
Get a specific feedback message from a campaign.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| fields | query | optional | array | A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation. |
| exclude_fields | query | optional | array | A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation. |
| campaign_id | path | required | string | The unique id for the campaign. |
| feedback_id | path | required | string | The unique id for the feedback message. |
An error generated by the Mailchimp API.
GET /campaigns/{campaign_id}/feedback/{feedback_id}
/campaigns/{campaign_id}/send-checklist
Review the send checklist for a campaign, and resolve any issues before sending.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| fields | query | optional | array | A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation. |
| exclude_fields | query | optional | array | A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation. |
| campaign_id | path | required | string | The unique id for the campaign. |
An error generated by the Mailchimp API.
GET /campaigns/{campaign_id}/send-checklist
/connected-sites
Get all connected sites in an account.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| fields | query | optional | array | A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation. |
| exclude_fields | query | optional | array | A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation. |
| count | query | optional | integer | The number of records to return. Default value is 10. Maximum value is 1000 |
| offset | query | optional | integer | Used for pagination, this it the number of records from a collection to skip. Default value is 0. |
An error generated by the Mailchimp API.
GET /connected-sites
/connected-sites/{connected_site_id}
Get information about a specific connected site.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| fields | query | optional | array | A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation. |
| exclude_fields | query | optional | array | A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation. |
| connected_site_id | path | required | string | The unique identifier for the site. |
An error generated by the Mailchimp API.
GET /connected-sites/{connected_site_id}
/ecommerce/orders
Get information about an account’s orders.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| fields | query | optional | array | A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation. |
| exclude_fields | query | optional | array | A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation. |
| count | query | optional | integer | The number of records to return. Default value is 10. Maximum value is 1000 |
| offset | query | optional | integer | Used for pagination, this it the number of records from a collection to skip. Default value is 0. |
| campaign_id | query | optional | string | Restrict results to orders with a specific |
| outreach_id | query | optional | string | Restrict results to orders with a specific |
| customer_id | query | optional | string | Restrict results to orders made by a specific customer. |
| has_outreach | query | optional | boolean | Restrict results to orders that have an outreach attached. For example, an email campaign or Facebook ad. |
An error generated by the Mailchimp API.
GET /ecommerce/orders
/ecommerce/stores
Get information about all stores in the account.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| fields | query | optional | array | A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation. |
| exclude_fields | query | optional | array | A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation. |
| count | query | optional | integer | The number of records to return. Default value is 10. Maximum value is 1000 |
| offset | query | optional | integer | Used for pagination, this it the number of records from a collection to skip. Default value is 0. |
An error generated by the Mailchimp API.
GET /ecommerce/stores
/ecommerce/stores/{store_id}
Get information about a specific store.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| fields | query | optional | array | A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation. |
| exclude_fields | query | optional | array | A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation. |
| store_id | path | required | string | The store id. |
An error generated by the Mailchimp API.
GET /ecommerce/stores/{store_id}
/ecommerce/stores/{store_id}/carts
Get information about a store’s carts.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| fields | query | optional | array | A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation. |
| exclude_fields | query | optional | array | A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation. |
| count | query | optional | integer | The number of records to return. Default value is 10. Maximum value is 1000 |
| offset | query | optional | integer | Used for pagination, this it the number of records from a collection to skip. Default value is 0. |
| store_id | path | required | string | The store id. |
An error generated by the Mailchimp API.
GET /ecommerce/stores/{store_id}/carts
/ecommerce/stores/{store_id}/carts/{cart_id}
Get information about a specific cart.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| fields | query | optional | array | A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation. |
| exclude_fields | query | optional | array | A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation. |
| store_id | path | required | string | The store id. |
| cart_id | path | required | string | The id for the cart. |
An error generated by the Mailchimp API.
GET /ecommerce/stores/{store_id}/carts/{cart_id}
/ecommerce/stores/{store_id}/carts/{cart_id}/lines
Get information about a cart’s line items.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| fields | query | optional | array | A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation. |
| exclude_fields | query | optional | array | A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation. |
| count | query | optional | integer | The number of records to return. Default value is 10. Maximum value is 1000 |
| offset | query | optional | integer | Used for pagination, this it the number of records from a collection to skip. Default value is 0. |
| store_id | path | required | string | The store id. |
| cart_id | path | required | string | The id for the cart. |
An error generated by the Mailchimp API.
GET /ecommerce/stores/{store_id}/carts/{cart_id}/lines
/ecommerce/stores/{store_id}/carts/{cart_id}/lines/{line_id}
Get information about a specific cart line item.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| fields | query | optional | array | A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation. |
| exclude_fields | query | optional | array | A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation. |
| store_id | path | required | string | The store id. |
| cart_id | path | required | string | The id for the cart. |
| line_id | path | required | string | The id for the line item of a cart. |
An error generated by the Mailchimp API.
GET /ecommerce/stores/{store_id}/carts/{cart_id}/lines/{line_id}
/ecommerce/stores/{store_id}/customers
Get information about a store’s customers.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| fields | query | optional | array | A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation. |
| exclude_fields | query | optional | array | A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation. |
| count | query | optional | integer | The number of records to return. Default value is 10. Maximum value is 1000 |
| offset | query | optional | integer | Used for pagination, this it the number of records from a collection to skip. Default value is 0. |
| store_id | path | required | string | The store id. |
| email_address | query | optional | string | Restrict the response to customers with the email address. |
An error generated by the Mailchimp API.
GET /ecommerce/stores/{store_id}/customers
/ecommerce/stores/{store_id}/customers/{customer_id}
Get information about a specific customer.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| fields | query | optional | array | A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation. |
| exclude_fields | query | optional | array | A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation. |
| store_id | path | required | string | The store id. |
| customer_id | path | required | string | The id for the customer of a store. |
An error generated by the Mailchimp API.
GET /ecommerce/stores/{store_id}/customers/{customer_id}
/ecommerce/stores/{store_id}/orders
Get information about a store’s orders.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| fields | query | optional | array | A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation. |
| exclude_fields | query | optional | array | A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation. |
| count | query | optional | integer | The number of records to return. Default value is 10. Maximum value is 1000 |
| offset | query | optional | integer | Used for pagination, this it the number of records from a collection to skip. Default value is 0. |
| store_id | path | required | string | The store id. |
| customer_id | query | optional | string | Restrict results to orders made by a specific customer. |
| has_outreach | query | optional | boolean | Restrict results to orders that have an outreach attached. For example, an email campaign or Facebook ad. |
| campaign_id | query | optional | string | Restrict results to orders with a specific |
| outreach_id | query | optional | string | Restrict results to orders with a specific |
An error generated by the Mailchimp API.
GET /ecommerce/stores/{store_id}/orders
/ecommerce/stores/{store_id}/orders/{order_id}
Get information about a specific order.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| fields | query | optional | array | A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation. |
| exclude_fields | query | optional | array | A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation. |
| store_id | path | required | string | The store id. |
| order_id | path | required | string | The id for the order in a store. |
An error generated by the Mailchimp API.
GET /ecommerce/stores/{store_id}/orders/{order_id}
/ecommerce/stores/{store_id}/orders/{order_id}/lines
Get information about an order’s line items.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| fields | query | optional | array | A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation. |
| exclude_fields | query | optional | array | A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation. |
| count | query | optional | integer | The number of records to return. Default value is 10. Maximum value is 1000 |
| offset | query | optional | integer | Used for pagination, this it the number of records from a collection to skip. Default value is 0. |
| store_id | path | required | string | The store id. |
| order_id | path | required | string | The id for the order in a store. |
An error generated by the Mailchimp API.
GET /ecommerce/stores/{store_id}/orders/{order_id}/lines
/ecommerce/stores/{store_id}/orders/{order_id}/lines/{line_id}
Get information about a specific order line item.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| fields | query | optional | array | A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation. |
| exclude_fields | query | optional | array | A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation. |
| store_id | path | required | string | The store id. |
| order_id | path | required | string | The id for the order in a store. |
| line_id | path | required | string | The id for the line item of an order. |
An error generated by the Mailchimp API.
GET /ecommerce/stores/{store_id}/orders/{order_id}/lines/{line_id}
/ecommerce/stores/{store_id}/products
Get information about a store’s products.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| fields | query | optional | array | A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation. |
| exclude_fields | query | optional | array | A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation. |
| count | query | optional | integer | The number of records to return. Default value is 10. Maximum value is 1000 |
| offset | query | optional | integer | Used for pagination, this it the number of records from a collection to skip. Default value is 0. |
| store_id | path | required | string | The store id. |
An error generated by the Mailchimp API.
GET /ecommerce/stores/{store_id}/products
/ecommerce/stores/{store_id}/products/{product_id}
Get information about a specific product.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| fields | query | optional | array | A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation. |
| exclude_fields | query | optional | array | A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation. |
| store_id | path | required | string | The store id. |
| product_id | path | required | string | The id for the product of a store. |
An error generated by the Mailchimp API.
GET /ecommerce/stores/{store_id}/products/{product_id}
/ecommerce/stores/{store_id}/products/{product_id}/images
Get information about a product’s images.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| fields | query | optional | array | A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation. |
| exclude_fields | query | optional | array | A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation. |
| count | query | optional | integer | The number of records to return. Default value is 10. Maximum value is 1000 |
| offset | query | optional | integer | Used for pagination, this it the number of records from a collection to skip. Default value is 0. |
| store_id | path | required | string | The store id. |
| product_id | path | required | string | The id for the product of a store. |
An error generated by the Mailchimp API.
GET /ecommerce/stores/{store_id}/products/{product_id}/images
/ecommerce/stores/{store_id}/products/{product_id}/images/{image_id}
Get information about a specific product image.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| fields | query | optional | array | A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation. |
| exclude_fields | query | optional | array | A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation. |
| store_id | path | required | string | The store id. |
| product_id | path | required | string | The id for the product of a store. |
| image_id | path | required | string | The id for the product image. |
An error generated by the Mailchimp API.
GET /ecommerce/stores/{store_id}/products/{product_id}/images/{image_id}
/ecommerce/stores/{store_id}/products/{product_id}/variants
Get information about a product’s variants.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| fields | query | optional | array | A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation. |
| exclude_fields | query | optional | array | A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation. |
| count | query | optional | integer | The number of records to return. Default value is 10. Maximum value is 1000 |
| offset | query | optional | integer | Used for pagination, this it the number of records from a collection to skip. Default value is 0. |
| store_id | path | required | string | The store id. |
| product_id | path | required | string | The id for the product of a store. |
An error generated by the Mailchimp API.
GET /ecommerce/stores/{store_id}/products/{product_id}/variants
/ecommerce/stores/{store_id}/products/{product_id}/variants/{variant_id}
Get information about a specific product variant.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| fields | query | optional | array | A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation. |
| exclude_fields | query | optional | array | A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation. |
| store_id | path | required | string | The store id. |
| product_id | path | required | string | The id for the product of a store. |
| variant_id | path | required | string | The id for the product variant. |
An error generated by the Mailchimp API.
GET /ecommerce/stores/{store_id}/products/{product_id}/variants/{variant_id}
/ecommerce/stores/{store_id}/promo-rules
Get information about a store’s promo rules.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| fields | query | optional | array | A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation. |
| exclude_fields | query | optional | array | A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation. |
| count | query | optional | integer | The number of records to return. Default value is 10. Maximum value is 1000 |
| offset | query | optional | integer | Used for pagination, this it the number of records from a collection to skip. Default value is 0. |
| store_id | path | required | string | The store id. |
An error generated by the Mailchimp API.
GET /ecommerce/stores/{store_id}/promo-rules
/ecommerce/stores/{store_id}/promo-rules/{promo_rule_id}
Get information about a specific promo rule.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| fields | query | optional | array | A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation. |
| exclude_fields | query | optional | array | A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation. |
| store_id | path | required | string | The store id. |
| promo_rule_id | path | required | string | The id for the promo rule of a store. |
An error generated by the Mailchimp API.
GET /ecommerce/stores/{store_id}/promo-rules/{promo_rule_id}
/ecommerce/stores/{store_id}/promo-rules/{promo_rule_id}/promo-codes
Get information about a store’s promo codes.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| fields | query | optional | array | A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation. |
| exclude_fields | query | optional | array | A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation. |
| count | query | optional | integer | The number of records to return. Default value is 10. Maximum value is 1000 |
| offset | query | optional | integer | Used for pagination, this it the number of records from a collection to skip. Default value is 0. |
| promo_rule_id | path | required | string | The id for the promo rule of a store. |
| store_id | path | required | string | The store id. |
An error generated by the Mailchimp API.
GET /ecommerce/stores/{store_id}/promo-rules/{promo_rule_id}/promo-codes
/ecommerce/stores/{store_id}/promo-rules/{promo_rule_id}/promo-codes/{promo_code_id}
Get information about a specific promo code.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| fields | query | optional | array | A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation. |
| exclude_fields | query | optional | array | A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation. |
| store_id | path | required | string | The store id. |
| promo_rule_id | path | required | string | The id for the promo rule of a store. |
| promo_code_id | path | required | string | The id for the promo code of a store. |
An error generated by the Mailchimp API.
GET /ecommerce/stores/{store_id}/promo-rules/{promo_rule_id}/promo-codes/{promo_code_id}
/facebook-ads
Get list of Facebook ads.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| fields | query | optional | array | A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation. |
| exclude_fields | query | optional | array | A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation. |
| count | query | optional | integer | The number of records to return. Default value is 10. Maximum value is 1000 |
| offset | query | optional | integer | Used for pagination, this it the number of records from a collection to skip. Default value is 0. |
| sort_field | query | optional | string | Returns files sorted by the specified field. |
| sort_dir | query | optional | string | Determines the order direction for sorted results. |
An error generated by the Mailchimp API.
List of Facebook Ad Instances
GET /facebook-ads
/facebook-ads/{outreach_id}
Get details of a Facebook ad.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| fields | query | optional | array | A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation. |
| outreach_id | path | required | string | The outreach id. |
| exclude_fields | query | optional | array | A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation. |
An error generated by the Mailchimp API.
Facebook Ad Instance
GET /facebook-ads/{outreach_id}
/file-manager/files
Get a list of available images and files stored in the File Manager for the account.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| fields | query | optional | array | A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation. |
| exclude_fields | query | optional | array | A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation. |
| count | query | optional | integer | The number of records to return. Default value is 10. Maximum value is 1000 |
| offset | query | optional | integer | Used for pagination, this it the number of records from a collection to skip. Default value is 0. |
| type | query | optional | string | The file type for the File Manager file. |
| created_by | query | optional | string | The Mailchimp account user who created the File Manager file. |
| before_created_at | query | optional | string | Restrict the response to files created before the set date. Uses ISO 8601 time format: 2015-10-21T15:41:36+00:00. |
| since_created_at | query | optional | string | Restrict the response to files created after the set date. Uses ISO 8601 time format: 2015-10-21T15:41:36+00:00. |
| sort_field | query | optional | string | Returns files sorted by the specified field. |
| sort_dir | query | optional | string | Determines the order direction for sorted results. |
An error generated by the Mailchimp API.
GET /file-manager/files
/file-manager/files/{file_id}
Get information about a specific file in the File Manager.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| fields | query | optional | array | A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation. |
| exclude_fields | query | optional | array | A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation. |
| file_id | path | required | string | The unique id for the File Manager file. |
An error generated by the Mailchimp API.
GET /file-manager/files/{file_id}
/file-manager/folders
Get a list of all folders in the File Manager.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| fields | query | optional | array | A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation. |
| exclude_fields | query | optional | array | A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation. |
| count | query | optional | integer | The number of records to return. Default value is 10. Maximum value is 1000 |
| offset | query | optional | integer | Used for pagination, this it the number of records from a collection to skip. Default value is 0. |
| created_by | query | optional | string | The Mailchimp account user who created the File Manager file. |
| before_created_at | query | optional | string | Restrict the response to files created before the set date. Uses ISO 8601 time format: 2015-10-21T15:41:36+00:00. |
| since_created_at | query | optional | string | Restrict the response to files created after the set date. Uses ISO 8601 time format: 2015-10-21T15:41:36+00:00. |
An error generated by the Mailchimp API.
GET /file-manager/folders
/file-manager/folders/{folder_id}
Get information about a specific folder in the File Manager.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| fields | query | optional | array | A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation. |
| exclude_fields | query | optional | array | A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation. |
| folder_id | path | required | string | The unique id for the File Manager folder. |
An error generated by the Mailchimp API.
GET /file-manager/folders/{folder_id}
/file-manager/folders/{folder_id}/files
Get a list of available images and files stored in this folder.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| folder_id | path | required | string | The unique id for the File Manager folder. |
| fields | query | optional | array | A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation. |
| exclude_fields | query | optional | array | A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation. |
| count | query | optional | integer | The number of records to return. Default value is 10. Maximum value is 1000 |
| offset | query | optional | integer | Used for pagination, this it the number of records from a collection to skip. Default value is 0. |
| type | query | optional | string | The file type for the File Manager file. |
| created_by | query | optional | string | The Mailchimp account user who created the File Manager file. |
| before_created_at | query | optional | string | Restrict the response to files created before the set date. Uses ISO 8601 time format: 2015-10-21T15:41:36+00:00. |
| since_created_at | query | optional | string | Restrict the response to files created after the set date. Uses ISO 8601 time format: 2015-10-21T15:41:36+00:00. |
| sort_field | query | optional | string | Returns files sorted by the specified field. |
| sort_dir | query | optional | string | Determines the order direction for sorted results. |
An error generated by the Mailchimp API.
GET /file-manager/folders/{folder_id}/files
/landing-pages
Get all landing pages.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| sort_dir | query | optional | string | Determines the order direction for sorted results. |
| sort_field | query | optional | string | Returns files sorted by the specified field. |
| fields | query | optional | array | A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation. |
| exclude_fields | query | optional | array | A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation. |
| count | query | optional | integer | The number of records to return. Default value is 10. Maximum value is 1000 |
An error generated by the Mailchimp API.
Landing Pages Collection
GET /landing-pages
/landing-pages/{page_id}
Get information about a specific page.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| fields | query | optional | array | A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation. |
| exclude_fields | query | optional | array | A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation. |
| page_id | path | required | string | The unique id for the page. |
An error generated by the Mailchimp API.
Landing Pages Instance
GET /landing-pages/{page_id}
/landing-pages/{page_id}/content
Get the the HTML for your landing page.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| fields | query | optional | array | A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation. |
| exclude_fields | query | optional | array | A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation. |
| page_id | path | required | string | The unique id for the page. |
An error generated by the Mailchimp API.
GET /landing-pages/{page_id}/content
/lists
Get information about all lists in the account.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| fields | query | optional | array | A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation. |
| exclude_fields | query | optional | array | A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation. |
| count | query | optional | integer | The number of records to return. Default value is 10. Maximum value is 1000 |
| offset | query | optional | integer | Used for pagination, this it the number of records from a collection to skip. Default value is 0. |
| before_date_created | query | optional | string | Restrict response to lists created before the set date. Uses ISO 8601 time format: 2015-10-21T15:41:36+00:00. |
| since_date_created | query | optional | string | Restrict results to lists created after the set date. Uses ISO 8601 time format: 2015-10-21T15:41:36+00:00. |
| before_campaign_last_sent | query | optional | string | Restrict results to lists created before the last campaign send date. Uses ISO 8601 time format: 2015-10-21T15:41:36+00:00. |
| since_campaign_last_sent | query | optional | string | Restrict results to lists created after the last campaign send date. Uses ISO 8601 time format: 2015-10-21T15:41:36+00:00. |
| query | optional | string | Restrict results to lists that include a specific subscriber’s email address. |
|
| sort_field | query | optional | string | Returns files sorted by the specified field. |
| sort_dir | query | optional | string | Determines the order direction for sorted results. |
| has_ecommerce_store | query | optional | boolean | Restrict results to lists that contain an active, connected, undeleted ecommerce store. |
| include_total_contacts | query | optional | boolean | Return the total_contacts field in the stats response, which contains an approximate count of all contacts in any state. |
An error generated by the Mailchimp API.
GET /lists
/lists/{list_id}
Get information about a specific list in your Mailchimp account. Results include list members who have signed up but haven’t confirmed their subscription yet and unsubscribed or cleaned.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| fields | query | optional | array | A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation. |
| exclude_fields | query | optional | array | A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation. |
| list_id | path | required | string | The unique ID for the list. |
| include_total_contacts | query | optional | boolean | Return the total_contacts field in the stats response, which contains an approximate count of all contacts in any state. |
An error generated by the Mailchimp API.
GET /lists/{list_id}
/lists/{list_id}/abuse-reports
Get all abuse reports for a specific list.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| fields | query | optional | array | A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation. |
| exclude_fields | query | optional | array | A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation. |
| count | query | optional | integer | The number of records to return. Default value is 10. Maximum value is 1000 |
| offset | query | optional | integer | Used for pagination, this it the number of records from a collection to skip. Default value is 0. |
| list_id | path | required | string | The unique ID for the list. |
An error generated by the Mailchimp API.
GET /lists/{list_id}/abuse-reports
/lists/{list_id}/abuse-reports/{report_id}
Get details about a specific abuse report.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| fields | query | optional | array | A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation. |
| exclude_fields | query | optional | array | A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation. |
| count | query | optional | integer | The number of records to return. Default value is 10. Maximum value is 1000 |
| offset | query | optional | integer | Used for pagination, this it the number of records from a collection to skip. Default value is 0. |
| list_id | path | required | string | The unique ID for the list. |
| report_id | path | required | string | The id for the abuse report. |
An error generated by the Mailchimp API.
GET /lists/{list_id}/abuse-reports/{report_id}
/lists/{list_id}/activity
Get up to the previous 180 days of daily detailed aggregated activity stats for a list, not including Automation activity.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| count | query | optional | integer | The number of records to return. Default value is 10. Maximum value is 1000 |
| offset | query | optional | integer | Used for pagination, this it the number of records from a collection to skip. Default value is 0. |
| fields | query | optional | array | A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation. |
| exclude_fields | query | optional | array | A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation. |
| list_id | path | required | string | The unique ID for the list. |
An error generated by the Mailchimp API.
GET /lists/{list_id}/activity
/lists/{list_id}/clients
Get a list of the top email clients based on user-agent strings.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| fields | query | optional | array | A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation. |
| exclude_fields | query | optional | array | A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation. |
| list_id | path | required | string | The unique ID for the list. |
An error generated by the Mailchimp API.
GET /lists/{list_id}/clients
/lists/{list_id}/growth-history
Get a month-by-month summary of a specific list’s growth activity.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| fields | query | optional | array | A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation. |
| exclude_fields | query | optional | array | A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation. |
| count | query | optional | integer | The number of records to return. Default value is 10. Maximum value is 1000 |
| offset | query | optional | integer | Used for pagination, this it the number of records from a collection to skip. Default value is 0. |
| list_id | path | required | string | The unique ID for the list. |
| sort_field | query | optional | string | Returns files sorted by the specified field. |
| sort_dir | query | optional | string | Determines the order direction for sorted results. |
An error generated by the Mailchimp API.
GET /lists/{list_id}/growth-history
/lists/{list_id}/growth-history/{month}
Get a summary of a specific list’s growth activity for a specific month and year.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| fields | query | optional | array | A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation. |
| exclude_fields | query | optional | array | A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation. |
| list_id | path | required | string | The unique ID for the list. |
| month | path | required | string | A specific month of list growth history. |
An error generated by the Mailchimp API.
GET /lists/{list_id}/growth-history/{month}
/lists/{list_id}/interest-categories
Get information about a list’s interest categories.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| list_id | path | required | string | The unique ID for the list. |
| fields | query | optional | array | A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation. |
| exclude_fields | query | optional | array | A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation. |
| count | query | optional | integer | The number of records to return. Default value is 10. Maximum value is 1000 |
| offset | query | optional | integer | Used for pagination, this it the number of records from a collection to skip. Default value is 0. |
| type | query | optional | string | Restrict results a type of interest group |
An error generated by the Mailchimp API.
GET /lists/{list_id}/interest-categories
/lists/{list_id}/interest-categories/{interest_category_id}
Get information about a specific interest category.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| list_id | path | required | string | The unique ID for the list. |
| interest_category_id | path | required | string | The unique ID for the interest category. |
| fields | query | optional | array | A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation. |
| exclude_fields | query | optional | array | A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation. |
An error generated by the Mailchimp API.
GET /lists/{list_id}/interest-categories/{interest_category_id}
/lists/{list_id}/interest-categories/{interest_category_id}/interests
Get a list of this category’s interests.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| list_id | path | required | string | The unique ID for the list. |
| interest_category_id | path | required | string | The unique ID for the interest category. |
| fields | query | optional | array | A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation. |
| exclude_fields | query | optional | array | A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation. |
| count | query | optional | integer | The number of records to return. Default value is 10. Maximum value is 1000 |
| offset | query | optional | integer | Used for pagination, this it the number of records from a collection to skip. Default value is 0. |
An error generated by the Mailchimp API.
GET /lists/{list_id}/interest-categories/{interest_category_id}/interests
/lists/{list_id}/interest-categories/{interest_category_id}/interests/{interest_id}
Get interests or ‘group names’ for a specific category.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| list_id | path | required | string | The unique ID for the list. |
| interest_category_id | path | required | string | The unique ID for the interest category. |
| interest_id | path | required | string | The specific interest or ‘group name’. |
| fields | query | optional | array | A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation. |
| exclude_fields | query | optional | array | A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation. |
An error generated by the Mailchimp API.
GET /lists/{list_id}/interest-categories/{interest_category_id}/interests/{interest_id}
/lists/{list_id}/locations
Get the locations (countries) that the list’s subscribers have been tagged to based on geocoding their IP address.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| fields | query | optional | array | A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation. |
| exclude_fields | query | optional | array | A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation. |
| list_id | path | required | string | The unique ID for the list. |
An error generated by the Mailchimp API.
GET /lists/{list_id}/locations
/lists/{list_id}/members
Get information about members in a specific Mailchimp list.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| fields | query | optional | array | A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation. |
| exclude_fields | query | optional | array | A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation. |
| count | query | optional | integer | The number of records to return. Default value is 10. Maximum value is 1000 |
| offset | query | optional | integer | Used for pagination, this it the number of records from a collection to skip. Default value is 0. |
| list_id | path | required | string | The unique ID for the list. |
| email_type | query | optional | string | The email type. |
| status | query | optional | string | The subscriber’s status. |
| since_timestamp_opt | query | optional | string | Restrict results to subscribers who opted-in after the set timeframe. Uses ISO 8601 time format: 2015-10-21T15:41:36+00:00. |
| before_timestamp_opt | query | optional | string | Restrict results to subscribers who opted-in before the set timeframe. Uses ISO 8601 time format: 2015-10-21T15:41:36+00:00. |
| since_last_changed | query | optional | string | Restrict results to subscribers whose information changed after the set timeframe. Uses ISO 8601 time format: 2015-10-21T15:41:36+00:00. |
| before_last_changed | query | optional | string | Restrict results to subscribers whose information changed before the set timeframe. Uses ISO 8601 time format: 2015-10-21T15:41:36+00:00. |
| unique_email_id | query | optional | string | A unique identifier for the email address across all Mailchimp lists. |
| vip_only | query | optional | boolean | A filter to return only the list’s VIP members. Passing |
| interest_category_id | query | optional | string | The unique id for the interest category. |
| interest_ids | query | optional | string | Used to filter list members by interests. Must be accompanied by interest_category_id and interest_match. The value must be a comma separated list of interest ids present for any supplied interest categories. |
| interest_match | query | optional | string | Used to filter list members by interests. Must be accompanied by interest_category_id and interest_ids. “any” will match a member with any of the interest supplied, “all” will only match members with every interest supplied, and “none” will match members without any of the interest supplied. |
| sort_field | query | optional | string | Returns files sorted by the specified field. |
| sort_dir | query | optional | string | Determines the order direction for sorted results. |
| since_last_campaign | query | optional | boolean | Filter subscribers by those subscribed/unsubscribed/pending/cleaned since last email campaign send. Member status is required to use this filter. |
| unsubscribed_since | query | optional | string | Filter subscribers by those unsubscribed since a specific date. Using any status other than unsubscribed with this filter will result in an error. |
An error generated by the Mailchimp API.
GET /lists/{list_id}/members
/lists/{list_id}/members/{subscriber_hash}
Get information about a specific list member, including a currently subscribed, unsubscribed, or bounced member.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| fields | query | optional | array | A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation. |
| exclude_fields | query | optional | array | A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation. |
| list_id | path | required | string | The unique ID for the list. |
| subscriber_hash | path | required | string | The MD5 hash of the lowercase version of the list member’s email address. This endpoint also accepts a list member’s email address or contact_id. |
An error generated by the Mailchimp API.
GET /lists/{list_id}/members/{subscriber_hash}
/lists/{list_id}/members/{subscriber_hash}/activity
Get the last 50 events of a member’s activity on a specific list, including opens, clicks, and unsubscribes.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| list_id | path | required | string | The unique ID for the list. |
| subscriber_hash | path | required | string | The MD5 hash of the lowercase version of the list member’s email address. This endpoint also accepts a list member’s email address or contact_id. |
| fields | query | optional | array | A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation. |
| exclude_fields | query | optional | array | A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation. |
| action | query | optional | array | A comma seperated list of actions to return. |
An error generated by the Mailchimp API.
GET /lists/{list_id}/members/{subscriber_hash}/activity
/lists/{list_id}/members/{subscriber_hash}/activity-feed
Get a member’s activity on a specific list, including opens, clicks, and unsubscribes.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| list_id | path | required | string | The unique ID for the list. |
| subscriber_hash | path | required | string | The MD5 hash of the lowercase version of the list member’s email address. This endpoint also accepts a list member’s email address or contact_id. |
| fields | query | optional | array | A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation. |
| exclude_fields | query | optional | array | A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation. |
| count | query | optional | integer | The number of records to return. Default value is 10. Maximum value is 1000 |
| offset | query | optional | integer | Used for pagination, this it the number of records from a collection to skip. Default value is 0. |
| activity_filters | query | optional | array | A comma-separated list of activity filters that correspond to a set of activity types, e.g “?activity_filters=open,bounce,click”. |
An error generated by the Mailchimp API.
GET /lists/{list_id}/members/{subscriber_hash}/activity-feed
/lists/{list_id}/members/{subscriber_hash}/events
Get events for a contact.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| list_id | path | required | string | The unique ID for the list. |
| subscriber_hash | path | required | string | The MD5 hash of the lowercase version of the list member’s email address. This endpoint also accepts a list member’s email address or contact_id. |
| count | query | optional | integer | The number of records to return. Default value is 10. Maximum value is 1000 |
| offset | query | optional | integer | Used for pagination, this it the number of records from a collection to skip. Default value is 0. |
| fields | query | optional | array | A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation. |
| exclude_fields | query | optional | array | A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation. |
An error generated by the Mailchimp API.
GET /lists/{list_id}/members/{subscriber_hash}/events
/lists/{list_id}/members/{subscriber_hash}/goals
Get the last 50 Goal events for a member on a specific list.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| list_id | path | required | string | The unique ID for the list. |
| subscriber_hash | path | required | string | The MD5 hash of the lowercase version of the list member’s email address. This endpoint also accepts a list member’s email address or contact_id. |
| fields | query | optional | array | A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation. |
| exclude_fields | query | optional | array | A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation. |
An error generated by the Mailchimp API.
GET /lists/{list_id}/members/{subscriber_hash}/goals
/lists/{list_id}/members/{subscriber_hash}/notes
Get recent notes for a specific list member.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| list_id | path | required | string | The unique ID for the list. |
| subscriber_hash | path | required | string | The MD5 hash of the lowercase version of the list member’s email address. |
| sort_field | query | optional | string | Returns notes sorted by the specified field. |
| sort_dir | query | optional | string | Determines the order direction for sorted results. |
| fields | query | optional | array | A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation. |
| exclude_fields | query | optional | array | A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation. |
| count | query | optional | integer | The number of records to return. Default value is 10. Maximum value is 1000 |
| offset | query | optional | integer | Used for pagination, this it the number of records from a collection to skip. Default value is 0. |
An error generated by the Mailchimp API.
GET /lists/{list_id}/members/{subscriber_hash}/notes
/lists/{list_id}/members/{subscriber_hash}/notes/{note_id}
Get a specific note for a specific list member.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| list_id | path | required | string | The unique ID for the list. |
| subscriber_hash | path | required | string | The MD5 hash of the lowercase version of the list member’s email address. This endpoint also accepts a list member’s email address or contact_id. |
| note_id | path | required | string | The id for the note. |
| fields | query | optional | array | A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation. |
| exclude_fields | query | optional | array | A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation. |
An error generated by the Mailchimp API.
GET /lists/{list_id}/members/{subscriber_hash}/notes/{note_id}
/lists/{list_id}/members/{subscriber_hash}/tags
Get the tags on a list member.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| list_id | path | required | string | The unique ID for the list. |
| subscriber_hash | path | required | string | The MD5 hash of the lowercase version of the list member’s email address. This endpoint also accepts a list member’s email address or contact_id. |
| fields | query | optional | array | A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation. |
| exclude_fields | query | optional | array | A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation. |
| count | query | optional | integer | The number of records to return. Default value is 10. Maximum value is 1000 |
| offset | query | optional | integer | Used for pagination, this it the number of records from a collection to skip. Default value is 0. |
An error generated by the Mailchimp API.
GET /lists/{list_id}/members/{subscriber_hash}/tags
/lists/{list_id}/merge-fields
Get a list of all merge fields for an audience.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| list_id | path | required | string | The unique ID for the list. |
| fields | query | optional | array | A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation. |
| exclude_fields | query | optional | array | A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation. |
| count | query | optional | integer | The number of records to return. Default value is 10. Maximum value is 1000 |
| offset | query | optional | integer | Used for pagination, this it the number of records from a collection to skip. Default value is 0. |
| type | query | optional | string | The merge field type. |
| required | query | optional | boolean | Whether it’s a required merge field. |
An error generated by the Mailchimp API.
GET /lists/{list_id}/merge-fields
/lists/{list_id}/merge-fields/{merge_id}
Get information about a specific merge field.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| list_id | path | required | string | The unique ID for the list. |
| merge_id | path | required | string | The id for the merge field. |
| exclude_fields | query | optional | array | A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation. |
| fields | query | optional | array | A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation. |
An error generated by the Mailchimp API.
GET /lists/{list_id}/merge-fields/{merge_id}
/lists/{list_id}/segments
Get information about all available segments for a specific list.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| fields | query | optional | array | A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation. |
| exclude_fields | query | optional | array | A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation. |
| count | query | optional | integer | The number of records to return. Default value is 10. Maximum value is 1000 |
| offset | query | optional | integer | Used for pagination, this it the number of records from a collection to skip. Default value is 0. |
| list_id | path | required | string | The unique ID for the list. |
| type | query | optional | string | Limit results based on segment type. |
| since_created_at | query | optional | string | Restrict results to segments created after the set time. Uses ISO 8601 time format: 2015-10-21T15:41:36+00:00. |
| before_created_at | query | optional | string | Restrict results to segments created before the set time. Uses ISO 8601 time format: 2015-10-21T15:41:36+00:00. |
| include_cleaned | query | optional | boolean | Include cleaned members in response |
| include_transactional | query | optional | boolean | Include transactional members in response |
| include_unsubscribed | query | optional | boolean | Include unsubscribed members in response |
| since_updated_at | query | optional | string | Restrict results to segments update after the set time. Uses ISO 8601 time format: 2015-10-21T15:41:36+00:00. |
| before_updated_at | query | optional | string | Restrict results to segments update before the set time. Uses ISO 8601 time format: 2015-10-21T15:41:36+00:00. |
An error generated by the Mailchimp API.
GET /lists/{list_id}/segments
/lists/{list_id}/segments/{segment_id}
Get information about a specific segment.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| fields | query | optional | array | A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation. |
| exclude_fields | query | optional | array | A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation. |
| list_id | path | required | string | The unique ID for the list. |
| segment_id | path | required | string | The unique id for the segment. |
| include_cleaned | query | optional | boolean | Include cleaned members in response |
| include_transactional | query | optional | boolean | Include transactional members in response |
| include_unsubscribed | query | optional | boolean | Include unsubscribed members in response |
An error generated by the Mailchimp API.
GET /lists/{list_id}/segments/{segment_id}
/lists/{list_id}/segments/{segment_id}/members
Get information about members in a saved segment.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| fields | query | optional | array | A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation. |
| exclude_fields | query | optional | array | A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation. |
| count | query | optional | integer | The number of records to return. Default value is 10. Maximum value is 1000 |
| offset | query | optional | integer | Used for pagination, this it the number of records from a collection to skip. Default value is 0. |
| list_id | path | required | string | The unique ID for the list. |
| segment_id | path | required | string | The unique id for the segment. |
| include_cleaned | query | optional | boolean | Include cleaned members in response |
| include_transactional | query | optional | boolean | Include transactional members in response |
| include_unsubscribed | query | optional | boolean | Include unsubscribed members in response |
An error generated by the Mailchimp API.
GET /lists/{list_id}/segments/{segment_id}/members
/lists/{list_id}/signup-forms
Get signup forms for a specific list.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| list_id | path | required | string | The unique ID for the list. |
An error generated by the Mailchimp API.
GET /lists/{list_id}/signup-forms
/lists/{list_id}/surveys
Get information about all available surveys for a specific list.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| list_id | path | required | string | The unique ID for the list. |
An error generated by the Mailchimp API.
GET /lists/{list_id}/surveys
/lists/{list_id}/surveys/{survey_id}
Get details about a specific survey.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| list_id | path | required | string | The unique ID for the list. |
| survey_id | path | required | string | The ID of the survey. |
An error generated by the Mailchimp API.
GET /lists/{list_id}/surveys/{survey_id}
/lists/{list_id}/tag-search
Search for tags on a list by name. If no name is provided, will return all tags on the list.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| list_id | path | required | string | The unique ID for the list. |
| name | query | optional | string | The search query used to filter tags. The search query will be compared to each tag as a prefix, so all tags that have a name starting with this field will be returned. |
An error generated by the Mailchimp API.
GET /lists/{list_id}/tag-search
/lists/{list_id}/webhooks
Get information about all webhooks for a specific list.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| list_id | path | required | string | The unique ID for the list. |
An error generated by the Mailchimp API.
GET /lists/{list_id}/webhooks
/lists/{list_id}/webhooks/{webhook_id}
Get information about a specific webhook.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| list_id | path | required | string | The unique ID for the list. |
| webhook_id | path | required | string | The webhook’s id. |
An error generated by the Mailchimp API.
GET /lists/{list_id}/webhooks/{webhook_id}
/ping
A health check for the API that won’t return any account-specific information.
An error generated by the Mailchimp API.
GET /ping
/reporting/facebook-ads
Get reports of Facebook ads.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| fields | query | optional | array | A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation. |
| exclude_fields | query | optional | array | A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation. |
| count | query | optional | integer | The number of records to return. Default value is 10. Maximum value is 1000 |
| offset | query | optional | integer | Used for pagination, this it the number of records from a collection to skip. Default value is 0. |
| sort_field | query | optional | string | Returns files sorted by the specified field. |
| sort_dir | query | optional | string | Determines the order direction for sorted results. |
An error generated by the Mailchimp API.
List of Facebook Ad Report Instances
GET /reporting/facebook-ads
/reporting/facebook-ads/{outreach_id}
Get report of a Facebook ad.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| fields | query | optional | array | A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation. |
| outreach_id | path | required | string | The outreach id. |
| exclude_fields | query | optional | array | A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation. |
An error generated by the Mailchimp API.
Facebook Ad report Instance
GET /reporting/facebook-ads/{outreach_id}
/reporting/facebook-ads/{outreach_id}/ecommerce-product-activity
Get breakdown of product activity for an outreach.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| fields | query | optional | array | A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation. |
| exclude_fields | query | optional | array | A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation. |
| count | query | optional | integer | The number of records to return. Default value is 10. Maximum value is 1000 |
| offset | query | optional | integer | Used for pagination, this it the number of records from a collection to skip. Default value is 0. |
| outreach_id | path | required | string | The outreach id. |
| sort_field | query | optional | string | Returns files sorted by the specified field. |
An error generated by the Mailchimp API.
Ecommerce Product Activity Instance
GET /reporting/facebook-ads/{outreach_id}/ecommerce-product-activity
/reporting/landing-pages
Get reports of landing pages.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| fields | query | optional | array | A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation. |
| exclude_fields | query | optional | array | A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation. |
| count | query | optional | integer | The number of records to return. Default value is 10. Maximum value is 1000 |
| offset | query | optional | integer | Used for pagination, this it the number of records from a collection to skip. Default value is 0. |
An error generated by the Mailchimp API.
List of Landing Page Report Instances
GET /reporting/landing-pages
/reporting/landing-pages/{outreach_id}
Get report of a landing page.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| fields | query | optional | array | A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation. |
| outreach_id | path | required | string | The outreach id. |
| exclude_fields | query | optional | array | A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation. |
An error generated by the Mailchimp API.
Landing Page Report Instance
GET /reporting/landing-pages/{outreach_id}
/reporting/surveys
Get reports for surveys.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| fields | query | optional | array | A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation. |
| exclude_fields | query | optional | array | A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation. |
| count | query | optional | integer | The number of records to return. Default value is 10. Maximum value is 1000 |
| offset | query | optional | integer | Used for pagination, this it the number of records from a collection to skip. Default value is 0. |
An error generated by the Mailchimp API.
List of Survey Report Instances
GET /reporting/surveys
/reporting/surveys/{survey_id}
Get report for a survey.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| fields | query | optional | array | A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation. |
| exclude_fields | query | optional | array | A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation. |
| survey_id | path | required | string | The ID of the survey. |
An error generated by the Mailchimp API.
Survey Report Instance
GET /reporting/surveys/{survey_id}
/reporting/surveys/{survey_id}/questions
Get reports for survey questions.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| fields | query | optional | array | A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation. |
| exclude_fields | query | optional | array | A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation. |
| survey_id | path | required | string | The ID of the survey. |
An error generated by the Mailchimp API.
List of Survey Question Report Instances
GET /reporting/surveys/{survey_id}/questions
/reporting/surveys/{survey_id}/questions/{question_id}
Get report for a survey question.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| fields | query | optional | array | A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation. |
| exclude_fields | query | optional | array | A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation. |
| survey_id | path | required | string | The ID of the survey. |
| question_id | path | required | string | The ID of the survey question. |
An error generated by the Mailchimp API.
Survey Question Report Instance
GET /reporting/surveys/{survey_id}/questions/{question_id}
/reporting/surveys/{survey_id}/questions/{question_id}/answers
Get answers for a survey question.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| fields | query | optional | array | A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation. |
| exclude_fields | query | optional | array | A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation. |
| survey_id | path | required | string | The ID of the survey. |
| question_id | path | required | string | The ID of the survey question. |
| respondent_familiarity_is | query | optional | string | Filter survey responses by familiarity of the respondents. |
An error generated by the Mailchimp API.
List of Survey Question Answers
GET /reporting/surveys/{survey_id}/questions/{question_id}/answers
/reporting/surveys/{survey_id}/responses
Get responses to a survey.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| fields | query | optional | array | A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation. |
| exclude_fields | query | optional | array | A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation. |
| survey_id | path | required | string | The ID of the survey. |
| answered_question | query | optional | integer | The ID of the question that was answered. |
| chose_answer | query | optional | string | The ID of the option chosen to filter responses on. |
| respondent_familiarity_is | query | optional | string | Filter survey responses by familiarity of the respondents. |
An error generated by the Mailchimp API.
List of survey responses
GET /reporting/surveys/{survey_id}/responses
/reporting/surveys/{survey_id}/responses/{response_id}
Get a single survey response.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| survey_id | path | required | string | The ID of the survey. |
| response_id | path | required | string | The ID of the survey response. |
An error generated by the Mailchimp API.
Get a single survey response.
GET /reporting/surveys/{survey_id}/responses/{response_id}
/reports
Get campaign reports.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| fields | query | optional | array | A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation. |
| exclude_fields | query | optional | array | A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation. |
| count | query | optional | integer | The number of records to return. Default value is 10. Maximum value is 1000 |
| offset | query | optional | integer | Used for pagination, this it the number of records from a collection to skip. Default value is 0. |
| type | query | optional | string | The campaign type. |
| before_send_time | query | optional | string | Restrict the response to campaigns sent before the set time. Uses ISO 8601 time format: 2015-10-21T15:41:36+00:00. |
| since_send_time | query | optional | string | Restrict the response to campaigns sent after the set time. Uses ISO 8601 time format: 2015-10-21T15:41:36+00:00. |
An error generated by the Mailchimp API.
GET /reports
/reports/{campaign_id}
Get report details for a specific sent campaign.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| fields | query | optional | array | A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation. |
| exclude_fields | query | optional | array | A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation. |
| campaign_id | path | required | string | The unique id for the campaign. |
An error generated by the Mailchimp API.
GET /reports/{campaign_id}
/reports/{campaign_id}/abuse-reports
Get a list of abuse complaints for a specific campaign.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| fields | query | optional | array | A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation. |
| exclude_fields | query | optional | array | A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation. |
| campaign_id | path | required | string | The unique id for the campaign. |
An error generated by the Mailchimp API.
GET /reports/{campaign_id}/abuse-reports
/reports/{campaign_id}/abuse-reports/{report_id}
Get information about a specific abuse report for a campaign.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| fields | query | optional | array | A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation. |
| exclude_fields | query | optional | array | A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation. |
| campaign_id | path | required | string | The unique id for the campaign. |
| report_id | path | required | string | The id for the abuse report. |
An error generated by the Mailchimp API.
GET /reports/{campaign_id}/abuse-reports/{report_id}
/reports/{campaign_id}/advice
Get feedback based on a campaign’s statistics. Advice feedback is based on campaign stats like opens, clicks, unsubscribes, bounces, and more.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| fields | query | optional | array | A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation. |
| exclude_fields | query | optional | array | A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation. |
| campaign_id | path | required | string | The unique id for the campaign. |
An error generated by the Mailchimp API.
GET /reports/{campaign_id}/advice
/reports/{campaign_id}/click-details
Get information about clicks on specific links in your Mailchimp campaigns.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| fields | query | optional | array | A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation. |
| exclude_fields | query | optional | array | A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation. |
| count | query | optional | integer | The number of records to return. Default value is 10. Maximum value is 1000 |
| offset | query | optional | integer | Used for pagination, this it the number of records from a collection to skip. Default value is 0. |
| campaign_id | path | required | string | The unique id for the campaign. |
| sort_field | query | optional | string | Returns click reports sorted by the specified field. |
| sort_dir | query | optional | string | Determines the order direction for sorted results. |
An error generated by the Mailchimp API.
GET /reports/{campaign_id}/click-details
/reports/{campaign_id}/click-details/{link_id}
Get click details for a specific link in a campaign.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| fields | query | optional | array | A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation. |
| exclude_fields | query | optional | array | A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation. |
| campaign_id | path | required | string | The unique id for the campaign. |
| link_id | path | required | string | The id for the link. |
An error generated by the Mailchimp API.
GET /reports/{campaign_id}/click-details/{link_id}
/reports/{campaign_id}/click-details/{link_id}/members
Get information about list members who clicked on a specific link in a campaign.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| fields | query | optional | array | A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation. |
| exclude_fields | query | optional | array | A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation. |
| count | query | optional | integer | The number of records to return. Default value is 10. Maximum value is 1000 |
| offset | query | optional | integer | Used for pagination, this it the number of records from a collection to skip. Default value is 0. |
| campaign_id | path | required | string | The unique id for the campaign. |
| link_id | path | required | string | The id for the link. |
An error generated by the Mailchimp API.
GET /reports/{campaign_id}/click-details/{link_id}/members
/reports/{campaign_id}/click-details/{link_id}/members/{subscriber_hash}
Get information about a specific subscriber who clicked a link in a specific campaign.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| fields | query | optional | array | A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation. |
| exclude_fields | query | optional | array | A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation. |
| campaign_id | path | required | string | The unique id for the campaign. |
| link_id | path | required | string | The id for the link. |
| subscriber_hash | path | required | string | The MD5 hash of the lowercase version of the list member’s email address. |
An error generated by the Mailchimp API.
GET /reports/{campaign_id}/click-details/{link_id}/members/{subscriber_hash}
/reports/{campaign_id}/domain-performance
Get statistics for the top-performing email domains in a campaign.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| fields | query | optional | array | A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation. |
| exclude_fields | query | optional | array | A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation. |
| campaign_id | path | required | string | The unique id for the campaign. |
An error generated by the Mailchimp API.
GET /reports/{campaign_id}/domain-performance
/reports/{campaign_id}/ecommerce-product-activity
Get breakdown of product activity for a campaign
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| fields | query | optional | array | A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation. |
| exclude_fields | query | optional | array | A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation. |
| count | query | optional | integer | The number of records to return. Default value is 10. Maximum value is 1000 |
| offset | query | optional | integer | Used for pagination, this it the number of records from a collection to skip. Default value is 0. |
| campaign_id | path | required | string | The unique id for the campaign. |
| sort_field | query | optional | string | Returns files sorted by the specified field. |
An error generated by the Mailchimp API.
Ecommerce Product Activity Instance
GET /reports/{campaign_id}/ecommerce-product-activity
/reports/{campaign_id}/eepurl
Get a summary of social activity for the campaign, tracked by EepURL.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| fields | query | optional | array | A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation. |
| exclude_fields | query | optional | array | A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation. |
| campaign_id | path | required | string | The unique id for the campaign. |
An error generated by the Mailchimp API.
GET /reports/{campaign_id}/eepurl
/reports/{campaign_id}/email-activity
Get a list of member’s subscriber activity in a specific campaign.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| fields | query | optional | array | A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation. |
| exclude_fields | query | optional | array | A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation. |
| count | query | optional | integer | The number of records to return. Default value is 10. Maximum value is 1000 |
| offset | query | optional | integer | Used for pagination, this it the number of records from a collection to skip. Default value is 0. |
| campaign_id | path | required | string | The unique id for the campaign. |
| since | query | optional | string | Restrict results to email activity events that occur after a specific time. Uses ISO 8601 time format: 2015-10-21T15:41:36+00:00. |
An error generated by the Mailchimp API.
GET /reports/{campaign_id}/email-activity
/reports/{campaign_id}/email-activity/{subscriber_hash}
Get a specific list member’s activity in a campaign including opens, clicks, and bounces.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| fields | query | optional | array | A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation. |
| exclude_fields | query | optional | array | A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation. |
| campaign_id | path | required | string | The unique id for the campaign. |
| subscriber_hash | path | required | string | The MD5 hash of the lowercase version of the list member’s email address. |
| since | query | optional | string | Restrict results to email activity events that occur after a specific time. Uses ISO 8601 time format: 2015-10-21T15:41:36+00:00. |
An error generated by the Mailchimp API.
GET /reports/{campaign_id}/email-activity/{subscriber_hash}
/reports/{campaign_id}/locations
Get top open locations for a specific campaign.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| fields | query | optional | array | A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation. |
| exclude_fields | query | optional | array | A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation. |
| campaign_id | path | required | string | The unique id for the campaign. |
| count | query | optional | integer | The number of records to return. Default value is 10. Maximum value is 1000 |
| offset | query | optional | integer | Used for pagination, this it the number of records from a collection to skip. Default value is 0. |
An error generated by the Mailchimp API.
GET /reports/{campaign_id}/locations
/reports/{campaign_id}/open-details
Get detailed information about any campaign emails that were opened by a list member.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| fields | query | optional | array | A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation. |
| exclude_fields | query | optional | array | A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation. |
| count | query | optional | integer | The number of records to return. Default value is 10. Maximum value is 1000 |
| offset | query | optional | integer | Used for pagination, this it the number of records from a collection to skip. Default value is 0. |
| campaign_id | path | required | string | The unique id for the campaign. |
| since | query | optional | string | Restrict results to campaign open events that occur after a specific time. Uses ISO 8601 time format: 2015-10-21T15:41:36+00:00. |
| sort_field | query | optional | string | Returns open reports sorted by the specified field. |
| sort_dir | query | optional | string | Determines the order direction for sorted results. |
An error generated by the Mailchimp API.
GET /reports/{campaign_id}/open-details
/reports/{campaign_id}/open-details/{subscriber_hash}
Get information about a specific subscriber who opened a campaign.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| fields | query | optional | array | A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation. |
| exclude_fields | query | optional | array | A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation. |
| campaign_id | path | required | string | The unique id for the campaign. |
| subscriber_hash | path | required | string | The MD5 hash of the lowercase version of the list member’s email address. |
An error generated by the Mailchimp API.
GET /reports/{campaign_id}/open-details/{subscriber_hash}
/reports/{campaign_id}/sent-to
Get information about campaign recipients.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| fields | query | optional | array | A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation. |
| exclude_fields | query | optional | array | A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation. |
| count | query | optional | integer | The number of records to return. Default value is 10. Maximum value is 1000 |
| offset | query | optional | integer | Used for pagination, this it the number of records from a collection to skip. Default value is 0. |
| campaign_id | path | required | string | The unique id for the campaign. |
An error generated by the Mailchimp API.
GET /reports/{campaign_id}/sent-to
/reports/{campaign_id}/sent-to/{subscriber_hash}
Get information about a specific campaign recipient.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| fields | query | optional | array | A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation. |
| exclude_fields | query | optional | array | A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation. |
| campaign_id | path | required | string | The unique id for the campaign. |
| subscriber_hash | path | required | string | The MD5 hash of the lowercase version of the list member’s email address. |
An error generated by the Mailchimp API.
GET /reports/{campaign_id}/sent-to/{subscriber_hash}
/reports/{campaign_id}/sub-reports
Get a list of reports with child campaigns for a specific parent campaign.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| fields | query | optional | array | A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation. |
| exclude_fields | query | optional | array | A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation. |
| campaign_id | path | required | string | The unique id for the campaign. |
An error generated by the Mailchimp API.
GET /reports/{campaign_id}/sub-reports
/reports/{campaign_id}/unsubscribed
Get information about members who have unsubscribed from a specific campaign.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| fields | query | optional | array | A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation. |
| exclude_fields | query | optional | array | A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation. |
| count | query | optional | integer | The number of records to return. Default value is 10. Maximum value is 1000 |
| offset | query | optional | integer | Used for pagination, this it the number of records from a collection to skip. Default value is 0. |
| campaign_id | path | required | string | The unique id for the campaign. |
An error generated by the Mailchimp API.
GET /reports/{campaign_id}/unsubscribed
/reports/{campaign_id}/unsubscribed/{subscriber_hash}
Get information about a specific list member who unsubscribed from a campaign.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| fields | query | optional | array | A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation. |
| exclude_fields | query | optional | array | A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation. |
| campaign_id | path | required | string | The unique id for the campaign. |
| subscriber_hash | path | required | string | The MD5 hash of the lowercase version of the list member’s email address. |
An error generated by the Mailchimp API.
GET /reports/{campaign_id}/unsubscribed/{subscriber_hash}
/
Get links to all other resources available in the API.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| fields | query | optional | array | A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation. |
| exclude_fields | query | optional | array | A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation. |
An error generated by the Mailchimp API.
GET /
/search-campaigns
Search all campaigns for the specified query terms.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| fields | query | optional | array | A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation. |
| exclude_fields | query | optional | array | A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation. |
| query | query | required | string | The search query used to filter results. |
An error generated by the Mailchimp API.
GET /search-campaigns
/search-members
Search for list members. This search can be restricted to a specific list, or can be used to search across all lists in an account.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| fields | query | optional | array | A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation. |
| exclude_fields | query | optional | array | A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation. |
| query | query | required | string | The search query used to filter results. Query should be a valid email, or a string representing a contact’s first or last name. |
| list_id | query | optional | string | The unique id for the list. |
An error generated by the Mailchimp API.
GET /search-members
/template-folders
Get all folders used to organize templates.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| fields | query | optional | array | A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation. |
| exclude_fields | query | optional | array | A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation. |
| count | query | optional | integer | The number of records to return. Default value is 10. Maximum value is 1000 |
| offset | query | optional | integer | Used for pagination, this it the number of records from a collection to skip. Default value is 0. |
An error generated by the Mailchimp API.
GET /template-folders
/template-folders/{folder_id}
Get information about a specific folder used to organize templates.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| fields | query | optional | array | A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation. |
| exclude_fields | query | optional | array | A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation. |
| folder_id | path | required | string | The unique id for the template folder. |
An error generated by the Mailchimp API.
GET /template-folders/{folder_id}
/templates
Get a list of an account’s available templates.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| fields | query | optional | array | A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation. |
| exclude_fields | query | optional | array | A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation. |
| count | query | optional | integer | The number of records to return. Default value is 10. Maximum value is 1000 |
| offset | query | optional | integer | Used for pagination, this it the number of records from a collection to skip. Default value is 0. |
| created_by | query | optional | string | The Mailchimp account user who created the template. |
| since_date_created | query | optional | string | Restrict the response to templates created after the set date. Uses ISO 8601 time format: 2015-10-21T15:41:36+00:00. |
| before_date_created | query | optional | string | Restrict the response to templates created before the set date. Uses ISO 8601 time format: 2015-10-21T15:41:36+00:00. |
| type | query | optional | string | Limit results based on template type. |
| category | query | optional | string | Limit results based on category. |
| folder_id | query | optional | string | The unique folder id. |
| sort_field | query | optional | string | Returns user templates sorted by the specified field. |
| content_type | query | optional | string | Limit results based on how the template’s content is put together. Only templates of type |
| sort_dir | query | optional | string | Determines the order direction for sorted results. |
An error generated by the Mailchimp API.
GET /templates
/templates/{template_id}
Get information about a specific template.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| fields | query | optional | array | A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation. |
| exclude_fields | query | optional | array | A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation. |
| template_id | path | required | string | The unique id for the template. |
An error generated by the Mailchimp API.
GET /templates/{template_id}
/templates/{template_id}/default-content
Get the sections that you can edit in a template, including each section’s default content.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| fields | query | optional | array | A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation. |
| exclude_fields | query | optional | array | A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation. |
| template_id | path | required | string | The unique id for the template. |
An error generated by the Mailchimp API.
GET /templates/{template_id}/default-content
/verified-domains
Get all of the sending domains on the account.
An error generated by the Mailchimp API.
The domains on the account.
GET /verified-domains
/verified-domains/{domain_name}
Get the details for a single domain on the account.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| domain_name | path | required | string | The domain name. |
An error generated by the Mailchimp API.
GET /verified-domains/{domain_name}
AccountExportInfo200Response
{
"type": "object",
"properties": {
"_links": {
"type": "array",
"items": {
"type": "object",
"title": "Resource Link",
"properties": {
"rel": {
"type": "string",
"title": "Rel",
"readOnly": true,
"description": "As with an HTML 'rel' attribute, this describes the type of link."
},
"href": {
"type": "string",
"title": "Href",
"readOnly": true,
"description": "This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action."
},
"method": {
"enum": [
"GET",
"POST",
"PUT",
"PATCH",
"DELETE",
"OPTIONS",
"HEAD"
],
"type": "string",
"title": "Method",
"readOnly": true,
"description": "The HTTP method that should be used when accessing the URL defined in 'href'."
},
"schema": {
"type": "string",
"title": "Schema",
"readOnly": true,
"description": "For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to."
},
"targetSchema": {
"type": "string",
"title": "Target Schema",
"readOnly": true,
"description": "For GETs, this is a URL representing the schema that the response should conform to."
}
},
"description": "This object represents a link from the resource where it is found to another resource or action that may be performed."
},
"title": "Links",
"readOnly": true,
"description": "A list of link types and descriptions for the API schema documents."
},
"started": {
"type": "string",
"title": "Start Time",
"format": "date-time",
"description": "Start time for the export."
},
"finished": {
"type": "string",
"title": "Finish Time",
"format": "date-time",
"description": "If finished, the finish time for the export."
},
"export_id": {
"type": "integer",
"title": "Export ID",
"description": "The ID for the export."
},
"download_url": {
"type": "string",
"title": "Download URL",
"description": "If the export is finished, the download URL for an export. URLs are only valid for 90 days after the export completes."
},
"size_in_bytes": {
"type": "integer",
"title": "Export Size",
"description": "The size of the uncompressed export in bytes."
}
},
"description": "An account export."
}
AccountExportInfoResponse
{
"type": "object",
"properties": {
"_links": {
"type": "array",
"items": {
"type": "object",
"title": "Resource Link",
"properties": {
"rel": {
"type": "string",
"title": "Rel",
"readOnly": true,
"description": "As with an HTML 'rel' attribute, this describes the type of link."
},
"href": {
"type": "string",
"title": "Href",
"readOnly": true,
"description": "This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action."
},
"method": {
"enum": [
"GET",
"POST",
"PUT",
"PATCH",
"DELETE",
"OPTIONS",
"HEAD"
],
"type": "string",
"title": "Method",
"readOnly": true,
"description": "The HTTP method that should be used when accessing the URL defined in 'href'."
},
"schema": {
"type": "string",
"title": "Schema",
"readOnly": true,
"description": "For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to."
},
"targetSchema": {
"type": "string",
"title": "Target Schema",
"readOnly": true,
"description": "For GETs, this is a URL representing the schema that the response should conform to."
}
},
"description": "This object represents a link from the resource where it is found to another resource or action that may be performed."
},
"title": "Links",
"readOnly": true,
"description": "A list of link types and descriptions for the API schema documents."
},
"started": {
"type": "string",
"title": "Start Time",
"format": "date-time",
"description": "Start time for the export."
},
"finished": {
"type": "string",
"title": "Finish Time",
"format": "date-time",
"description": "If finished, the finish time for the export."
},
"export_id": {
"type": "integer",
"title": "Export ID",
"description": "The ID for the export."
},
"download_url": {
"type": "string",
"title": "Download URL",
"description": "If the export is finished, the download URL for an export. URLs are only valid for 90 days after the export completes."
},
"size_in_bytes": {
"type": "integer",
"title": "Export Size",
"description": "The size of the uncompressed export in bytes."
}
},
"description": "An account export."
}
AccountExportInfodefaultResponse
{
"type": "object",
"title": "Problem Detail Document",
"required": [
"type",
"title",
"status",
"detail",
"instance"
],
"properties": {
"type": {
"type": "string",
"title": "Problem Type",
"example": "https://mailchimp.com/developer/marketing/docs/errors/",
"description": "An absolute URI that identifies the problem type. When dereferenced, it should provide human-readable documentation for the problem type."
},
"title": {
"type": "string",
"title": "Error Title",
"example": "Resource Not Found",
"description": "A short, human-readable summary of the problem type. It shouldn't change based on the occurrence of the problem, except for purposes of localization."
},
"detail": {
"type": "string",
"title": "Error Message",
"example": "The requested resource could not be found.",
"description": "A human-readable explanation specific to this occurrence of the problem. [Learn more about errors](https://mailchimp.com/developer/)."
},
"status": {
"type": "integer",
"title": "HTTP Status Code",
"example": 404,
"description": "The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem."
},
"instance": {
"type": "string",
"title": "Instance ID",
"example": "995c5cb0-3280-4a6e-808b-3b096d0bb219",
"description": "A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support."
}
},
"description": "An error generated by the Mailchimp API. Conforms to IETF draft 'draft-nottingham-http-problem-06'."
}
AccountExportsCreateNewExport200Response
{
"type": "object",
"properties": {
"_links": {
"type": "array",
"items": {
"type": "object",
"title": "Resource Link",
"properties": {
"rel": {
"type": "string",
"title": "Rel",
"readOnly": true,
"description": "As with an HTML 'rel' attribute, this describes the type of link."
},
"href": {
"type": "string",
"title": "Href",
"readOnly": true,
"description": "This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action."
},
"method": {
"enum": [
"GET",
"POST",
"PUT",
"PATCH",
"DELETE",
"OPTIONS",
"HEAD"
],
"type": "string",
"title": "Method",
"readOnly": true,
"description": "The HTTP method that should be used when accessing the URL defined in 'href'."
},
"schema": {
"type": "string",
"title": "Schema",
"readOnly": true,
"description": "For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to."
},
"targetSchema": {
"type": "string",
"title": "Target Schema",
"readOnly": true,
"description": "For GETs, this is a URL representing the schema that the response should conform to."
}
},
"description": "This object represents a link from the resource where it is found to another resource or action that may be performed."
},
"title": "Links",
"readOnly": true,
"description": "A list of link types and descriptions for the API schema documents."
},
"started": {
"type": "string",
"title": "Start Time",
"format": "date-time",
"description": "Start time for the export."
},
"finished": {
"type": "string",
"title": "Finish Time",
"format": "date-time",
"description": "If finished, the finish time for the export."
},
"export_id": {
"type": "integer",
"title": "Export ID",
"description": "The ID for the export."
},
"download_url": {
"type": "string",
"title": "Download URL",
"description": "If the export is finished, the download URL for an export. URLs are only valid for 90 days after the export completes."
},
"size_in_bytes": {
"type": "integer",
"title": "Export Size",
"description": "The size of the uncompressed export in bytes."
}
},
"description": "An account export."
}
AccountExportsCreateNewExportRequest
{
"type": "object",
"title": "Create an account export",
"required": [
"include_stages"
],
"properties": {
"include_stages": {
"type": "array",
"items": {
"enum": [
"audiences",
"campaigns",
"events",
"gallery_files",
"reports",
"templates"
],
"type": "string"
},
"title": "Include Stages",
"example": "[\"audiences\", \"gallery_files\"]",
"description": "The stages of an account export to include."
},
"since_timestamp": {
"type": "string",
"title": "Since Timestamp",
"format": "date-time",
"example": "2021-08-23T14:15:09Z",
"description": "An ISO 8601 date that will limit the export to only records created after a given time. For instance, the reports stage will contain any campaign sent after the given timestamp. Audiences, however, are excluded from this limit."
}
},
"description": "Creates an account export with the given parameters."
}
AccountExportsCreateNewExportResponse
{
"type": "object",
"properties": {
"_links": {
"type": "array",
"items": {
"type": "object",
"title": "Resource Link",
"properties": {
"rel": {
"type": "string",
"title": "Rel",
"readOnly": true,
"description": "As with an HTML 'rel' attribute, this describes the type of link."
},
"href": {
"type": "string",
"title": "Href",
"readOnly": true,
"description": "This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action."
},
"method": {
"enum": [
"GET",
"POST",
"PUT",
"PATCH",
"DELETE",
"OPTIONS",
"HEAD"
],
"type": "string",
"title": "Method",
"readOnly": true,
"description": "The HTTP method that should be used when accessing the URL defined in 'href'."
},
"schema": {
"type": "string",
"title": "Schema",
"readOnly": true,
"description": "For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to."
},
"targetSchema": {
"type": "string",
"title": "Target Schema",
"readOnly": true,
"description": "For GETs, this is a URL representing the schema that the response should conform to."
}
},
"description": "This object represents a link from the resource where it is found to another resource or action that may be performed."
},
"title": "Links",
"readOnly": true,
"description": "A list of link types and descriptions for the API schema documents."
},
"started": {
"type": "string",
"title": "Start Time",
"format": "date-time",
"description": "Start time for the export."
},
"finished": {
"type": "string",
"title": "Finish Time",
"format": "date-time",
"description": "If finished, the finish time for the export."
},
"export_id": {
"type": "integer",
"title": "Export ID",
"description": "The ID for the export."
},
"download_url": {
"type": "string",
"title": "Download URL",
"description": "If the export is finished, the download URL for an export. URLs are only valid for 90 days after the export completes."
},
"size_in_bytes": {
"type": "integer",
"title": "Export Size",
"description": "The size of the uncompressed export in bytes."
}
},
"description": "An account export."
}
AccountExportsCreateNewExportdefaultResponse
{
"type": "object",
"title": "Problem Detail Document",
"required": [
"type",
"title",
"status",
"detail",
"instance"
],
"properties": {
"type": {
"type": "string",
"title": "Problem Type",
"example": "https://mailchimp.com/developer/marketing/docs/errors/",
"description": "An absolute URI that identifies the problem type. When dereferenced, it should provide human-readable documentation for the problem type."
},
"title": {
"type": "string",
"title": "Error Title",
"example": "Resource Not Found",
"description": "A short, human-readable summary of the problem type. It shouldn't change based on the occurrence of the problem, except for purposes of localization."
},
"detail": {
"type": "string",
"title": "Error Message",
"example": "The requested resource could not be found.",
"description": "A human-readable explanation specific to this occurrence of the problem. [Learn more about errors](https://mailchimp.com/developer/)."
},
"status": {
"type": "integer",
"title": "HTTP Status Code",
"example": 404,
"description": "The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem."
},
"instance": {
"type": "string",
"title": "Instance ID",
"example": "995c5cb0-3280-4a6e-808b-3b096d0bb219",
"description": "A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support."
}
},
"description": "An error generated by the Mailchimp API. Conforms to IETF draft 'draft-nottingham-http-problem-06'."
}
AccountExportsListForGivenAccount200Response
{
"type": "object",
"properties": {
"_links": {
"type": "array",
"items": {
"type": "object",
"title": "Resource Link",
"properties": {
"rel": {
"type": "string",
"title": "Rel",
"readOnly": true,
"description": "As with an HTML 'rel' attribute, this describes the type of link."
},
"href": {
"type": "string",
"title": "Href",
"readOnly": true,
"description": "This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action."
},
"method": {
"enum": [
"GET",
"POST",
"PUT",
"PATCH",
"DELETE",
"OPTIONS",
"HEAD"
],
"type": "string",
"title": "Method",
"readOnly": true,
"description": "The HTTP method that should be used when accessing the URL defined in 'href'."
},
"schema": {
"type": "string",
"title": "Schema",
"readOnly": true,
"description": "For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to."
},
"targetSchema": {
"type": "string",
"title": "Target Schema",
"readOnly": true,
"description": "For GETs, this is a URL representing the schema that the response should conform to."
}
},
"description": "This object represents a link from the resource where it is found to another resource or action that may be performed."
},
"title": "Links",
"readOnly": true,
"description": "A list of link types and descriptions for the API schema documents."
},
"exports": {
"type": "array",
"items": {
"type": "object",
"properties": {
"_links": {
"type": "array",
"items": {
"type": "object",
"title": "Resource Link",
"properties": {
"rel": {
"type": "string",
"title": "Rel",
"readOnly": true,
"description": "As with an HTML 'rel' attribute, this describes the type of link."
},
"href": {
"type": "string",
"title": "Href",
"readOnly": true,
"description": "This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action."
},
"method": {
"enum": [
"GET",
"POST",
"PUT",
"PATCH",
"DELETE",
"OPTIONS",
"HEAD"
],
"type": "string",
"title": "Method",
"readOnly": true,
"description": "The HTTP method that should be used when accessing the URL defined in 'href'."
},
"schema": {
"type": "string",
"title": "Schema",
"readOnly": true,
"description": "For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to."
},
"targetSchema": {
"type": "string",
"title": "Target Schema",
"readOnly": true,
"description": "For GETs, this is a URL representing the schema that the response should conform to."
}
},
"description": "This object represents a link from the resource where it is found to another resource or action that may be performed."
},
"title": "Links",
"readOnly": true,
"description": "A list of link types and descriptions for the API schema documents."
},
"started": {
"type": "string",
"title": "Start Time",
"format": "date-time",
"description": "Start time for the export."
},
"finished": {
"type": "string",
"title": "Finish Time",
"format": "date-time",
"description": "If finished, the finish time for the export."
},
"export_id": {
"type": "integer",
"title": "Export ID",
"description": "The ID for the export."
},
"download_url": {
"type": "string",
"title": "Download URL",
"description": "If the export is finished, the download URL for an export. URLs are only valid for 90 days after the export completes."
},
"size_in_bytes": {
"type": "integer",
"title": "Export Size",
"description": "The size of the uncompressed export in bytes."
}
},
"description": "An account export."
},
"title": "Account Exports",
"description": "An array of objects, each representing an account export."
},
"total_items": {
"type": "integer",
"title": "Item Count",
"readOnly": true,
"description": "The total number of items matching the query regardless of pagination."
}
},
"description": "An array of objects, each representing an account export."
}
AccountExportsListForGivenAccountResponse
{
"type": "object",
"properties": {
"_links": {
"type": "array",
"items": {
"type": "object",
"title": "Resource Link",
"properties": {
"rel": {
"type": "string",
"title": "Rel",
"readOnly": true,
"description": "As with an HTML 'rel' attribute, this describes the type of link."
},
"href": {
"type": "string",
"title": "Href",
"readOnly": true,
"description": "This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action."
},
"method": {
"enum": [
"GET",
"POST",
"PUT",
"PATCH",
"DELETE",
"OPTIONS",
"HEAD"
],
"type": "string",
"title": "Method",
"readOnly": true,
"description": "The HTTP method that should be used when accessing the URL defined in 'href'."
},
"schema": {
"type": "string",
"title": "Schema",
"readOnly": true,
"description": "For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to."
},
"targetSchema": {
"type": "string",
"title": "Target Schema",
"readOnly": true,
"description": "For GETs, this is a URL representing the schema that the response should conform to."
}
},
"description": "This object represents a link from the resource where it is found to another resource or action that may be performed."
},
"title": "Links",
"readOnly": true,
"description": "A list of link types and descriptions for the API schema documents."
},
"exports": {
"type": "array",
"items": {
"type": "object",
"properties": {
"_links": {
"type": "array",
"items": {
"type": "object",
"title": "Resource Link",
"properties": {
"rel": {
"type": "string",
"title": "Rel",
"readOnly": true,
"description": "As with an HTML 'rel' attribute, this describes the type of link."
},
"href": {
"type": "string",
"title": "Href",
"readOnly": true,
"description": "This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action."
},
"method": {
"enum": [
"GET",
"POST",
"PUT",
"PATCH",
"DELETE",
"OPTIONS",
"HEAD"
],
"type": "string",
"title": "Method",
"readOnly": true,
"description": "The HTTP method that should be used when accessing the URL defined in 'href'."
},
"schema": {
"type": "string",
"title": "Schema",
"readOnly": true,
"description": "For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to."
},
"targetSchema": {
"type": "string",
"title": "Target Schema",
"readOnly": true,
"description": "For GETs, this is a URL representing the schema that the response should conform to."
}
},
"description": "This object represents a link from the resource where it is found to another resource or action that may be performed."
},
"title": "Links",
"readOnly": true,
"description": "A list of link types and descriptions for the API schema documents."
},
"started": {
"type": "string",
"title": "Start Time",
"format": "date-time",
"description": "Start time for the export."
},
"finished": {
"type": "string",
"title": "Finish Time",
"format": "date-time",
"description": "If finished, the finish time for the export."
},
"export_id": {
"type": "integer",
"title": "Export ID",
"description": "The ID for the export."
},
"download_url": {
"type": "string",
"title": "Download URL",
"description": "If the export is finished, the download URL for an export. URLs are only valid for 90 days after the export completes."
},
"size_in_bytes": {
"type": "integer",
"title": "Export Size",
"description": "The size of the uncompressed export in bytes."
}
},
"description": "An account export."
},
"title": "Account Exports",
"description": "An array of objects, each representing an account export."
},
"total_items": {
"type": "integer",
"title": "Item Count",
"readOnly": true,
"description": "The total number of items matching the query regardless of pagination."
}
},
"description": "An array of objects, each representing an account export."
}
AccountExportsListForGivenAccountdefaultResponse
{
"type": "object",
"title": "Problem Detail Document",
"required": [
"type",
"title",
"status",
"detail",
"instance"
],
"properties": {
"type": {
"type": "string",
"title": "Problem Type",
"example": "https://mailchimp.com/developer/marketing/docs/errors/",
"description": "An absolute URI that identifies the problem type. When dereferenced, it should provide human-readable documentation for the problem type."
},
"title": {
"type": "string",
"title": "Error Title",
"example": "Resource Not Found",
"description": "A short, human-readable summary of the problem type. It shouldn't change based on the occurrence of the problem, except for purposes of localization."
},
"detail": {
"type": "string",
"title": "Error Message",
"example": "The requested resource could not be found.",
"description": "A human-readable explanation specific to this occurrence of the problem. [Learn more about errors](https://mailchimp.com/developer/)."
},
"status": {
"type": "integer",
"title": "HTTP Status Code",
"example": 404,
"description": "The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem."
},
"instance": {
"type": "string",
"title": "Instance ID",
"example": "995c5cb0-3280-4a6e-808b-3b096d0bb219",
"description": "A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support."
}
},
"description": "An error generated by the Mailchimp API. Conforms to IETF draft 'draft-nottingham-http-problem-06'."
}
ActivityFeedGetLatestChimpChatter200Response
{
"type": "object",
"properties": {
"_links": {
"type": "array",
"items": {
"type": "object",
"title": "Resource Link",
"properties": {
"rel": {
"type": "string",
"title": "Rel",
"readOnly": true,
"description": "As with an HTML 'rel' attribute, this describes the type of link."
},
"href": {
"type": "string",
"title": "Href",
"readOnly": true,
"description": "This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action."
},
"method": {
"enum": [
"GET",
"POST",
"PUT",
"PATCH",
"DELETE",
"OPTIONS",
"HEAD"
],
"type": "string",
"title": "Method",
"readOnly": true,
"description": "The HTTP method that should be used when accessing the URL defined in 'href'."
},
"schema": {
"type": "string",
"title": "Schema",
"readOnly": true,
"description": "For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to."
},
"targetSchema": {
"type": "string",
"title": "Target Schema",
"readOnly": true,
"description": "For GETs, this is a URL representing the schema that the response should conform to."
}
},
"description": "This object represents a link from the resource where it is found to another resource or action that may be performed."
},
"title": "Links",
"readOnly": true,
"description": "A list of link types and descriptions for the API schema documents."
},
"total_items": {
"type": "integer",
"title": "Item Count",
"readOnly": true,
"description": "The total number of items matching the query regardless of pagination."
},
"chimp_chatter": {
"type": "array",
"items": {
"type": "object",
"title": "ChimpChatter",
"properties": {
"url": {
"type": "string",
"title": "URL",
"example": "http://dev.mailchimp.com/reports/summary?id=1",
"readOnly": true,
"description": "URL to a report that includes this activity"
},
"type": {
"enum": [
"lists:new-subscriber",
"lists:unsubscribes",
"lists:profile-updates",
"campaigns:facebook-likes",
"campaigns:forward-to-friend",
"lists:imports"
],
"type": "string",
"title": "Type",
"example": "campaigns:forward-to-friend",
"readOnly": true,
"description": "The type of activity"
},
"title": {
"type": "string",
"title": "Title",
"example": "1 new subscriber to Your New Campaign!",
"readOnly": true
},
"list_id": {
"type": "string",
"title": "List ID",
"example": "2017-08-04T11:09:01+00:00",
"readOnly": true,
"description": "If it exists, list ID for the associated list"
},
"message": {
"type": "string",
"title": "Message",
"example": "People are telling their friends about your campaign!",
"readOnly": true
},
"campaign_id": {
"type": "string",
"title": "Campaign ID",
"example": "2017-08-04T11:09:01+00:00",
"readOnly": true,
"description": "If it exists, campaign ID for the associated campaign"
},
"update_time": {
"type": "string",
"title": "Update Time",
"format": "date-time",
"example": "2017-08-04T11:09:01+00:00",
"readOnly": true,
"description": "The date and time this activity was updated."
}
},
"description": "A Chimp Chatter message"
},
"readOnly": true,
"description": "An array of Chimp Chatter messages. There's a maximum of 200 messages present for an account."
}
},
"description": "An array of Chimp Chatter messages. There's a maximum of 200 messages present for an account."
}
ActivityFeedGetLatestChimpChatterResponse
{
"type": "object",
"properties": {
"_links": {
"type": "array",
"items": {
"type": "object",
"title": "Resource Link",
"properties": {
"rel": {
"type": "string",
"title": "Rel",
"readOnly": true,
"description": "As with an HTML 'rel' attribute, this describes the type of link."
},
"href": {
"type": "string",
"title": "Href",
"readOnly": true,
"description": "This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action."
},
"method": {
"enum": [
"GET",
"POST",
"PUT",
"PATCH",
"DELETE",
"OPTIONS",
"HEAD"
],
"type": "string",
"title": "Method",
"readOnly": true,
"description": "The HTTP method that should be used when accessing the URL defined in 'href'."
},
"schema": {
"type": "string",
"title": "Schema",
"readOnly": true,
"description": "For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to."
},
"targetSchema": {
"type": "string",
"title": "Target Schema",
"readOnly": true,
"description": "For GETs, this is a URL representing the schema that the response should conform to."
}
},
"description": "This object represents a link from the resource where it is found to another resource or action that may be performed."
},
"title": "Links",
"readOnly": true,
"description": "A list of link types and descriptions for the API schema documents."
},
"total_items": {
"type": "integer",
"title": "Item Count",
"readOnly": true,
"description": "The total number of items matching the query regardless of pagination."
},
"chimp_chatter": {
"type": "array",
"items": {
"type": "object",
"title": "ChimpChatter",
"properties": {
"url": {
"type": "string",
"title": "URL",
"example": "http://dev.mailchimp.com/reports/summary?id=1",
"readOnly": true,
"description": "URL to a report that includes this activity"
},
"type": {
"enum": [
"lists:new-subscriber",
"lists:unsubscribes",
"lists:profile-updates",
"campaigns:facebook-likes",
"campaigns:forward-to-friend",
"lists:imports"
],
"type": "string",
"title": "Type",
"example": "campaigns:forward-to-friend",
"readOnly": true,
"description": "The type of activity"
},
"title": {
"type": "string",
"title": "Title",
"example": "1 new subscriber to Your New Campaign!",
"readOnly": true
},
"list_id": {
"type": "string",
"title": "List ID",
"example": "2017-08-04T11:09:01+00:00",
"readOnly": true,
"description": "If it exists, list ID for the associated list"
},
"message": {
"type": "string",
"title": "Message",
"example": "People are telling their friends about your campaign!",
"readOnly": true
},
"campaign_id": {
"type": "string",
"title": "Campaign ID",
"example": "2017-08-04T11:09:01+00:00",
"readOnly": true,
"description": "If it exists, campaign ID for the associated campaign"
},
"update_time": {
"type": "string",
"title": "Update Time",
"format": "date-time",
"example": "2017-08-04T11:09:01+00:00",
"readOnly": true,
"description": "The date and time this activity was updated."
}
},
"description": "A Chimp Chatter message"
},
"readOnly": true,
"description": "An array of Chimp Chatter messages. There's a maximum of 200 messages present for an account."
}
},
"description": "An array of Chimp Chatter messages. There's a maximum of 200 messages present for an account."
}
ActivityFeedGetLatestChimpChatterdefaultResponse
{
"type": "object",
"title": "Problem Detail Document",
"required": [
"type",
"title",
"status",
"detail",
"instance"
],
"properties": {
"type": {
"type": "string",
"title": "Problem Type",
"example": "https://mailchimp.com/developer/marketing/docs/errors/",
"description": "An absolute URI that identifies the problem type. When dereferenced, it should provide human-readable documentation for the problem type."
},
"title": {
"type": "string",
"title": "Error Title",
"example": "Resource Not Found",
"description": "A short, human-readable summary of the problem type. It shouldn't change based on the occurrence of the problem, except for purposes of localization."
},
"detail": {
"type": "string",
"title": "Error Message",
"example": "The requested resource could not be found.",
"description": "A human-readable explanation specific to this occurrence of the problem. [Learn more about errors](https://mailchimp.com/developer/)."
},
"status": {
"type": "integer",
"title": "HTTP Status Code",
"example": 404,
"description": "The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem."
},
"instance": {
"type": "string",
"title": "Instance ID",
"example": "995c5cb0-3280-4a6e-808b-3b096d0bb219",
"description": "A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support."
}
},
"description": "An error generated by the Mailchimp API. Conforms to IETF draft 'draft-nottingham-http-problem-06'."
}
AuthorizedAppsGetInfo200Response
{
"type": "object",
"properties": {
"id": {
"type": "integer",
"title": "Client ID",
"description": "The ID for the application."
},
"name": {
"type": "string",
"title": "Application Name",
"description": "The name of the application."
},
"users": {
"type": "array",
"items": {
"type": "string"
},
"title": "Application Users",
"description": "An array of usernames for users who have linked the app."
},
"_links": {
"type": "array",
"items": {
"type": "object",
"title": "Resource Link",
"properties": {
"rel": {
"type": "string",
"title": "Rel",
"readOnly": true,
"description": "As with an HTML 'rel' attribute, this describes the type of link."
},
"href": {
"type": "string",
"title": "Href",
"readOnly": true,
"description": "This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action."
},
"method": {
"enum": [
"GET",
"POST",
"PUT",
"PATCH",
"DELETE",
"OPTIONS",
"HEAD"
],
"type": "string",
"title": "Method",
"readOnly": true,
"description": "The HTTP method that should be used when accessing the URL defined in 'href'."
},
"schema": {
"type": "string",
"title": "Schema",
"readOnly": true,
"description": "For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to."
},
"targetSchema": {
"type": "string",
"title": "Target Schema",
"readOnly": true,
"description": "For GETs, this is a URL representing the schema that the response should conform to."
}
},
"description": "This object represents a link from the resource where it is found to another resource or action that may be performed."
},
"title": "Links",
"readOnly": true,
"description": "A list of link types and descriptions for the API schema documents."
},
"description": {
"type": "string",
"title": "Application Description",
"description": "A short description of the application."
}
},
"description": "An authorized app."
}
AuthorizedAppsGetInfoResponse
{
"type": "object",
"properties": {
"id": {
"type": "integer",
"title": "Client ID",
"description": "The ID for the application."
},
"name": {
"type": "string",
"title": "Application Name",
"description": "The name of the application."
},
"users": {
"type": "array",
"items": {
"type": "string"
},
"title": "Application Users",
"description": "An array of usernames for users who have linked the app."
},
"_links": {
"type": "array",
"items": {
"type": "object",
"title": "Resource Link",
"properties": {
"rel": {
"type": "string",
"title": "Rel",
"readOnly": true,
"description": "As with an HTML 'rel' attribute, this describes the type of link."
},
"href": {
"type": "string",
"title": "Href",
"readOnly": true,
"description": "This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action."
},
"method": {
"enum": [
"GET",
"POST",
"PUT",
"PATCH",
"DELETE",
"OPTIONS",
"HEAD"
],
"type": "string",
"title": "Method",
"readOnly": true,
"description": "The HTTP method that should be used when accessing the URL defined in 'href'."
},
"schema": {
"type": "string",
"title": "Schema",
"readOnly": true,
"description": "For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to."
},
"targetSchema": {
"type": "string",
"title": "Target Schema",
"readOnly": true,
"description": "For GETs, this is a URL representing the schema that the response should conform to."
}
},
"description": "This object represents a link from the resource where it is found to another resource or action that may be performed."
},
"title": "Links",
"readOnly": true,
"description": "A list of link types and descriptions for the API schema documents."
},
"description": {
"type": "string",
"title": "Application Description",
"description": "A short description of the application."
}
},
"description": "An authorized app."
}
AuthorizedAppsGetInfodefaultResponse
{
"type": "object",
"title": "Problem Detail Document",
"required": [
"type",
"title",
"status",
"detail",
"instance"
],
"properties": {
"type": {
"type": "string",
"title": "Problem Type",
"example": "https://mailchimp.com/developer/marketing/docs/errors/",
"description": "An absolute URI that identifies the problem type. When dereferenced, it should provide human-readable documentation for the problem type."
},
"title": {
"type": "string",
"title": "Error Title",
"example": "Resource Not Found",
"description": "A short, human-readable summary of the problem type. It shouldn't change based on the occurrence of the problem, except for purposes of localization."
},
"detail": {
"type": "string",
"title": "Error Message",
"example": "The requested resource could not be found.",
"description": "A human-readable explanation specific to this occurrence of the problem. [Learn more about errors](https://mailchimp.com/developer/)."
},
"status": {
"type": "integer",
"title": "HTTP Status Code",
"example": 404,
"description": "The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem."
},
"instance": {
"type": "string",
"title": "Instance ID",
"example": "995c5cb0-3280-4a6e-808b-3b096d0bb219",
"description": "A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support."
}
},
"description": "An error generated by the Mailchimp API. Conforms to IETF draft 'draft-nottingham-http-problem-06'."
}
AuthorizedAppsListConnectedApplications200Response
{
"type": "object",
"properties": {
"apps": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"title": "Client ID",
"description": "The ID for the application."
},
"name": {
"type": "string",
"title": "Application Name",
"description": "The name of the application."
},
"users": {
"type": "array",
"items": {
"type": "string"
},
"title": "Application Users",
"description": "An array of usernames for users who have linked the app."
},
"_links": {
"type": "array",
"items": {
"type": "object",
"title": "Resource Link",
"properties": {
"rel": {
"type": "string",
"title": "Rel",
"readOnly": true,
"description": "As with an HTML 'rel' attribute, this describes the type of link."
},
"href": {
"type": "string",
"title": "Href",
"readOnly": true,
"description": "This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action."
},
"method": {
"enum": [
"GET",
"POST",
"PUT",
"PATCH",
"DELETE",
"OPTIONS",
"HEAD"
],
"type": "string",
"title": "Method",
"readOnly": true,
"description": "The HTTP method that should be used when accessing the URL defined in 'href'."
},
"schema": {
"type": "string",
"title": "Schema",
"readOnly": true,
"description": "For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to."
},
"targetSchema": {
"type": "string",
"title": "Target Schema",
"readOnly": true,
"description": "For GETs, this is a URL representing the schema that the response should conform to."
}
},
"description": "This object represents a link from the resource where it is found to another resource or action that may be performed."
},
"title": "Links",
"readOnly": true,
"description": "A list of link types and descriptions for the API schema documents."
},
"description": {
"type": "string",
"title": "Application Description",
"description": "A short description of the application."
}
},
"description": "An authorized app."
},
"title": "Authorized Applications",
"description": "An array of objects, each representing an authorized application."
},
"_links": {
"type": "array",
"items": {
"type": "object",
"title": "Resource Link",
"properties": {
"rel": {
"type": "string",
"title": "Rel",
"readOnly": true,
"description": "As with an HTML 'rel' attribute, this describes the type of link."
},
"href": {
"type": "string",
"title": "Href",
"readOnly": true,
"description": "This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action."
},
"method": {
"enum": [
"GET",
"POST",
"PUT",
"PATCH",
"DELETE",
"OPTIONS",
"HEAD"
],
"type": "string",
"title": "Method",
"readOnly": true,
"description": "The HTTP method that should be used when accessing the URL defined in 'href'."
},
"schema": {
"type": "string",
"title": "Schema",
"readOnly": true,
"description": "For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to."
},
"targetSchema": {
"type": "string",
"title": "Target Schema",
"readOnly": true,
"description": "For GETs, this is a URL representing the schema that the response should conform to."
}
},
"description": "This object represents a link from the resource where it is found to another resource or action that may be performed."
},
"title": "Links",
"readOnly": true,
"description": "A list of link types and descriptions for the API schema documents."
},
"total_items": {
"type": "integer",
"title": "Item Count",
"readOnly": true,
"description": "The total number of items matching the query regardless of pagination."
}
},
"description": "An array of objects, each representing an authorized application."
}
AuthorizedAppsListConnectedApplicationsResponse
{
"type": "object",
"properties": {
"apps": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"title": "Client ID",
"description": "The ID for the application."
},
"name": {
"type": "string",
"title": "Application Name",
"description": "The name of the application."
},
"users": {
"type": "array",
"items": {
"type": "string"
},
"title": "Application Users",
"description": "An array of usernames for users who have linked the app."
},
"_links": {
"type": "array",
"items": {
"type": "object",
"title": "Resource Link",
"properties": {
"rel": {
"type": "string",
"title": "Rel",
"readOnly": true,
"description": "As with an HTML 'rel' attribute, this describes the type of link."
},
"href": {
"type": "string",
"title": "Href",
"readOnly": true,
"description": "This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action."
},
"method": {
"enum": [
"GET",
"POST",
"PUT",
"PATCH",
"DELETE",
"OPTIONS",
"HEAD"
],
"type": "string",
"title": "Method",
"readOnly": true,
"description": "The HTTP method that should be used when accessing the URL defined in 'href'."
},
"schema": {
"type": "string",
"title": "Schema",
"readOnly": true,
"description": "For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to."
},
"targetSchema": {
"type": "string",
"title": "Target Schema",
"readOnly": true,
"description": "For GETs, this is a URL representing the schema that the response should conform to."
}
},
"description": "This object represents a link from the resource where it is found to another resource or action that may be performed."
},
"title": "Links",
"readOnly": true,
"description": "A list of link types and descriptions for the API schema documents."
},
"description": {
"type": "string",
"title": "Application Description",
"description": "A short description of the application."
}
},
"description": "An authorized app."
},
"title": "Authorized Applications",
"description": "An array of objects, each representing an authorized application."
},
"_links": {
"type": "array",
"items": {
"type": "object",
"title": "Resource Link",
"properties": {
"rel": {
"type": "string",
"title": "Rel",
"readOnly": true,
"description": "As with an HTML 'rel' attribute, this describes the type of link."
},
"href": {
"type": "string",
"title": "Href",
"readOnly": true,
"description": "This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action."
},
"method": {
"enum": [
"GET",
"POST",
"PUT",
"PATCH",
"DELETE",
"OPTIONS",
"HEAD"
],
"type": "string",
"title": "Method",
"readOnly": true,
"description": "The HTTP method that should be used when accessing the URL defined in 'href'."
},
"schema": {
"type": "string",
"title": "Schema",
"readOnly": true,
"description": "For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to."
},
"targetSchema": {
"type": "string",
"title": "Target Schema",
"readOnly": true,
"description": "For GETs, this is a URL representing the schema that the response should conform to."
}
},
"description": "This object represents a link from the resource where it is found to another resource or action that may be performed."
},
"title": "Links",
"readOnly": true,
"description": "A list of link types and descriptions for the API schema documents."
},
"total_items": {
"type": "integer",
"title": "Item Count",
"readOnly": true,
"description": "The total number of items matching the query regardless of pagination."
}
},
"description": "An array of objects, each representing an authorized application."
}
AuthorizedAppsListConnectedApplicationsdefaultResponse
{
"type": "object",
"title": "Problem Detail Document",
"required": [
"type",
"title",
"status",
"detail",
"instance"
],
"properties": {
"type": {
"type": "string",
"title": "Problem Type",
"example": "https://mailchimp.com/developer/marketing/docs/errors/",
"description": "An absolute URI that identifies the problem type. When dereferenced, it should provide human-readable documentation for the problem type."
},
"title": {
"type": "string",
"title": "Error Title",
"example": "Resource Not Found",
"description": "A short, human-readable summary of the problem type. It shouldn't change based on the occurrence of the problem, except for purposes of localization."
},
"detail": {
"type": "string",
"title": "Error Message",
"example": "The requested resource could not be found.",
"description": "A human-readable explanation specific to this occurrence of the problem. [Learn more about errors](https://mailchimp.com/developer/)."
},
"status": {
"type": "integer",
"title": "HTTP Status Code",
"example": 404,
"description": "The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem."
},
"instance": {
"type": "string",
"title": "Instance ID",
"example": "995c5cb0-3280-4a6e-808b-3b096d0bb219",
"description": "A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support."
}
},
"description": "An error generated by the Mailchimp API. Conforms to IETF draft 'draft-nottingham-http-problem-06'."
}
AutomationsAddSubscriberToWorkflowEmail200Response
{
"type": "object",
"title": "Subscriber in Automation Queue",
"properties": {
"id": {
"type": "string",
"title": "Email Hash",
"readOnly": true,
"description": "The MD5 hash of the lowercase version of the list member's email address."
},
"_links": {
"type": "array",
"items": {
"type": "object",
"title": "Resource Link",
"properties": {
"rel": {
"type": "string",
"title": "Rel",
"readOnly": true,
"description": "As with an HTML 'rel' attribute, this describes the type of link."
},
"href": {
"type": "string",
"title": "Href",
"readOnly": true,
"description": "This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action."
},
"method": {
"enum": [
"GET",
"POST",
"PUT",
"PATCH",
"DELETE",
"OPTIONS",
"HEAD"
],
"type": "string",
"title": "Method",
"readOnly": true,
"description": "The HTTP method that should be used when accessing the URL defined in 'href'."
},
"schema": {
"type": "string",
"title": "Schema",
"readOnly": true,
"description": "For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to."
},
"targetSchema": {
"type": "string",
"title": "Target Schema",
"readOnly": true,
"description": "For GETs, this is a URL representing the schema that the response should conform to."
}
},
"description": "This object represents a link from the resource where it is found to another resource or action that may be performed."
},
"title": "Links",
"readOnly": true,
"description": "A list of link types and descriptions for the API schema documents."
},
"list_id": {
"type": "string",
"title": "List ID",
"readOnly": true,
"description": "A string that uniquely identifies a list."
},
"email_id": {
"type": "string",
"title": "Automation Email ID",
"readOnly": true,
"description": "A string that uniquely identifies an email in an Automation workflow."
},
"next_send": {
"type": "string",
"title": "Next Send",
"format": "date-time",
"readOnly": true,
"description": "The date and time of the next send for the workflow email in ISO 8601 format."
},
"workflow_id": {
"type": "string",
"title": "Workflow ID",
"readOnly": true,
"description": "A string that uniquely identifies an Automation workflow."
},
"email_address": {
"type": "string",
"title": "Email Address",
"description": "The list member's email address."
},
"list_is_active": {
"type": "boolean",
"title": "List Status",
"readOnly": true,
"description": "The status of the list used, namely if it's deleted or disabled."
}
},
"description": "Information about subscribers in an Automation email queue."
}
AutomationsAddSubscriberToWorkflowEmailRequest
{
"type": "object",
"title": "Subscriber in Automation Queue",
"required": [
"email_address"
],
"properties": {
"email_address": {
"type": "string",
"title": "Email Address",
"description": "The list member's email address."
}
},
"description": "Information about subscribers in an Automation email queue."
}
AutomationsAddSubscriberToWorkflowEmailResponse
{
"type": "object",
"title": "Subscriber in Automation Queue",
"properties": {
"id": {
"type": "string",
"title": "Email Hash",
"readOnly": true,
"description": "The MD5 hash of the lowercase version of the list member's email address."
},
"_links": {
"type": "array",
"items": {
"type": "object",
"title": "Resource Link",
"properties": {
"rel": {
"type": "string",
"title": "Rel",
"readOnly": true,
"description": "As with an HTML 'rel' attribute, this describes the type of link."
},
"href": {
"type": "string",
"title": "Href",
"readOnly": true,
"description": "This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action."
},
"method": {
"enum": [
"GET",
"POST",
"PUT",
"PATCH",
"DELETE",
"OPTIONS",
"HEAD"
],
"type": "string",
"title": "Method",
"readOnly": true,
"description": "The HTTP method that should be used when accessing the URL defined in 'href'."
},
"schema": {
"type": "string",
"title": "Schema",
"readOnly": true,
"description": "For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to."
},
"targetSchema": {
"type": "string",
"title": "Target Schema",
"readOnly": true,
"description": "For GETs, this is a URL representing the schema that the response should conform to."
}
},
"description": "This object represents a link from the resource where it is found to another resource or action that may be performed."
},
"title": "Links",
"readOnly": true,
"description": "A list of link types and descriptions for the API schema documents."
},
"list_id": {
"type": "string",
"title": "List ID",
"readOnly": true,
"description": "A string that uniquely identifies a list."
},
"email_id": {
"type": "string",
"title": "Automation Email ID",
"readOnly": true,
"description": "A string that uniquely identifies an email in an Automation workflow."
},
"next_send": {
"type": "string",
"title": "Next Send",
"format": "date-time",
"readOnly": true,
"description": "The date and time of the next send for the workflow email in ISO 8601 format."
},
"workflow_id": {
"type": "string",
"title": "Workflow ID",
"readOnly": true,
"description": "A string that uniquely identifies an Automation workflow."
},
"email_address": {
"type": "string",
"title": "Email Address",
"description": "The list member's email address."
},
"list_is_active": {
"type": "boolean",
"title": "List Status",
"readOnly": true,
"description": "The status of the list used, namely if it's deleted or disabled."
}
},
"description": "Information about subscribers in an Automation email queue."
}
AutomationsAddSubscriberToWorkflowEmaildefaultResponse
{
"type": "object",
"title": "Problem Detail Document",
"required": [
"type",
"title",
"status",
"detail",
"instance"
],
"properties": {
"type": {
"type": "string",
"title": "Problem Type",
"example": "https://mailchimp.com/developer/marketing/docs/errors/",
"description": "An absolute URI that identifies the problem type. When dereferenced, it should provide human-readable documentation for the problem type."
},
"title": {
"type": "string",
"title": "Error Title",
"example": "Resource Not Found",
"description": "A short, human-readable summary of the problem type. It shouldn't change based on the occurrence of the problem, except for purposes of localization."
},
"detail": {
"type": "string",
"title": "Error Message",
"example": "The requested resource could not be found.",
"description": "A human-readable explanation specific to this occurrence of the problem. [Learn more about errors](https://mailchimp.com/developer/)."
},
"status": {
"type": "integer",
"title": "HTTP Status Code",
"example": 404,
"description": "The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem."
},
"instance": {
"type": "string",
"title": "Instance ID",
"example": "995c5cb0-3280-4a6e-808b-3b096d0bb219",
"description": "A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support."
}
},
"description": "An error generated by the Mailchimp API. Conforms to IETF draft 'draft-nottingham-http-problem-06'."
}
AutomationsArchiveActionResponse
{
"type": "object",
"title": "Problem Detail Document",
"required": [
"type",
"title",
"status",
"detail",
"instance"
],
"properties": {
"type": {
"type": "string",
"title": "Problem Type",
"example": "https://mailchimp.com/developer/marketing/docs/errors/",
"description": "An absolute URI that identifies the problem type. When dereferenced, it should provide human-readable documentation for the problem type."
},
"title": {
"type": "string",
"title": "Error Title",
"example": "Resource Not Found",
"description": "A short, human-readable summary of the problem type. It shouldn't change based on the occurrence of the problem, except for purposes of localization."
},
"detail": {
"type": "string",
"title": "Error Message",
"example": "The requested resource could not be found.",
"description": "A human-readable explanation specific to this occurrence of the problem. [Learn more about errors](https://mailchimp.com/developer/)."
},
"status": {
"type": "integer",
"title": "HTTP Status Code",
"example": 404,
"description": "The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem."
},
"instance": {
"type": "string",
"title": "Instance ID",
"example": "995c5cb0-3280-4a6e-808b-3b096d0bb219",
"description": "A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support."
}
},
"description": "An error generated by the Mailchimp API. Conforms to IETF draft 'draft-nottingham-http-problem-06'."
}
AutomationsArchiveActiondefaultResponse
{
"type": "object",
"title": "Problem Detail Document",
"required": [
"type",
"title",
"status",
"detail",
"instance"
],
"properties": {
"type": {
"type": "string",
"title": "Problem Type",
"example": "https://mailchimp.com/developer/marketing/docs/errors/",
"description": "An absolute URI that identifies the problem type. When dereferenced, it should provide human-readable documentation for the problem type."
},
"title": {
"type": "string",
"title": "Error Title",
"example": "Resource Not Found",
"description": "A short, human-readable summary of the problem type. It shouldn't change based on the occurrence of the problem, except for purposes of localization."
},
"detail": {
"type": "string",
"title": "Error Message",
"example": "The requested resource could not be found.",
"description": "A human-readable explanation specific to this occurrence of the problem. [Learn more about errors](https://mailchimp.com/developer/)."
},
"status": {
"type": "integer",
"title": "HTTP Status Code",
"example": 404,
"description": "The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem."
},
"instance": {
"type": "string",
"title": "Instance ID",
"example": "995c5cb0-3280-4a6e-808b-3b096d0bb219",
"description": "A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support."
}
},
"description": "An error generated by the Mailchimp API. Conforms to IETF draft 'draft-nottingham-http-problem-06'."
}
AutomationsClassicAutomationSubscriberInfo200Response
{
"type": "object",
"title": "Subscriber in Automation Queue",
"properties": {
"id": {
"type": "string",
"title": "Email Hash",
"readOnly": true,
"description": "The MD5 hash of the lowercase version of the list member's email address."
},
"_links": {
"type": "array",
"items": {
"type": "object",
"title": "Resource Link",
"properties": {
"rel": {
"type": "string",
"title": "Rel",
"readOnly": true,
"description": "As with an HTML 'rel' attribute, this describes the type of link."
},
"href": {
"type": "string",
"title": "Href",
"readOnly": true,
"description": "This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action."
},
"method": {
"enum": [
"GET",
"POST",
"PUT",
"PATCH",
"DELETE",
"OPTIONS",
"HEAD"
],
"type": "string",
"title": "Method",
"readOnly": true,
"description": "The HTTP method that should be used when accessing the URL defined in 'href'."
},
"schema": {
"type": "string",
"title": "Schema",
"readOnly": true,
"description": "For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to."
},
"targetSchema": {
"type": "string",
"title": "Target Schema",
"readOnly": true,
"description": "For GETs, this is a URL representing the schema that the response should conform to."
}
},
"description": "This object represents a link from the resource where it is found to another resource or action that may be performed."
},
"title": "Links",
"readOnly": true,
"description": "A list of link types and descriptions for the API schema documents."
},
"list_id": {
"type": "string",
"title": "List ID",
"readOnly": true,
"description": "A string that uniquely identifies a list."
},
"email_id": {
"type": "string",
"title": "Automation Email ID",
"readOnly": true,
"description": "A string that uniquely identifies an email in an Automation workflow."
},
"next_send": {
"type": "string",
"title": "Next Send",
"format": "date-time",
"readOnly": true,
"description": "The date and time of the next send for the workflow email in ISO 8601 format."
},
"workflow_id": {
"type": "string",
"title": "Workflow ID",
"readOnly": true,
"description": "A string that uniquely identifies an Automation workflow."
},
"email_address": {
"type": "string",
"title": "Email Address",
"description": "The list member's email address."
},
"list_is_active": {
"type": "boolean",
"title": "List Status",
"readOnly": true,
"description": "The status of the list used, namely if it's deleted or disabled."
}
},
"description": "Information about subscribers in an Automation email queue."
}
AutomationsClassicAutomationSubscriberInfoResponse
{
"type": "object",
"title": "Subscriber in Automation Queue",
"properties": {
"id": {
"type": "string",
"title": "Email Hash",
"readOnly": true,
"description": "The MD5 hash of the lowercase version of the list member's email address."
},
"_links": {
"type": "array",
"items": {
"type": "object",
"title": "Resource Link",
"properties": {
"rel": {
"type": "string",
"title": "Rel",
"readOnly": true,
"description": "As with an HTML 'rel' attribute, this describes the type of link."
},
"href": {
"type": "string",
"title": "Href",
"readOnly": true,
"description": "This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action."
},
"method": {
"enum": [
"GET",
"POST",
"PUT",
"PATCH",
"DELETE",
"OPTIONS",
"HEAD"
],
"type": "string",
"title": "Method",
"readOnly": true,
"description": "The HTTP method that should be used when accessing the URL defined in 'href'."
},
"schema": {
"type": "string",
"title": "Schema",
"readOnly": true,
"description": "For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to."
},
"targetSchema": {
"type": "string",
"title": "Target Schema",
"readOnly": true,
"description": "For GETs, this is a URL representing the schema that the response should conform to."
}
},
"description": "This object represents a link from the resource where it is found to another resource or action that may be performed."
},
"title": "Links",
"readOnly": true,
"description": "A list of link types and descriptions for the API schema documents."
},
"list_id": {
"type": "string",
"title": "List ID",
"readOnly": true,
"description": "A string that uniquely identifies a list."
},
"email_id": {
"type": "string",
"title": "Automation Email ID",
"readOnly": true,
"description": "A string that uniquely identifies an email in an Automation workflow."
},
"next_send": {
"type": "string",
"title": "Next Send",
"format": "date-time",
"readOnly": true,
"description": "The date and time of the next send for the workflow email in ISO 8601 format."
},
"workflow_id": {
"type": "string",
"title": "Workflow ID",
"readOnly": true,
"description": "A string that uniquely identifies an Automation workflow."
},
"email_address": {
"type": "string",
"title": "Email Address",
"description": "The list member's email address."
},
"list_is_active": {
"type": "boolean",
"title": "List Status",
"readOnly": true,
"description": "The status of the list used, namely if it's deleted or disabled."
}
},
"description": "Information about subscribers in an Automation email queue."
}
AutomationsClassicAutomationSubscriberInfodefaultResponse
{
"type": "object",
"title": "Problem Detail Document",
"required": [
"type",
"title",
"status",
"detail",
"instance"
],
"properties": {
"type": {
"type": "string",
"title": "Problem Type",
"example": "https://mailchimp.com/developer/marketing/docs/errors/",
"description": "An absolute URI that identifies the problem type. When dereferenced, it should provide human-readable documentation for the problem type."
},
"title": {
"type": "string",
"title": "Error Title",
"example": "Resource Not Found",
"description": "A short, human-readable summary of the problem type. It shouldn't change based on the occurrence of the problem, except for purposes of localization."
},
"detail": {
"type": "string",
"title": "Error Message",
"example": "The requested resource could not be found.",
"description": "A human-readable explanation specific to this occurrence of the problem. [Learn more about errors](https://mailchimp.com/developer/)."
},
"status": {
"type": "integer",
"title": "HTTP Status Code",
"example": 404,
"description": "The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem."
},
"instance": {
"type": "string",
"title": "Instance ID",
"example": "995c5cb0-3280-4a6e-808b-3b096d0bb219",
"description": "A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support."
}
},
"description": "An error generated by the Mailchimp API. Conforms to IETF draft 'draft-nottingham-http-problem-06'."
}
AutomationsCreateClassic200Response
{
"type": "object",
"title": "Automation Workflow",
"properties": {
"id": {
"type": "string",
"title": "Automation Campaign ID",
"readOnly": true,
"description": "A string that identifies the Automation."
},
"_links": {
"type": "array",
"items": {
"type": "object",
"title": "Resource Link",
"properties": {
"rel": {
"type": "string",
"title": "Rel",
"readOnly": true,
"description": "As with an HTML 'rel' attribute, this describes the type of link."
},
"href": {
"type": "string",
"title": "Href",
"readOnly": true,
"description": "This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action."
},
"method": {
"enum": [
"GET",
"POST",
"PUT",
"PATCH",
"DELETE",
"OPTIONS",
"HEAD"
],
"type": "string",
"title": "Method",
"readOnly": true,
"description": "The HTTP method that should be used when accessing the URL defined in 'href'."
},
"schema": {
"type": "string",
"title": "Schema",
"readOnly": true,
"description": "For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to."
},
"targetSchema": {
"type": "string",
"title": "Target Schema",
"readOnly": true,
"description": "For GETs, this is a URL representing the schema that the response should conform to."
}
},
"description": "This object represents a link from the resource where it is found to another resource or action that may be performed."
},
"title": "Links",
"readOnly": true,
"description": "A list of link types and descriptions for the API schema documents."
},
"status": {
"enum": [
"save",
"paused",
"sending"
],
"type": "string",
"title": "Automation Status",
"readOnly": true,
"description": "The current status of the Automation."
},
"settings": {
"type": "object",
"title": "Automation Campaign Settings",
"properties": {
"title": {
"type": "string",
"title": "Automation Title",
"description": "The title of the Automation."
},
"to_name": {
"type": "string",
"title": "To Name",
"description": "The Automation's custom 'To' name, typically the first name [audience field](https://mailchimp.com/help/getting-started-with-merge-tags/)."
},
"reply_to": {
"type": "string",
"title": "Reply To Address",
"description": "The reply-to email address for the Automation."
},
"from_name": {
"type": "string",
"title": "From Name",
"description": "The 'from' name for the Automation (not an email address)."
},
"inline_css": {
"type": "boolean",
"title": "Inline CSS",
"description": "Whether to automatically inline the CSS included with the Automation content."
},
"auto_footer": {
"type": "boolean",
"title": "Auto-Footer",
"description": "Whether to automatically append Mailchimp's [default footer](https://mailchimp.com/help/about-campaign-footers/) to the Automation."
},
"authenticate": {
"type": "boolean",
"title": "Authentication",
"description": "Whether Mailchimp [authenticated](https://mailchimp.com/help/about-email-authentication/) the Automation. Defaults to `true`."
},
"use_conversation": {
"type": "boolean",
"title": "Conversations",
"description": "Whether to use Mailchimp Conversation feature to manage replies"
}
},
"description": "The settings for the Automation workflow."
},
"tracking": {
"type": "object",
"title": "Automation Tracking Options",
"properties": {
"opens": {
"type": "boolean",
"title": "Opens",
"description": "Whether to [track opens](https://mailchimp.com/help/about-open-tracking/). Defaults to `true`."
},
"capsule": {
"type": "object",
"title": "Capsule CRM Tracking",
"properties": {
"notes": {
"type": "boolean",
"title": "Capsule Note",
"description": "Update contact notes for a campaign based on a subscriber's email addresses."
}
},
"description": "Deprecated"
},
"ecomm360": {
"type": "boolean",
"title": "E-commerce Tracking",
"description": "Whether to enable e-commerce tracking."
},
"clicktale": {
"type": "string",
"title": "ClickTale Analytics Tracking",
"description": "The custom slug for [ClickTale](https://mailchimp.com/help/additional-tracking-options-for-campaigns/) tracking (max of 50 bytes)."
},
"salesforce": {
"type": "object",
"title": "Salesforce CRM Tracking",
"properties": {
"notes": {
"type": "boolean",
"title": "Salesforce Note",
"description": "Update contact notes for a campaign based on a subscriber's email address."
},
"campaign": {
"type": "boolean",
"title": "Salesforce Campaign",
"description": "Create a campaign in a connected Salesforce account."
}
},
"description": "Deprecated"
},
"html_clicks": {
"type": "boolean",
"title": "HTML Click Tracking",
"description": "Whether to [track clicks](https://mailchimp.com/help/enable-and-view-click-tracking/) in the HTML version of the Automation. Defaults to `true`."
},
"text_clicks": {
"type": "boolean",
"title": "Plain-Text Click Tracking",
"description": "Whether to [track clicks](https://mailchimp.com/help/enable-and-view-click-tracking/) in the plain-text version of the Automation. Defaults to `true`."
},
"goal_tracking": {
"type": "boolean",
"title": "Mailchimp Goal Tracking",
"description": "Deprecated"
},
"google_analytics": {
"type": "string",
"title": "Google Analytics Tracking",
"description": "The custom slug for [Google Analytics](https://mailchimp.com/help/integrate-google-analytics-with-mailchimp/) tracking (max of 50 bytes)."
}
},
"description": "The tracking options for the Automation."
},
"recipients": {
"type": "object",
"title": "List",
"properties": {
"list_id": {
"type": "string",
"title": "List ID",
"description": "The unique list id."
},
"store_id": {
"type": "string",
"title": "Store ID",
"example": "1a2df69xxx",
"description": "The id of the store."
},
"list_name": {
"type": "string",
"title": "List Name",
"description": "List Name."
},
"segment_opts": {
"type": "object",
"title": "Segment Options",
"properties": {
"match": {
"enum": [
"any",
"all"
],
"type": "string",
"title": "Match Type",
"description": "Segment match type."
},
"conditions": {
"type": "array",
"items": {
"oneOf": [
{
"type": "object",
"title": "Aim Segment",
"properties": {
"op": {
"enum": [
"open",
"click",
"sent",
"noopen",
"noclick",
"nosent"
],
"type": "string",
"title": "Segment Operator",
"example": "open",
"description": "The status of the member with regard to their campaign interaction. One of the following: opened, clicked, was sent, didn't open, didn't click, or was not sent."
},
"field": {
"enum": [
"aim"
],
"type": "string",
"title": "Segment Field",
"example": "aim",
"description": "Segment by interaction with a specific campaign."
},
"value": {
"type": "string",
"title": "Segment Data",
"example": "any",
"description": "Either the web id value for a specific campaign or 'any' to account for subscribers who have/have not interacted with any campaigns."
},
"condition_type": {
"enum": [
"Aim"
],
"type": "string",
"x-value": "Aim"
}
},
"description": "Segment by interaction with a specific campaign."
},
{
"type": "object",
"title": "Automation Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"started",
"completed",
"not_started",
"not_completed"
],
"type": "string",
"title": "Segment Operator",
"example": "started",
"description": "The status of the member with regard to the automation workflow. One of the following: has started the workflow, has completed the workflow, has not started the workflow, or has not completed the workflow."
},
"field": {
"enum": [
"automation"
],
"type": "string",
"title": "Segment Field",
"example": "automation",
"description": "Segment by interaction with an Automation workflow."
},
"value": {
"type": "string",
"title": "Segment Data",
"example": "2135217",
"description": "The web id for the automation workflow to segment against."
},
"condition_type": {
"enum": [
"Automation"
],
"type": "string",
"x-value": "Automation"
}
},
"description": "Segment by interaction with an Automation workflow."
},
{
"type": "object",
"title": "Poll Activity Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"member",
"notmember"
],
"type": "string",
"title": "Segment Operator",
"example": "member",
"description": "Members have/have not interacted with a specific poll in a Mailchimp email."
},
"field": {
"enum": [
"poll"
],
"type": "string",
"title": "Segment Field",
"example": "poll",
"description": "Segment by poll activity."
},
"value": {
"type": "number",
"title": "Segment Operator",
"example": 409,
"description": "The id for the poll."
},
"condition_type": {
"enum": [
"CampaignPoll"
],
"type": "string",
"x-value": "CampaignPoll"
}
},
"description": "Segment by poll activity."
},
{
"type": "object",
"title": "Conversation Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"member",
"notmember"
],
"type": "string",
"title": "Segment Operator",
"example": "member",
"description": "The status of a member's interaction with a conversation. One of the following: has replied or has not replied."
},
"field": {
"enum": [
"conversation"
],
"type": "string",
"title": "Segment Field",
"example": "conversation",
"description": "Segment by interaction with a campaign via Conversations."
},
"value": {
"type": "string",
"title": "Segment Data",
"example": "any",
"description": "The web id value for a specific campaign or 'any' to account for subscribers who have/have not interacted with any campaigns."
},
"condition_type": {
"enum": [
"Conversation"
],
"type": "string",
"x-value": "Conversation"
}
},
"description": "Segment by interaction with a campaign via Conversations."
},
{
"type": "object",
"title": "Date Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"greater",
"less",
"is",
"not",
"blank",
"blank_not",
"within",
"notwithin"
],
"type": "string",
"title": "Segment Operator",
"example": "greater",
"description": "When the event took place: Before, after, is a specific date, is not a specific date, is blank, or is not blank."
},
"extra": {
"type": "string",
"title": "Segment Extra Value",
"example": "2015-01-30",
"description": "When segmenting on 'date' or 'campaign', the date for the segment formatted as YYYY-MM-DD or the web id for the campaign."
},
"field": {
"enum": [
"timestamp_opt",
"info_changed",
"ecomm_date"
],
"type": "string",
"title": "Segment Field",
"example": "timestamp_opt",
"description": "The type of date field to segment on: The opt-in time for a signup, the date the subscriber was last updated, or the date of their last ecomm purchase."
},
"value": {
"type": "string",
"title": "Segment Data",
"example": "date",
"description": "What type of data to segment on: a specific date, a specific campaign, or the last campaign sent."
},
"condition_type": {
"enum": [
"Date"
],
"type": "string",
"x-value": "Date"
}
},
"description": "Segment by a specific date field."
},
{
"type": "object",
"title": "Email Client Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"client_is",
"client_not"
],
"type": "string",
"title": "Segment Operator",
"example": "client_is",
"description": "The operation to determine whether we select clients that match the value, or clients that do not match the value."
},
"field": {
"enum": [
"email_client"
],
"type": "string",
"title": "Segment Field",
"example": "email_client",
"description": "Segment by use of a particular email client."
},
"value": {
"type": "string",
"title": "Segment Data",
"example": "Gmail",
"description": "The name of the email client."
},
"condition_type": {
"enum": [
"EmailClient"
],
"type": "string",
"x-value": "EmailClient"
}
},
"description": "Segment by use of a particular email client."
},
{
"type": "object",
"title": "Language Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"is",
"not"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Whether the member's language is or is not set to a specific language."
},
"field": {
"enum": [
"language"
],
"type": "string",
"title": "Segment Field",
"example": "language",
"description": "Segmenting based off of a subscriber's language."
},
"value": {
"type": "string",
"title": "Segment Data",
"example": "en",
"description": "A two-letter language identifier."
},
"condition_type": {
"enum": [
"Language"
],
"type": "string",
"x-value": "Language"
}
},
"description": "Segment by language."
},
{
"type": "object",
"title": "Member Rating Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"is",
"not",
"greater",
"less"
],
"type": "string",
"title": "Segment Operator",
"example": "greater",
"description": "Members who have have a rating that is/not exactly a given number or members who have a rating greater/less than a given number."
},
"field": {
"enum": [
"rating"
],
"type": "string",
"title": "Segment Field",
"example": "rating",
"description": "Segment by member rating."
},
"value": {
"type": "number",
"title": "Segment Operator",
"example": 4,
"description": "The star rating number to segment against."
},
"condition_type": {
"enum": [
"MemberRating"
],
"type": "string",
"x-value": "MemberRating"
}
},
"description": "Segment by member rating."
},
{
"type": "object",
"title": "Signup Source Segment",
"required": [
"field",
"condition_type",
"op"
],
"properties": {
"op": {
"enum": [
"source_is",
"source_not"
],
"type": "string",
"title": "Segment Operator",
"example": "source_is",
"description": "Whether the member's signup source was/was not a particular value."
},
"field": {
"enum": [
"source"
],
"type": "string",
"title": "Segment Field",
"example": "source"
},
"value": {
"type": "string",
"title": "Segment Data",
"example": "List Import",
"description": "The signup source."
},
"condition_type": {
"enum": [
"SignupSource"
],
"type": "string",
"title": "Type",
"x-value": "SignupSource"
}
},
"description": "Segment by signup source."
},
{
"type": "object",
"title": "Survey Monkey Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"started",
"completed",
"not_started",
"not_completed"
],
"type": "string",
"title": "Segment Operator",
"example": "started",
"description": "The status of the member with regard to the survey.One of the following: has started the survey, has completed the survey, has not started the survey, or has not completed the survey."
},
"field": {
"enum": [
"survey_monkey"
],
"type": "string",
"title": "Segment Field",
"example": "survey_monkey",
"description": "Segment by interaction with a SurveyMonkey survey."
},
"value": {
"type": "string",
"title": "Survey ID",
"example": "32179586",
"description": "The unique ID of the survey monkey survey."
},
"condition_type": {
"enum": [
"SurveyMonkey"
],
"type": "string",
"x-value": "SurveyMonkey"
}
},
"description": "Segment by interaction with a SurveyMonkey survey."
},
{
"type": "object",
"title": "VIP Segment",
"required": [
"field",
"op"
],
"properties": {
"op": {
"enum": [
"member",
"notmember"
],
"type": "string",
"title": "Segment Operator",
"example": "member",
"description": "Whether the member is or is not marked as VIP."
},
"field": {
"enum": [
"gmonkey"
],
"type": "string",
"title": "Segment Field",
"example": "gmonkey",
"description": "Segment by VIP status."
},
"condition_type": {
"enum": [
"VIP"
],
"type": "string",
"x-value": "VIP"
}
},
"description": "Segment by VIP status."
},
{
"type": "object",
"title": "Interests Segment",
"properties": {
"op": {
"enum": [
"interestcontains",
"interestcontainsall",
"interestnotcontains"
],
"type": "string",
"title": "Segment Operator",
"example": "interestcontains",
"description": "Whether the member is a part of one, all, or none of the groups."
},
"field": {
"type": "string",
"title": "Segment Field",
"example": "interests-123",
"description": "Segmenting based on interest group information. This should start with 'interests-' followed by the grouping id. Ex. 'interests-123'."
},
"value": {
"type": "array",
"items": {
"type": "string",
"example": [
"44401",
"44405",
"44409"
]
},
"title": "Segment Value",
"description": "An array containing strings, each representing a group id."
},
"condition_type": {
"enum": [
"Interests"
],
"type": "string",
"x-value": "Interests"
}
},
"description": "Segment by an interest group merge field."
},
{
"type": "object",
"title": "Ecommerce Category Segment",
"properties": {
"op": {
"enum": [
"is",
"not",
"contains",
"notcontain",
"starts",
"ends"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "A member who has purchased from a category/specific item that is/is not a specific name, where the category/item name contains/doesn't contain a specific phrase or string, or a category/item name that starts/ends with a string."
},
"field": {
"enum": [
"ecomm_cat",
"ecomm_prod"
],
"type": "string",
"title": "Segment Field",
"example": "ecomm_cat",
"description": "Segment by purchases in specific items or categories."
},
"value": {
"type": "string",
"title": "Segment Data",
"example": "Product",
"description": "The ecommerce category/item information."
},
"condition_type": {
"enum": [
"EcommCategory"
],
"type": "string",
"x-value": "EcommCategory"
}
},
"description": "Segment by purchases in specific items or categories."
},
{
"type": "object",
"title": "Ecommerce Number Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"is",
"not",
"greater",
"less"
],
"type": "string",
"title": "Segment Operator",
"example": "greater",
"description": "Members who have spent exactly, have not spent exactly, spent more, or spent less than the segment value."
},
"field": {
"enum": [
"ecomm_spent_avg",
"ecomm_orders",
"ecomm_prod_all",
"ecomm_avg_ord"
],
"type": "string",
"title": "Segment Field",
"example": "ecomm_orders",
"description": "Segment by average spent total, number of orders, total number of products purchased, or average number of products per order."
},
"value": {
"type": "number",
"title": "Segment Operator",
"example": 42,
"description": "Members who have spent exactly, have not spent exactly, spent more, or spent less than this amount."
},
"condition_type": {
"enum": [
"EcommNumber"
],
"type": "string",
"x-value": "EcommNumber"
}
},
"description": "Segment by average spent total, number of orders, total number of products purchased, or average number of products per order."
},
{
"type": "object",
"title": "Ecommerce Purchased Segment",
"properties": {
"op": {
"enum": [
"member",
"notmember"
],
"type": "string",
"title": "Segment Operator",
"example": "member",
"description": "Members who have have ('member') or have not ('notmember') purchased."
},
"field": {
"enum": [
"ecomm_purchased"
],
"type": "string",
"title": "Segment Field",
"example": "ecomm_purchased",
"description": "Segment by whether someone has purchased anything."
},
"condition_type": {
"enum": [
"EcommPurchased"
],
"type": "string",
"x-value": "EcommPurchased"
}
},
"description": "Segment by whether someone has purchased anything."
},
{
"type": "object",
"title": "Ecommerce Spent Segment",
"properties": {
"op": {
"enum": [
"greater",
"less"
],
"type": "string",
"title": "Segment Operator",
"example": "greater",
"description": "Members who have spent 'more' or 'less' than then specified value."
},
"field": {
"enum": [
"ecomm_spent_one",
"ecomm_spent_all"
],
"type": "string",
"title": "Segment Field",
"example": "ecomm_spent_one",
"description": "Segment by amount spent on a single order or across all orders."
},
"value": {
"type": "integer",
"title": "Segment Data",
"example": 42,
"description": "The total amount a member spent."
},
"condition_type": {
"enum": [
"EcommSpent"
],
"type": "string",
"x-value": "EcommSpent"
}
},
"description": "Segment by amount spent on a single order or across all orders."
},
{
"type": "object",
"title": "Ecommerce Purchased Store Segment",
"properties": {
"op": {
"enum": [
"is",
"not"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Members who have or have not purchased from a specific store."
},
"field": {
"enum": [
"ecomm_store"
],
"type": "string",
"title": "Segment Field",
"example": "ecomm_store",
"description": "Segment by purchases from a specific store."
},
"value": {
"type": "string",
"title": "Segment Operator",
"example": "289",
"description": "The store id to segment against."
},
"condition_type": {
"enum": [
"EcommStore"
],
"type": "string",
"x-value": "EcommStore"
}
},
"description": "Segment by purchases from a specific store."
},
{
"type": "object",
"title": "Goal Activity Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"is",
"goal_not",
"contains",
"goal_notcontain",
"starts",
"ends"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Whether the website URL is/not exactly, contains/doesn't contain, starts with/ends with a string."
},
"field": {
"enum": [
"goal"
],
"type": "string",
"title": "Segment Field",
"example": "goal",
"description": "Segment by Goal activity."
},
"value": {
"type": "string",
"title": "Segment Value",
"description": "The URL to check Goal activity against."
},
"condition_type": {
"enum": [
"GoalActivity"
],
"type": "string",
"x-value": "GoalActivity"
}
},
"description": "Segment by Goal activity."
},
{
"type": "object",
"title": "Goal Timestamp Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"greater",
"less",
"is"
],
"type": "string",
"title": "Segment Operator",
"example": "greater",
"description": "Whether the website activity happened after, before, or at a given timestamp."
},
"field": {
"enum": [
"goal_last_visited"
],
"type": "string",
"title": "Segment Field",
"example": "goal_last_visited",
"description": "Segment by most recent interaction with a website."
},
"value": {
"type": "string",
"title": "Segment Value",
"example": "2015-07-20 19:45:21",
"description": "The date to check Goal activity against."
},
"condition_type": {
"enum": [
"GoalTimestamp"
],
"type": "string",
"x-value": "GoalTimestamp"
}
},
"description": "Segment by most recent interaction with a website."
},
{
"type": "object",
"title": "Similar Subscribers Segment Member Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"fuzzy_is",
"fuzzy_not"
],
"type": "string",
"title": "Segment Operator",
"example": "fuzzy_is",
"description": "Members who are/are not apart of a 'similar subscribers' segment."
},
"field": {
"enum": [
"fuzzy_segment"
],
"type": "string",
"title": "Segment Field",
"example": "fuzzy_segment",
"description": "Segment by similar subscribers."
},
"value": {
"type": "number",
"title": "Segment Operator",
"example": 48433,
"description": "The id for the 'similar subscribers' segment."
},
"condition_type": {
"enum": [
"FuzzySegment"
],
"type": "string",
"x-value": "FuzzySegment"
}
},
"description": "Segment by similar subscribers."
},
{
"type": "object",
"title": "Static Segment Member Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"static_is",
"static_not"
],
"type": "string",
"title": "Segment Operator",
"example": "static_is",
"description": "Members who are/are not apart of a static segment."
},
"field": {
"enum": [
"static_segment"
],
"type": "string",
"title": "Segment Field",
"example": "static_segment",
"description": "Segment by a given static segment."
},
"value": {
"type": "number",
"title": "Segment Operator",
"example": 48433,
"description": "The id for the static segment."
},
"condition_type": {
"enum": [
"StaticSegment"
],
"type": "string",
"x-value": "StaticSegment"
}
},
"description": "Segment by a given static segment."
},
{
"type": "object",
"title": "Location-Based Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"ipgeocountry",
"ipgeonotcountry",
"ipgeostate",
"ipgeonotstate"
],
"type": "string",
"title": "Segment Operator",
"example": "ipgeocountry",
"description": "Segment members who are within a specific country or US state."
},
"field": {
"enum": [
"ipgeo"
],
"type": "string",
"title": "Segment Field",
"example": "ipgeo",
"description": "Segmenting subscribers who are within a specific location."
},
"value": {
"type": "string",
"title": "Segment Data",
"example": "US",
"description": "The two-letter country code or US state abbreviation."
},
"condition_type": {
"enum": [
"IPGeoCountryState"
],
"type": "string",
"x-value": "IPGeoCountryState"
}
},
"description": "Segment by a specific country or US state."
},
{
"type": "object",
"title": "Geolocation Segment",
"required": [
"field",
"op",
"value",
"addr",
"lat",
"lng"
],
"properties": {
"op": {
"enum": [
"ipgeoin",
"ipgeonotin"
],
"type": "string",
"title": "Segment Operator",
"example": "ipgeoin",
"description": "Segment members who are within a specific geographic region."
},
"lat": {
"type": "string",
"title": "Segment Location Latitude",
"example": "33.7489954",
"description": "The latitude of the target location."
},
"lng": {
"type": "string",
"title": "Segment Location Longitude",
"example": "-84.3879824",
"description": "The longitude of the target location."
},
"addr": {
"type": "string",
"title": "Segment Location Address",
"example": "Atlanta, GA, USA",
"description": "The address of the target location."
},
"field": {
"enum": [
"ipgeo"
],
"type": "string",
"title": "Segment Field",
"example": "ipgeo",
"description": "Segmenting subscribers who are within a specific location."
},
"value": {
"type": "integer",
"title": "Segment Data",
"example": 42,
"description": "The radius of the target location."
},
"condition_type": {
"enum": [
"IPGeoIn"
],
"type": "string",
"x-value": "IPGeoIn"
}
},
"description": "Segment by a specific geographic region."
},
{
"type": "object",
"title": "US Zip Code Segment",
"required": [
"field",
"op",
"value",
"extra"
],
"properties": {
"op": {
"enum": [
"ipgeoinzip"
],
"type": "string",
"title": "Segment Operator",
"example": "ipgeoinzip",
"description": "Segment members who are within a specific US zip code."
},
"extra": {
"type": "integer",
"title": "Extra Data",
"example": 30318,
"description": "The zip code to segment against."
},
"field": {
"enum": [
"ipgeo"
],
"type": "string",
"title": "Segment Field",
"example": "ipgeo",
"description": "Segmenting subscribers who are within a specific location."
},
"value": {
"type": "integer",
"title": "Segment Data",
"example": 25,
"description": "The radius of the target location."
},
"condition_type": {
"enum": [
"IPGeoInZip"
],
"type": "string",
"x-value": "IPGeoInZip"
}
},
"description": "Segment by a specific US ZIP code."
},
{
"type": "object",
"title": "Unknown Location-Based Segment",
"required": [
"field",
"op"
],
"properties": {
"op": {
"enum": [
"ipgeounknown"
],
"type": "string",
"title": "Segment Operator",
"example": "ipgeounknown",
"description": "Segment members for which location information is unknown."
},
"field": {
"enum": [
"ipgeo"
],
"type": "string",
"title": "Segment Field",
"example": "ipgeo",
"description": "Segmenting subscribers who are within a specific location."
},
"condition_type": {
"enum": [
"IPGeoUnknown"
],
"type": "string",
"x-value": "IPGeoUnknown"
}
},
"description": "Segment members whose location information is unknown."
},
{
"type": "object",
"title": "Zip Code Location-Based Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"ipgeoiszip",
"ipgeonotzip"
],
"type": "string",
"title": "Segment Operator",
"example": "ipgeonotzip",
"description": "Segment members who are/are not within a specific US zip code."
},
"field": {
"enum": [
"ipgeo"
],
"type": "string",
"title": "Segment Field",
"example": "ipgeo",
"description": "Segmenting subscribers who are within a specific location."
},
"value": {
"type": "integer",
"title": "Segment Data",
"example": 30318,
"description": "The 5-digit zip code."
},
"condition_type": {
"enum": [
"IPGeoZip"
],
"type": "string",
"x-value": "IPGeoZip"
}
},
"description": "Segment by a specific US ZIP code."
},
{
"type": "object",
"title": "Social Profiles Age Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"is",
"not"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Members who are/not the exact criteria listed."
},
"field": {
"enum": [
"social_age"
],
"type": "string",
"title": "Segment Field",
"example": "social_age",
"description": "Segment by age ranges in Social Profiles data."
},
"value": {
"enum": [
"18-24",
"25-34",
"35-54",
"55+"
],
"type": "string",
"title": "Segment Operator",
"example": "35-54",
"description": "The age range to segment."
},
"condition_type": {
"enum": [
"SocialAge"
],
"type": "string",
"x-value": "SocialAge"
}
},
"description": "Segment by age ranges in Social Profiles data."
},
{
"type": "object",
"title": "Social Profiles Gender Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"is",
"not"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Members who are/not the exact criteria listed."
},
"field": {
"enum": [
"social_gender"
],
"type": "string",
"title": "Segment Field",
"example": "social_gender",
"description": "Segment by listed gender in Social Profiles data."
},
"value": {
"enum": [
"male",
"female"
],
"type": "string",
"title": "Segment Operator",
"example": "female",
"description": "The Social Profiles gender to segment."
},
"condition_type": {
"enum": [
"SocialGender"
],
"type": "string",
"x-value": "SocialGender"
}
},
"description": "Segment by listed gender in Social Profiles data."
},
{
"type": "object",
"title": "Social Profiles Influence Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"is",
"not",
"greater",
"less"
],
"type": "string",
"title": "Segment Operator",
"example": "greater",
"description": "Members who have a rating that is/not or greater/less than the rating provided."
},
"field": {
"enum": [
"social_influence"
],
"type": "string",
"title": "Segment Field",
"example": "social_influence",
"description": "Segment by influence rating in Social Profiles data."
},
"value": {
"type": "number",
"title": "Segment Operator",
"example": 2,
"description": "The Social Profiles influence rating to segment."
},
"condition_type": {
"enum": [
"SocialInfluence"
],
"type": "string",
"x-value": "SocialInfluence"
}
},
"description": "Segment by influence rating in Social Profiles data."
},
{
"type": "object",
"title": "Social Profiles Social Network Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"member",
"notmember"
],
"type": "string",
"title": "Segment Operator",
"example": "member",
"description": "Members who are/not on a given social network."
},
"field": {
"enum": [
"social_network"
],
"type": "string",
"title": "Segment Field",
"example": "social_network",
"description": "Segment by social network in Social Profiles data."
},
"value": {
"enum": [
"twitter",
"facebook",
"linkedin",
"flickr",
"foursquare",
"lastfm",
"myspace",
"quora",
"vimeo",
"yelp",
"youtube"
],
"type": "string",
"title": "Segment Operator",
"example": "twitter",
"description": "The social network to segment against."
},
"condition_type": {
"enum": [
"SocialNetworkMember"
],
"type": "string",
"x-value": "SocialNetworkMember"
}
},
"description": "Segment by social network in Social Profiles data."
},
{
"type": "object",
"title": "Social Profiles Social Network Follow Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"follow",
"notfollow"
],
"type": "string",
"title": "Segment Operator",
"example": "follow",
"description": "Members who are/not following a linked account on a given social network."
},
"field": {
"enum": [
"social_network"
],
"type": "string",
"title": "Segment Field",
"example": "social_network",
"description": "Segment by social network in Social Profiles data."
},
"value": {
"enum": [
"twitter_follow"
],
"type": "string",
"title": "Segment Operator",
"example": "twitter_follow",
"description": "The social network to segment against."
},
"condition_type": {
"enum": [
"SocialNetworkFollow"
],
"type": "string",
"x-value": "SocialNetworkFollow"
}
},
"description": "Segment by social network in Social Profiles data."
},
{
"type": "object",
"title": "Address Merge Field Segment",
"required": [
"field",
"op"
],
"properties": {
"op": {
"enum": [
"contains",
"notcontain",
"blank",
"blank_not"
],
"type": "string",
"title": "Segment Operator",
"example": "contains",
"description": "Whether the member's address merge field contains/does not contain a value or is/is not blank."
},
"field": {
"type": "string",
"title": "Segment Field",
"example": "MMERGE3",
"description": "An address-type merge field to segment."
},
"value": {
"type": "string",
"title": "Segment Value",
"example": "Atlanta",
"description": "The value to segment a text merge field with."
},
"condition_type": {
"enum": [
"AddressMerge"
],
"type": "string",
"x-value": "AddressMerge"
}
},
"description": "Segment by an address-type merge field."
},
{
"type": "object",
"title": "Address/Zip Merge Field Segment",
"required": [
"field",
"op",
"value",
"extra"
],
"properties": {
"op": {
"enum": [
"geoin"
],
"type": "string",
"title": "Segment Operator",
"example": "geoin",
"description": "Whether the member's address merge field is within a given distance from a city or zip."
},
"extra": {
"type": "string",
"title": "Segment Extra",
"example": "30318",
"description": "The city or the zip being used to segment against."
},
"field": {
"type": "string",
"title": "Segment Field",
"example": "MMERGE2",
"description": "An address or zip-type merge field to segment."
},
"value": {
"type": "string",
"title": "Segment Value",
"example": "25",
"description": "The distance from the city/zip."
},
"condition_type": {
"enum": [
"ZipMerge"
],
"type": "string",
"x-value": "ZipMerge"
}
},
"description": "Segment by an address-type merge field within a given distance."
},
{
"type": "object",
"title": "Birthday Merge Field Segment",
"required": [
"field",
"op"
],
"properties": {
"op": {
"enum": [
"is",
"not",
"blank",
"blank_not"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Whether the member's birthday merge information is/is not a certain date or is/is not blank."
},
"field": {
"type": "string",
"title": "Segment Field",
"example": "MMERGE4",
"description": "A date merge field to segment."
},
"value": {
"type": "string",
"title": "Segment Value",
"example": "01/30",
"description": "A date to segment against (mm/dd)."
},
"condition_type": {
"enum": [
"BirthdayMerge"
],
"type": "string",
"x-value": "BirthdayMerge"
}
},
"description": "Segment by a contact's birthday."
},
{
"type": "object",
"title": "Date Merge Field Segment",
"required": [
"field",
"op"
],
"properties": {
"op": {
"enum": [
"is",
"not",
"less",
"blank",
"blank_not",
"greater"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Whether the member's merge information is/is not, is greater/less than a value or is/is not blank."
},
"field": {
"type": "string",
"title": "Segment Field",
"example": "MMERGE5",
"description": "A date merge field to segment."
},
"value": {
"type": "string",
"title": "Segment Value",
"example": "01/30/2015",
"description": "A date to segment against."
},
"condition_type": {
"enum": [
"DateMerge"
],
"type": "string",
"x-value": "DateMerge"
}
},
"description": "Segment by a given date merge field."
},
{
"type": "object",
"title": "Dropdown/Radio Merge Field Segment",
"required": [
"field",
"op"
],
"properties": {
"op": {
"enum": [
"is",
"not",
"blank",
"blank_not",
"notcontain",
"contains"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Whether the member's merge information is/is not a value or is/is not blank."
},
"field": {
"type": "string",
"title": "Segment Field",
"example": "MMERGE6",
"description": "A merge field to segment."
},
"value": {
"type": "string",
"title": "Segment Value",
"example": "Second Choice",
"description": "The value to segment a text merge field with."
},
"condition_type": {
"enum": [
"SelectMerge"
],
"type": "string",
"x-value": "SelectMerge"
}
},
"description": "An individual segment condition"
},
{
"type": "object",
"title": "Text or Number Merge Field Segment",
"required": [
"field",
"op"
],
"properties": {
"op": {
"enum": [
"is",
"not",
"contains",
"notcontain",
"starts",
"ends",
"greater",
"less",
"blank",
"blank_not"
],
"type": "string",
"title": "Segment Operator",
"example": "contains",
"description": "Whether the member's merge information is/is not, contains/does not contain, starts/ends with, or is greater/less than a value"
},
"field": {
"type": "string",
"title": "Segment Field",
"example": "MMERGE7",
"description": "A text or number merge field to segment."
},
"value": {
"type": "string",
"title": "Segment Value",
"example": "Freddie's Jokes",
"description": "The value to segment a text or number merge field with."
},
"condition_type": {
"enum": [
"TextMerge"
],
"type": "string",
"x-value": "TextMerge"
}
},
"description": "Segment by a given text or number merge field."
},
{
"type": "object",
"title": "Email Segment",
"required": [
"field",
"op"
],
"properties": {
"op": {
"enum": [
"is",
"not",
"contains",
"notcontain",
"starts",
"ends",
"greater",
"less"
],
"type": "string",
"title": "Segment Operator",
"description": "Whether the email address is/not exactly, contains/doesn't contain, starts/ends with a string."
},
"field": {
"enum": [
"merge0",
"EMAIL"
],
"type": "string",
"title": "Segment Field",
"example": "EMAIL",
"description": "Segmenting based off of a subscriber's email address."
},
"value": {
"type": "string",
"title": "Segment Value",
"example": "urist.mcvankab@freddiesjokes.com",
"description": "The value to compare the email against."
},
"condition_type": {
"enum": [
"EmailAddress"
],
"type": "string",
"x-value": "EmailAddress"
}
},
"description": "Segment by email address."
},
{
"type": "object",
"title": "Predicted Gender Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"is",
"not"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Members who are/not the exact criteria listed."
},
"field": {
"enum": [
"predicted_gender"
],
"type": "string",
"title": "Segment Field",
"description": "Segment by predicted gender."
},
"value": {
"enum": [
"male",
"female"
],
"type": "string",
"title": "Segment Operator",
"example": "female",
"description": "The predicted gender to segment."
},
"condition_type": {
"enum": [
"PredictedGender"
],
"type": "string",
"x-value": "PredictedGender"
}
},
"description": "Segment by predicted gender."
},
{
"type": "object",
"title": "Predicted Age Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"is"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Members who are/not the exact criteria listed."
},
"field": {
"enum": [
"predicted_age_range"
],
"type": "string",
"title": "Segment Field",
"description": "Segment by predicted age."
},
"value": {
"enum": [
"18-24",
"25-34",
"35-44",
"45-54",
"55-64",
"65+"
],
"type": "string",
"title": "Segment Operator",
"example": "female",
"description": "The predicted age to segment."
},
"condition_type": {
"enum": [
"PredictedAge"
],
"type": "string",
"x-value": "PredictedAge"
}
},
"description": "Segment by predicted age."
},
{
"type": "object",
"title": "New Subscribers Prebuilt Segment",
"properties": {
"op": {
"enum": [
"date_within"
],
"type": "string",
"title": "Segment Operator",
"description": "Whe the event took place, namely within a time frame."
},
"field": {
"enum": [
"timestamp_opt"
],
"type": "string",
"title": "Segment Field",
"description": "Segment by when people subscribed."
},
"value": {
"type": "string",
"title": "Segment Data",
"description": "What type of data to segment on: a specific date, a specific campaign, or the last campaign sent."
},
"condition_type": {
"enum": [
"NewSubscribers"
],
"type": "string",
"x-value": "NewSubscribers"
}
},
"description": "Segment by when people subscribed."
}
],
"discriminator": {
"type": "string",
"propertyName": "condition_type"
}
},
"title": "Segment Type",
"description": "Segment match conditions. There are multiple possible types, see the [condition types documentation](https://mailchimp.com/developer/marketing/docs/alternative-schemas/#segment-condition-schemas)."
},
"saved_segment_id": {
"type": "integer",
"title": "Saved Segment ID",
"description": "The id for an existing saved segment."
}
},
"description": "An object representing all segmentation options."
},
"list_is_active": {
"type": "boolean",
"title": "List Status",
"readOnly": true,
"description": "The status of the list used, namely if it's deleted or disabled."
}
},
"description": "List settings for the Automation."
},
"start_time": {
"type": "string",
"title": "Start Time",
"format": "date-time",
"readOnly": true,
"description": "The date and time the Automation was started in ISO 8601 format."
},
"create_time": {
"type": "string",
"title": "Create Time",
"format": "date-time",
"readOnly": true,
"description": "The date and time the Automation was created in ISO 8601 format."
},
"emails_sent": {
"type": "integer",
"title": "Emails Sent",
"readOnly": true,
"description": "The total number of emails sent for the Automation."
},
"report_summary": {
"type": "object",
"title": "Campaign Report Summary",
"properties": {
"opens": {
"type": "integer",
"title": "Automation Opens",
"readOnly": true,
"description": "The total number of opens for a campaign."
},
"clicks": {
"type": "integer",
"title": "Total Clicks",
"readOnly": true,
"description": "The total number of clicks for an campaign."
},
"open_rate": {
"type": "number",
"title": "Open Rate",
"readOnly": true,
"description": "The number of unique opens divided by the total number of successful deliveries."
},
"click_rate": {
"type": "number",
"title": "Click Rate",
"readOnly": true,
"description": "The number of unique clicks, divided by the total number of successful deliveries."
},
"unique_opens": {
"type": "integer",
"title": "Unique Opens",
"readOnly": true,
"description": "The number of unique opens."
},
"subscriber_clicks": {
"type": "integer",
"title": "Unique Subscriber Clicks",
"readOnly": true,
"description": "The number of unique clicks."
}
},
"description": "A summary of opens and clicks for sent campaigns."
},
"trigger_settings": {
"type": "object",
"title": "Automation Trigger",
"required": [
"workflow_type"
],
"properties": {
"runtime": {
"type": "object",
"title": "Automation Workflow Runtime Settings",
"properties": {
"days": {
"type": "array",
"items": {
"enum": [
"sunday",
"monday",
"tuesday",
"wednesday",
"thursday",
"friday",
"saturday"
],
"type": "string"
},
"title": "Days",
"description": "The days an Automation workflow can send."
},
"hours": {
"type": "object",
"title": "Hours",
"required": [
"type"
],
"properties": {
"type": {
"enum": [
"send_asap",
"send_between",
"send_at"
],
"type": "string",
"title": "Email Send Time Settings",
"description": "When to send the Automation email."
}
},
"description": "The hours an Automation workflow can send."
}
},
"description": "A workflow's runtime settings for an Automation."
},
"workflow_type": {
"enum": [
"abandonedBrowse",
"abandonedCart",
"api",
"bestCustomers",
"categoryFollowup",
"dateAdded",
"emailFollowup",
"emailSeries",
"groupAdd",
"groupRemove",
"mandrill",
"productFollowup",
"purchaseFollowup",
"recurringEvent",
"specialEvent",
"visitUrl",
"welcomeSeries"
],
"type": "string",
"title": "Workflow Type",
"description": "The type of Automation workflow."
},
"workflow_title": {
"type": "string",
"title": "Workflow Title",
"readOnly": true,
"description": "The title of the workflow type."
},
"workflow_emails_count": {
"type": "integer",
"title": "Workflow Emails Count",
"readOnly": true,
"description": "The number of emails in the Automation workflow."
}
},
"description": "Available triggers for Automation workflows.",
"discriminator": {
"propertyName": "workflow_type"
}
}
},
"description": "A summary of an individual Automation workflow's settings and content."
}
AutomationsCreateClassicRequest
{
"type": "object",
"title": "Automation Workflow",
"required": [
"recipients",
"trigger_settings"
],
"properties": {
"settings": {
"type": "object",
"title": "Automation Campaign Settings",
"properties": {
"reply_to": {
"type": "string",
"title": "Reply To Address",
"description": "The reply-to email address for the Automation."
},
"from_name": {
"type": "string",
"title": "From Name",
"description": "The 'from' name for the Automation (not an email address)."
}
},
"description": "The settings for the Automation workflow."
},
"recipients": {
"type": "object",
"title": "List",
"properties": {
"list_id": {
"type": "string",
"title": "List ID",
"example": "1a2df69xxx",
"description": "The id of the List."
},
"store_id": {
"type": "string",
"title": "Store ID",
"example": "1a2df69xxx",
"description": "The id of the store."
}
},
"description": "List settings for the Automation."
},
"trigger_settings": {
"type": "object",
"title": "Automation Trigger",
"required": [
"workflow_type"
],
"properties": {
"workflow_type": {
"type": "string",
"title": "Workflow Type",
"description": "The type of Automation workflow. Currently only supports 'abandonedCart'."
}
},
"description": "Trigger settings for the Automation."
}
},
"description": "A summary of an individual Automation workflow's settings and content."
}
AutomationsCreateClassicResponse
{
"type": "object",
"title": "Automation Workflow",
"properties": {
"id": {
"type": "string",
"title": "Automation Campaign ID",
"readOnly": true,
"description": "A string that identifies the Automation."
},
"_links": {
"type": "array",
"items": {
"type": "object",
"title": "Resource Link",
"properties": {
"rel": {
"type": "string",
"title": "Rel",
"readOnly": true,
"description": "As with an HTML 'rel' attribute, this describes the type of link."
},
"href": {
"type": "string",
"title": "Href",
"readOnly": true,
"description": "This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action."
},
"method": {
"enum": [
"GET",
"POST",
"PUT",
"PATCH",
"DELETE",
"OPTIONS",
"HEAD"
],
"type": "string",
"title": "Method",
"readOnly": true,
"description": "The HTTP method that should be used when accessing the URL defined in 'href'."
},
"schema": {
"type": "string",
"title": "Schema",
"readOnly": true,
"description": "For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to."
},
"targetSchema": {
"type": "string",
"title": "Target Schema",
"readOnly": true,
"description": "For GETs, this is a URL representing the schema that the response should conform to."
}
},
"description": "This object represents a link from the resource where it is found to another resource or action that may be performed."
},
"title": "Links",
"readOnly": true,
"description": "A list of link types and descriptions for the API schema documents."
},
"status": {
"enum": [
"save",
"paused",
"sending"
],
"type": "string",
"title": "Automation Status",
"readOnly": true,
"description": "The current status of the Automation."
},
"settings": {
"type": "object",
"title": "Automation Campaign Settings",
"properties": {
"title": {
"type": "string",
"title": "Automation Title",
"description": "The title of the Automation."
},
"to_name": {
"type": "string",
"title": "To Name",
"description": "The Automation's custom 'To' name, typically the first name [audience field](https://mailchimp.com/help/getting-started-with-merge-tags/)."
},
"reply_to": {
"type": "string",
"title": "Reply To Address",
"description": "The reply-to email address for the Automation."
},
"from_name": {
"type": "string",
"title": "From Name",
"description": "The 'from' name for the Automation (not an email address)."
},
"inline_css": {
"type": "boolean",
"title": "Inline CSS",
"description": "Whether to automatically inline the CSS included with the Automation content."
},
"auto_footer": {
"type": "boolean",
"title": "Auto-Footer",
"description": "Whether to automatically append Mailchimp's [default footer](https://mailchimp.com/help/about-campaign-footers/) to the Automation."
},
"authenticate": {
"type": "boolean",
"title": "Authentication",
"description": "Whether Mailchimp [authenticated](https://mailchimp.com/help/about-email-authentication/) the Automation. Defaults to `true`."
},
"use_conversation": {
"type": "boolean",
"title": "Conversations",
"description": "Whether to use Mailchimp Conversation feature to manage replies"
}
},
"description": "The settings for the Automation workflow."
},
"tracking": {
"type": "object",
"title": "Automation Tracking Options",
"properties": {
"opens": {
"type": "boolean",
"title": "Opens",
"description": "Whether to [track opens](https://mailchimp.com/help/about-open-tracking/). Defaults to `true`."
},
"capsule": {
"type": "object",
"title": "Capsule CRM Tracking",
"properties": {
"notes": {
"type": "boolean",
"title": "Capsule Note",
"description": "Update contact notes for a campaign based on a subscriber's email addresses."
}
},
"description": "Deprecated"
},
"ecomm360": {
"type": "boolean",
"title": "E-commerce Tracking",
"description": "Whether to enable e-commerce tracking."
},
"clicktale": {
"type": "string",
"title": "ClickTale Analytics Tracking",
"description": "The custom slug for [ClickTale](https://mailchimp.com/help/additional-tracking-options-for-campaigns/) tracking (max of 50 bytes)."
},
"salesforce": {
"type": "object",
"title": "Salesforce CRM Tracking",
"properties": {
"notes": {
"type": "boolean",
"title": "Salesforce Note",
"description": "Update contact notes for a campaign based on a subscriber's email address."
},
"campaign": {
"type": "boolean",
"title": "Salesforce Campaign",
"description": "Create a campaign in a connected Salesforce account."
}
},
"description": "Deprecated"
},
"html_clicks": {
"type": "boolean",
"title": "HTML Click Tracking",
"description": "Whether to [track clicks](https://mailchimp.com/help/enable-and-view-click-tracking/) in the HTML version of the Automation. Defaults to `true`."
},
"text_clicks": {
"type": "boolean",
"title": "Plain-Text Click Tracking",
"description": "Whether to [track clicks](https://mailchimp.com/help/enable-and-view-click-tracking/) in the plain-text version of the Automation. Defaults to `true`."
},
"goal_tracking": {
"type": "boolean",
"title": "Mailchimp Goal Tracking",
"description": "Deprecated"
},
"google_analytics": {
"type": "string",
"title": "Google Analytics Tracking",
"description": "The custom slug for [Google Analytics](https://mailchimp.com/help/integrate-google-analytics-with-mailchimp/) tracking (max of 50 bytes)."
}
},
"description": "The tracking options for the Automation."
},
"recipients": {
"type": "object",
"title": "List",
"properties": {
"list_id": {
"type": "string",
"title": "List ID",
"description": "The unique list id."
},
"store_id": {
"type": "string",
"title": "Store ID",
"example": "1a2df69xxx",
"description": "The id of the store."
},
"list_name": {
"type": "string",
"title": "List Name",
"description": "List Name."
},
"segment_opts": {
"type": "object",
"title": "Segment Options",
"properties": {
"match": {
"enum": [
"any",
"all"
],
"type": "string",
"title": "Match Type",
"description": "Segment match type."
},
"conditions": {
"type": "array",
"items": {
"oneOf": [
{
"type": "object",
"title": "Aim Segment",
"properties": {
"op": {
"enum": [
"open",
"click",
"sent",
"noopen",
"noclick",
"nosent"
],
"type": "string",
"title": "Segment Operator",
"example": "open",
"description": "The status of the member with regard to their campaign interaction. One of the following: opened, clicked, was sent, didn't open, didn't click, or was not sent."
},
"field": {
"enum": [
"aim"
],
"type": "string",
"title": "Segment Field",
"example": "aim",
"description": "Segment by interaction with a specific campaign."
},
"value": {
"type": "string",
"title": "Segment Data",
"example": "any",
"description": "Either the web id value for a specific campaign or 'any' to account for subscribers who have/have not interacted with any campaigns."
},
"condition_type": {
"enum": [
"Aim"
],
"type": "string",
"x-value": "Aim"
}
},
"description": "Segment by interaction with a specific campaign."
},
{
"type": "object",
"title": "Automation Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"started",
"completed",
"not_started",
"not_completed"
],
"type": "string",
"title": "Segment Operator",
"example": "started",
"description": "The status of the member with regard to the automation workflow. One of the following: has started the workflow, has completed the workflow, has not started the workflow, or has not completed the workflow."
},
"field": {
"enum": [
"automation"
],
"type": "string",
"title": "Segment Field",
"example": "automation",
"description": "Segment by interaction with an Automation workflow."
},
"value": {
"type": "string",
"title": "Segment Data",
"example": "2135217",
"description": "The web id for the automation workflow to segment against."
},
"condition_type": {
"enum": [
"Automation"
],
"type": "string",
"x-value": "Automation"
}
},
"description": "Segment by interaction with an Automation workflow."
},
{
"type": "object",
"title": "Poll Activity Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"member",
"notmember"
],
"type": "string",
"title": "Segment Operator",
"example": "member",
"description": "Members have/have not interacted with a specific poll in a Mailchimp email."
},
"field": {
"enum": [
"poll"
],
"type": "string",
"title": "Segment Field",
"example": "poll",
"description": "Segment by poll activity."
},
"value": {
"type": "number",
"title": "Segment Operator",
"example": 409,
"description": "The id for the poll."
},
"condition_type": {
"enum": [
"CampaignPoll"
],
"type": "string",
"x-value": "CampaignPoll"
}
},
"description": "Segment by poll activity."
},
{
"type": "object",
"title": "Conversation Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"member",
"notmember"
],
"type": "string",
"title": "Segment Operator",
"example": "member",
"description": "The status of a member's interaction with a conversation. One of the following: has replied or has not replied."
},
"field": {
"enum": [
"conversation"
],
"type": "string",
"title": "Segment Field",
"example": "conversation",
"description": "Segment by interaction with a campaign via Conversations."
},
"value": {
"type": "string",
"title": "Segment Data",
"example": "any",
"description": "The web id value for a specific campaign or 'any' to account for subscribers who have/have not interacted with any campaigns."
},
"condition_type": {
"enum": [
"Conversation"
],
"type": "string",
"x-value": "Conversation"
}
},
"description": "Segment by interaction with a campaign via Conversations."
},
{
"type": "object",
"title": "Date Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"greater",
"less",
"is",
"not",
"blank",
"blank_not",
"within",
"notwithin"
],
"type": "string",
"title": "Segment Operator",
"example": "greater",
"description": "When the event took place: Before, after, is a specific date, is not a specific date, is blank, or is not blank."
},
"extra": {
"type": "string",
"title": "Segment Extra Value",
"example": "2015-01-30",
"description": "When segmenting on 'date' or 'campaign', the date for the segment formatted as YYYY-MM-DD or the web id for the campaign."
},
"field": {
"enum": [
"timestamp_opt",
"info_changed",
"ecomm_date"
],
"type": "string",
"title": "Segment Field",
"example": "timestamp_opt",
"description": "The type of date field to segment on: The opt-in time for a signup, the date the subscriber was last updated, or the date of their last ecomm purchase."
},
"value": {
"type": "string",
"title": "Segment Data",
"example": "date",
"description": "What type of data to segment on: a specific date, a specific campaign, or the last campaign sent."
},
"condition_type": {
"enum": [
"Date"
],
"type": "string",
"x-value": "Date"
}
},
"description": "Segment by a specific date field."
},
{
"type": "object",
"title": "Email Client Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"client_is",
"client_not"
],
"type": "string",
"title": "Segment Operator",
"example": "client_is",
"description": "The operation to determine whether we select clients that match the value, or clients that do not match the value."
},
"field": {
"enum": [
"email_client"
],
"type": "string",
"title": "Segment Field",
"example": "email_client",
"description": "Segment by use of a particular email client."
},
"value": {
"type": "string",
"title": "Segment Data",
"example": "Gmail",
"description": "The name of the email client."
},
"condition_type": {
"enum": [
"EmailClient"
],
"type": "string",
"x-value": "EmailClient"
}
},
"description": "Segment by use of a particular email client."
},
{
"type": "object",
"title": "Language Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"is",
"not"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Whether the member's language is or is not set to a specific language."
},
"field": {
"enum": [
"language"
],
"type": "string",
"title": "Segment Field",
"example": "language",
"description": "Segmenting based off of a subscriber's language."
},
"value": {
"type": "string",
"title": "Segment Data",
"example": "en",
"description": "A two-letter language identifier."
},
"condition_type": {
"enum": [
"Language"
],
"type": "string",
"x-value": "Language"
}
},
"description": "Segment by language."
},
{
"type": "object",
"title": "Member Rating Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"is",
"not",
"greater",
"less"
],
"type": "string",
"title": "Segment Operator",
"example": "greater",
"description": "Members who have have a rating that is/not exactly a given number or members who have a rating greater/less than a given number."
},
"field": {
"enum": [
"rating"
],
"type": "string",
"title": "Segment Field",
"example": "rating",
"description": "Segment by member rating."
},
"value": {
"type": "number",
"title": "Segment Operator",
"example": 4,
"description": "The star rating number to segment against."
},
"condition_type": {
"enum": [
"MemberRating"
],
"type": "string",
"x-value": "MemberRating"
}
},
"description": "Segment by member rating."
},
{
"type": "object",
"title": "Signup Source Segment",
"required": [
"field",
"condition_type",
"op"
],
"properties": {
"op": {
"enum": [
"source_is",
"source_not"
],
"type": "string",
"title": "Segment Operator",
"example": "source_is",
"description": "Whether the member's signup source was/was not a particular value."
},
"field": {
"enum": [
"source"
],
"type": "string",
"title": "Segment Field",
"example": "source"
},
"value": {
"type": "string",
"title": "Segment Data",
"example": "List Import",
"description": "The signup source."
},
"condition_type": {
"enum": [
"SignupSource"
],
"type": "string",
"title": "Type",
"x-value": "SignupSource"
}
},
"description": "Segment by signup source."
},
{
"type": "object",
"title": "Survey Monkey Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"started",
"completed",
"not_started",
"not_completed"
],
"type": "string",
"title": "Segment Operator",
"example": "started",
"description": "The status of the member with regard to the survey.One of the following: has started the survey, has completed the survey, has not started the survey, or has not completed the survey."
},
"field": {
"enum": [
"survey_monkey"
],
"type": "string",
"title": "Segment Field",
"example": "survey_monkey",
"description": "Segment by interaction with a SurveyMonkey survey."
},
"value": {
"type": "string",
"title": "Survey ID",
"example": "32179586",
"description": "The unique ID of the survey monkey survey."
},
"condition_type": {
"enum": [
"SurveyMonkey"
],
"type": "string",
"x-value": "SurveyMonkey"
}
},
"description": "Segment by interaction with a SurveyMonkey survey."
},
{
"type": "object",
"title": "VIP Segment",
"required": [
"field",
"op"
],
"properties": {
"op": {
"enum": [
"member",
"notmember"
],
"type": "string",
"title": "Segment Operator",
"example": "member",
"description": "Whether the member is or is not marked as VIP."
},
"field": {
"enum": [
"gmonkey"
],
"type": "string",
"title": "Segment Field",
"example": "gmonkey",
"description": "Segment by VIP status."
},
"condition_type": {
"enum": [
"VIP"
],
"type": "string",
"x-value": "VIP"
}
},
"description": "Segment by VIP status."
},
{
"type": "object",
"title": "Interests Segment",
"properties": {
"op": {
"enum": [
"interestcontains",
"interestcontainsall",
"interestnotcontains"
],
"type": "string",
"title": "Segment Operator",
"example": "interestcontains",
"description": "Whether the member is a part of one, all, or none of the groups."
},
"field": {
"type": "string",
"title": "Segment Field",
"example": "interests-123",
"description": "Segmenting based on interest group information. This should start with 'interests-' followed by the grouping id. Ex. 'interests-123'."
},
"value": {
"type": "array",
"items": {
"type": "string",
"example": [
"44401",
"44405",
"44409"
]
},
"title": "Segment Value",
"description": "An array containing strings, each representing a group id."
},
"condition_type": {
"enum": [
"Interests"
],
"type": "string",
"x-value": "Interests"
}
},
"description": "Segment by an interest group merge field."
},
{
"type": "object",
"title": "Ecommerce Category Segment",
"properties": {
"op": {
"enum": [
"is",
"not",
"contains",
"notcontain",
"starts",
"ends"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "A member who has purchased from a category/specific item that is/is not a specific name, where the category/item name contains/doesn't contain a specific phrase or string, or a category/item name that starts/ends with a string."
},
"field": {
"enum": [
"ecomm_cat",
"ecomm_prod"
],
"type": "string",
"title": "Segment Field",
"example": "ecomm_cat",
"description": "Segment by purchases in specific items or categories."
},
"value": {
"type": "string",
"title": "Segment Data",
"example": "Product",
"description": "The ecommerce category/item information."
},
"condition_type": {
"enum": [
"EcommCategory"
],
"type": "string",
"x-value": "EcommCategory"
}
},
"description": "Segment by purchases in specific items or categories."
},
{
"type": "object",
"title": "Ecommerce Number Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"is",
"not",
"greater",
"less"
],
"type": "string",
"title": "Segment Operator",
"example": "greater",
"description": "Members who have spent exactly, have not spent exactly, spent more, or spent less than the segment value."
},
"field": {
"enum": [
"ecomm_spent_avg",
"ecomm_orders",
"ecomm_prod_all",
"ecomm_avg_ord"
],
"type": "string",
"title": "Segment Field",
"example": "ecomm_orders",
"description": "Segment by average spent total, number of orders, total number of products purchased, or average number of products per order."
},
"value": {
"type": "number",
"title": "Segment Operator",
"example": 42,
"description": "Members who have spent exactly, have not spent exactly, spent more, or spent less than this amount."
},
"condition_type": {
"enum": [
"EcommNumber"
],
"type": "string",
"x-value": "EcommNumber"
}
},
"description": "Segment by average spent total, number of orders, total number of products purchased, or average number of products per order."
},
{
"type": "object",
"title": "Ecommerce Purchased Segment",
"properties": {
"op": {
"enum": [
"member",
"notmember"
],
"type": "string",
"title": "Segment Operator",
"example": "member",
"description": "Members who have have ('member') or have not ('notmember') purchased."
},
"field": {
"enum": [
"ecomm_purchased"
],
"type": "string",
"title": "Segment Field",
"example": "ecomm_purchased",
"description": "Segment by whether someone has purchased anything."
},
"condition_type": {
"enum": [
"EcommPurchased"
],
"type": "string",
"x-value": "EcommPurchased"
}
},
"description": "Segment by whether someone has purchased anything."
},
{
"type": "object",
"title": "Ecommerce Spent Segment",
"properties": {
"op": {
"enum": [
"greater",
"less"
],
"type": "string",
"title": "Segment Operator",
"example": "greater",
"description": "Members who have spent 'more' or 'less' than then specified value."
},
"field": {
"enum": [
"ecomm_spent_one",
"ecomm_spent_all"
],
"type": "string",
"title": "Segment Field",
"example": "ecomm_spent_one",
"description": "Segment by amount spent on a single order or across all orders."
},
"value": {
"type": "integer",
"title": "Segment Data",
"example": 42,
"description": "The total amount a member spent."
},
"condition_type": {
"enum": [
"EcommSpent"
],
"type": "string",
"x-value": "EcommSpent"
}
},
"description": "Segment by amount spent on a single order or across all orders."
},
{
"type": "object",
"title": "Ecommerce Purchased Store Segment",
"properties": {
"op": {
"enum": [
"is",
"not"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Members who have or have not purchased from a specific store."
},
"field": {
"enum": [
"ecomm_store"
],
"type": "string",
"title": "Segment Field",
"example": "ecomm_store",
"description": "Segment by purchases from a specific store."
},
"value": {
"type": "string",
"title": "Segment Operator",
"example": "289",
"description": "The store id to segment against."
},
"condition_type": {
"enum": [
"EcommStore"
],
"type": "string",
"x-value": "EcommStore"
}
},
"description": "Segment by purchases from a specific store."
},
{
"type": "object",
"title": "Goal Activity Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"is",
"goal_not",
"contains",
"goal_notcontain",
"starts",
"ends"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Whether the website URL is/not exactly, contains/doesn't contain, starts with/ends with a string."
},
"field": {
"enum": [
"goal"
],
"type": "string",
"title": "Segment Field",
"example": "goal",
"description": "Segment by Goal activity."
},
"value": {
"type": "string",
"title": "Segment Value",
"description": "The URL to check Goal activity against."
},
"condition_type": {
"enum": [
"GoalActivity"
],
"type": "string",
"x-value": "GoalActivity"
}
},
"description": "Segment by Goal activity."
},
{
"type": "object",
"title": "Goal Timestamp Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"greater",
"less",
"is"
],
"type": "string",
"title": "Segment Operator",
"example": "greater",
"description": "Whether the website activity happened after, before, or at a given timestamp."
},
"field": {
"enum": [
"goal_last_visited"
],
"type": "string",
"title": "Segment Field",
"example": "goal_last_visited",
"description": "Segment by most recent interaction with a website."
},
"value": {
"type": "string",
"title": "Segment Value",
"example": "2015-07-20 19:45:21",
"description": "The date to check Goal activity against."
},
"condition_type": {
"enum": [
"GoalTimestamp"
],
"type": "string",
"x-value": "GoalTimestamp"
}
},
"description": "Segment by most recent interaction with a website."
},
{
"type": "object",
"title": "Similar Subscribers Segment Member Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"fuzzy_is",
"fuzzy_not"
],
"type": "string",
"title": "Segment Operator",
"example": "fuzzy_is",
"description": "Members who are/are not apart of a 'similar subscribers' segment."
},
"field": {
"enum": [
"fuzzy_segment"
],
"type": "string",
"title": "Segment Field",
"example": "fuzzy_segment",
"description": "Segment by similar subscribers."
},
"value": {
"type": "number",
"title": "Segment Operator",
"example": 48433,
"description": "The id for the 'similar subscribers' segment."
},
"condition_type": {
"enum": [
"FuzzySegment"
],
"type": "string",
"x-value": "FuzzySegment"
}
},
"description": "Segment by similar subscribers."
},
{
"type": "object",
"title": "Static Segment Member Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"static_is",
"static_not"
],
"type": "string",
"title": "Segment Operator",
"example": "static_is",
"description": "Members who are/are not apart of a static segment."
},
"field": {
"enum": [
"static_segment"
],
"type": "string",
"title": "Segment Field",
"example": "static_segment",
"description": "Segment by a given static segment."
},
"value": {
"type": "number",
"title": "Segment Operator",
"example": 48433,
"description": "The id for the static segment."
},
"condition_type": {
"enum": [
"StaticSegment"
],
"type": "string",
"x-value": "StaticSegment"
}
},
"description": "Segment by a given static segment."
},
{
"type": "object",
"title": "Location-Based Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"ipgeocountry",
"ipgeonotcountry",
"ipgeostate",
"ipgeonotstate"
],
"type": "string",
"title": "Segment Operator",
"example": "ipgeocountry",
"description": "Segment members who are within a specific country or US state."
},
"field": {
"enum": [
"ipgeo"
],
"type": "string",
"title": "Segment Field",
"example": "ipgeo",
"description": "Segmenting subscribers who are within a specific location."
},
"value": {
"type": "string",
"title": "Segment Data",
"example": "US",
"description": "The two-letter country code or US state abbreviation."
},
"condition_type": {
"enum": [
"IPGeoCountryState"
],
"type": "string",
"x-value": "IPGeoCountryState"
}
},
"description": "Segment by a specific country or US state."
},
{
"type": "object",
"title": "Geolocation Segment",
"required": [
"field",
"op",
"value",
"addr",
"lat",
"lng"
],
"properties": {
"op": {
"enum": [
"ipgeoin",
"ipgeonotin"
],
"type": "string",
"title": "Segment Operator",
"example": "ipgeoin",
"description": "Segment members who are within a specific geographic region."
},
"lat": {
"type": "string",
"title": "Segment Location Latitude",
"example": "33.7489954",
"description": "The latitude of the target location."
},
"lng": {
"type": "string",
"title": "Segment Location Longitude",
"example": "-84.3879824",
"description": "The longitude of the target location."
},
"addr": {
"type": "string",
"title": "Segment Location Address",
"example": "Atlanta, GA, USA",
"description": "The address of the target location."
},
"field": {
"enum": [
"ipgeo"
],
"type": "string",
"title": "Segment Field",
"example": "ipgeo",
"description": "Segmenting subscribers who are within a specific location."
},
"value": {
"type": "integer",
"title": "Segment Data",
"example": 42,
"description": "The radius of the target location."
},
"condition_type": {
"enum": [
"IPGeoIn"
],
"type": "string",
"x-value": "IPGeoIn"
}
},
"description": "Segment by a specific geographic region."
},
{
"type": "object",
"title": "US Zip Code Segment",
"required": [
"field",
"op",
"value",
"extra"
],
"properties": {
"op": {
"enum": [
"ipgeoinzip"
],
"type": "string",
"title": "Segment Operator",
"example": "ipgeoinzip",
"description": "Segment members who are within a specific US zip code."
},
"extra": {
"type": "integer",
"title": "Extra Data",
"example": 30318,
"description": "The zip code to segment against."
},
"field": {
"enum": [
"ipgeo"
],
"type": "string",
"title": "Segment Field",
"example": "ipgeo",
"description": "Segmenting subscribers who are within a specific location."
},
"value": {
"type": "integer",
"title": "Segment Data",
"example": 25,
"description": "The radius of the target location."
},
"condition_type": {
"enum": [
"IPGeoInZip"
],
"type": "string",
"x-value": "IPGeoInZip"
}
},
"description": "Segment by a specific US ZIP code."
},
{
"type": "object",
"title": "Unknown Location-Based Segment",
"required": [
"field",
"op"
],
"properties": {
"op": {
"enum": [
"ipgeounknown"
],
"type": "string",
"title": "Segment Operator",
"example": "ipgeounknown",
"description": "Segment members for which location information is unknown."
},
"field": {
"enum": [
"ipgeo"
],
"type": "string",
"title": "Segment Field",
"example": "ipgeo",
"description": "Segmenting subscribers who are within a specific location."
},
"condition_type": {
"enum": [
"IPGeoUnknown"
],
"type": "string",
"x-value": "IPGeoUnknown"
}
},
"description": "Segment members whose location information is unknown."
},
{
"type": "object",
"title": "Zip Code Location-Based Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"ipgeoiszip",
"ipgeonotzip"
],
"type": "string",
"title": "Segment Operator",
"example": "ipgeonotzip",
"description": "Segment members who are/are not within a specific US zip code."
},
"field": {
"enum": [
"ipgeo"
],
"type": "string",
"title": "Segment Field",
"example": "ipgeo",
"description": "Segmenting subscribers who are within a specific location."
},
"value": {
"type": "integer",
"title": "Segment Data",
"example": 30318,
"description": "The 5-digit zip code."
},
"condition_type": {
"enum": [
"IPGeoZip"
],
"type": "string",
"x-value": "IPGeoZip"
}
},
"description": "Segment by a specific US ZIP code."
},
{
"type": "object",
"title": "Social Profiles Age Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"is",
"not"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Members who are/not the exact criteria listed."
},
"field": {
"enum": [
"social_age"
],
"type": "string",
"title": "Segment Field",
"example": "social_age",
"description": "Segment by age ranges in Social Profiles data."
},
"value": {
"enum": [
"18-24",
"25-34",
"35-54",
"55+"
],
"type": "string",
"title": "Segment Operator",
"example": "35-54",
"description": "The age range to segment."
},
"condition_type": {
"enum": [
"SocialAge"
],
"type": "string",
"x-value": "SocialAge"
}
},
"description": "Segment by age ranges in Social Profiles data."
},
{
"type": "object",
"title": "Social Profiles Gender Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"is",
"not"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Members who are/not the exact criteria listed."
},
"field": {
"enum": [
"social_gender"
],
"type": "string",
"title": "Segment Field",
"example": "social_gender",
"description": "Segment by listed gender in Social Profiles data."
},
"value": {
"enum": [
"male",
"female"
],
"type": "string",
"title": "Segment Operator",
"example": "female",
"description": "The Social Profiles gender to segment."
},
"condition_type": {
"enum": [
"SocialGender"
],
"type": "string",
"x-value": "SocialGender"
}
},
"description": "Segment by listed gender in Social Profiles data."
},
{
"type": "object",
"title": "Social Profiles Influence Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"is",
"not",
"greater",
"less"
],
"type": "string",
"title": "Segment Operator",
"example": "greater",
"description": "Members who have a rating that is/not or greater/less than the rating provided."
},
"field": {
"enum": [
"social_influence"
],
"type": "string",
"title": "Segment Field",
"example": "social_influence",
"description": "Segment by influence rating in Social Profiles data."
},
"value": {
"type": "number",
"title": "Segment Operator",
"example": 2,
"description": "The Social Profiles influence rating to segment."
},
"condition_type": {
"enum": [
"SocialInfluence"
],
"type": "string",
"x-value": "SocialInfluence"
}
},
"description": "Segment by influence rating in Social Profiles data."
},
{
"type": "object",
"title": "Social Profiles Social Network Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"member",
"notmember"
],
"type": "string",
"title": "Segment Operator",
"example": "member",
"description": "Members who are/not on a given social network."
},
"field": {
"enum": [
"social_network"
],
"type": "string",
"title": "Segment Field",
"example": "social_network",
"description": "Segment by social network in Social Profiles data."
},
"value": {
"enum": [
"twitter",
"facebook",
"linkedin",
"flickr",
"foursquare",
"lastfm",
"myspace",
"quora",
"vimeo",
"yelp",
"youtube"
],
"type": "string",
"title": "Segment Operator",
"example": "twitter",
"description": "The social network to segment against."
},
"condition_type": {
"enum": [
"SocialNetworkMember"
],
"type": "string",
"x-value": "SocialNetworkMember"
}
},
"description": "Segment by social network in Social Profiles data."
},
{
"type": "object",
"title": "Social Profiles Social Network Follow Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"follow",
"notfollow"
],
"type": "string",
"title": "Segment Operator",
"example": "follow",
"description": "Members who are/not following a linked account on a given social network."
},
"field": {
"enum": [
"social_network"
],
"type": "string",
"title": "Segment Field",
"example": "social_network",
"description": "Segment by social network in Social Profiles data."
},
"value": {
"enum": [
"twitter_follow"
],
"type": "string",
"title": "Segment Operator",
"example": "twitter_follow",
"description": "The social network to segment against."
},
"condition_type": {
"enum": [
"SocialNetworkFollow"
],
"type": "string",
"x-value": "SocialNetworkFollow"
}
},
"description": "Segment by social network in Social Profiles data."
},
{
"type": "object",
"title": "Address Merge Field Segment",
"required": [
"field",
"op"
],
"properties": {
"op": {
"enum": [
"contains",
"notcontain",
"blank",
"blank_not"
],
"type": "string",
"title": "Segment Operator",
"example": "contains",
"description": "Whether the member's address merge field contains/does not contain a value or is/is not blank."
},
"field": {
"type": "string",
"title": "Segment Field",
"example": "MMERGE3",
"description": "An address-type merge field to segment."
},
"value": {
"type": "string",
"title": "Segment Value",
"example": "Atlanta",
"description": "The value to segment a text merge field with."
},
"condition_type": {
"enum": [
"AddressMerge"
],
"type": "string",
"x-value": "AddressMerge"
}
},
"description": "Segment by an address-type merge field."
},
{
"type": "object",
"title": "Address/Zip Merge Field Segment",
"required": [
"field",
"op",
"value",
"extra"
],
"properties": {
"op": {
"enum": [
"geoin"
],
"type": "string",
"title": "Segment Operator",
"example": "geoin",
"description": "Whether the member's address merge field is within a given distance from a city or zip."
},
"extra": {
"type": "string",
"title": "Segment Extra",
"example": "30318",
"description": "The city or the zip being used to segment against."
},
"field": {
"type": "string",
"title": "Segment Field",
"example": "MMERGE2",
"description": "An address or zip-type merge field to segment."
},
"value": {
"type": "string",
"title": "Segment Value",
"example": "25",
"description": "The distance from the city/zip."
},
"condition_type": {
"enum": [
"ZipMerge"
],
"type": "string",
"x-value": "ZipMerge"
}
},
"description": "Segment by an address-type merge field within a given distance."
},
{
"type": "object",
"title": "Birthday Merge Field Segment",
"required": [
"field",
"op"
],
"properties": {
"op": {
"enum": [
"is",
"not",
"blank",
"blank_not"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Whether the member's birthday merge information is/is not a certain date or is/is not blank."
},
"field": {
"type": "string",
"title": "Segment Field",
"example": "MMERGE4",
"description": "A date merge field to segment."
},
"value": {
"type": "string",
"title": "Segment Value",
"example": "01/30",
"description": "A date to segment against (mm/dd)."
},
"condition_type": {
"enum": [
"BirthdayMerge"
],
"type": "string",
"x-value": "BirthdayMerge"
}
},
"description": "Segment by a contact's birthday."
},
{
"type": "object",
"title": "Date Merge Field Segment",
"required": [
"field",
"op"
],
"properties": {
"op": {
"enum": [
"is",
"not",
"less",
"blank",
"blank_not",
"greater"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Whether the member's merge information is/is not, is greater/less than a value or is/is not blank."
},
"field": {
"type": "string",
"title": "Segment Field",
"example": "MMERGE5",
"description": "A date merge field to segment."
},
"value": {
"type": "string",
"title": "Segment Value",
"example": "01/30/2015",
"description": "A date to segment against."
},
"condition_type": {
"enum": [
"DateMerge"
],
"type": "string",
"x-value": "DateMerge"
}
},
"description": "Segment by a given date merge field."
},
{
"type": "object",
"title": "Dropdown/Radio Merge Field Segment",
"required": [
"field",
"op"
],
"properties": {
"op": {
"enum": [
"is",
"not",
"blank",
"blank_not",
"notcontain",
"contains"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Whether the member's merge information is/is not a value or is/is not blank."
},
"field": {
"type": "string",
"title": "Segment Field",
"example": "MMERGE6",
"description": "A merge field to segment."
},
"value": {
"type": "string",
"title": "Segment Value",
"example": "Second Choice",
"description": "The value to segment a text merge field with."
},
"condition_type": {
"enum": [
"SelectMerge"
],
"type": "string",
"x-value": "SelectMerge"
}
},
"description": "An individual segment condition"
},
{
"type": "object",
"title": "Text or Number Merge Field Segment",
"required": [
"field",
"op"
],
"properties": {
"op": {
"enum": [
"is",
"not",
"contains",
"notcontain",
"starts",
"ends",
"greater",
"less",
"blank",
"blank_not"
],
"type": "string",
"title": "Segment Operator",
"example": "contains",
"description": "Whether the member's merge information is/is not, contains/does not contain, starts/ends with, or is greater/less than a value"
},
"field": {
"type": "string",
"title": "Segment Field",
"example": "MMERGE7",
"description": "A text or number merge field to segment."
},
"value": {
"type": "string",
"title": "Segment Value",
"example": "Freddie's Jokes",
"description": "The value to segment a text or number merge field with."
},
"condition_type": {
"enum": [
"TextMerge"
],
"type": "string",
"x-value": "TextMerge"
}
},
"description": "Segment by a given text or number merge field."
},
{
"type": "object",
"title": "Email Segment",
"required": [
"field",
"op"
],
"properties": {
"op": {
"enum": [
"is",
"not",
"contains",
"notcontain",
"starts",
"ends",
"greater",
"less"
],
"type": "string",
"title": "Segment Operator",
"description": "Whether the email address is/not exactly, contains/doesn't contain, starts/ends with a string."
},
"field": {
"enum": [
"merge0",
"EMAIL"
],
"type": "string",
"title": "Segment Field",
"example": "EMAIL",
"description": "Segmenting based off of a subscriber's email address."
},
"value": {
"type": "string",
"title": "Segment Value",
"example": "urist.mcvankab@freddiesjokes.com",
"description": "The value to compare the email against."
},
"condition_type": {
"enum": [
"EmailAddress"
],
"type": "string",
"x-value": "EmailAddress"
}
},
"description": "Segment by email address."
},
{
"type": "object",
"title": "Predicted Gender Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"is",
"not"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Members who are/not the exact criteria listed."
},
"field": {
"enum": [
"predicted_gender"
],
"type": "string",
"title": "Segment Field",
"description": "Segment by predicted gender."
},
"value": {
"enum": [
"male",
"female"
],
"type": "string",
"title": "Segment Operator",
"example": "female",
"description": "The predicted gender to segment."
},
"condition_type": {
"enum": [
"PredictedGender"
],
"type": "string",
"x-value": "PredictedGender"
}
},
"description": "Segment by predicted gender."
},
{
"type": "object",
"title": "Predicted Age Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"is"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Members who are/not the exact criteria listed."
},
"field": {
"enum": [
"predicted_age_range"
],
"type": "string",
"title": "Segment Field",
"description": "Segment by predicted age."
},
"value": {
"enum": [
"18-24",
"25-34",
"35-44",
"45-54",
"55-64",
"65+"
],
"type": "string",
"title": "Segment Operator",
"example": "female",
"description": "The predicted age to segment."
},
"condition_type": {
"enum": [
"PredictedAge"
],
"type": "string",
"x-value": "PredictedAge"
}
},
"description": "Segment by predicted age."
},
{
"type": "object",
"title": "New Subscribers Prebuilt Segment",
"properties": {
"op": {
"enum": [
"date_within"
],
"type": "string",
"title": "Segment Operator",
"description": "Whe the event took place, namely within a time frame."
},
"field": {
"enum": [
"timestamp_opt"
],
"type": "string",
"title": "Segment Field",
"description": "Segment by when people subscribed."
},
"value": {
"type": "string",
"title": "Segment Data",
"description": "What type of data to segment on: a specific date, a specific campaign, or the last campaign sent."
},
"condition_type": {
"enum": [
"NewSubscribers"
],
"type": "string",
"x-value": "NewSubscribers"
}
},
"description": "Segment by when people subscribed."
}
],
"discriminator": {
"type": "string",
"propertyName": "condition_type"
}
},
"title": "Segment Type",
"description": "Segment match conditions. There are multiple possible types, see the [condition types documentation](https://mailchimp.com/developer/marketing/docs/alternative-schemas/#segment-condition-schemas)."
},
"saved_segment_id": {
"type": "integer",
"title": "Saved Segment ID",
"description": "The id for an existing saved segment."
}
},
"description": "An object representing all segmentation options."
},
"list_is_active": {
"type": "boolean",
"title": "List Status",
"readOnly": true,
"description": "The status of the list used, namely if it's deleted or disabled."
}
},
"description": "List settings for the Automation."
},
"start_time": {
"type": "string",
"title": "Start Time",
"format": "date-time",
"readOnly": true,
"description": "The date and time the Automation was started in ISO 8601 format."
},
"create_time": {
"type": "string",
"title": "Create Time",
"format": "date-time",
"readOnly": true,
"description": "The date and time the Automation was created in ISO 8601 format."
},
"emails_sent": {
"type": "integer",
"title": "Emails Sent",
"readOnly": true,
"description": "The total number of emails sent for the Automation."
},
"report_summary": {
"type": "object",
"title": "Campaign Report Summary",
"properties": {
"opens": {
"type": "integer",
"title": "Automation Opens",
"readOnly": true,
"description": "The total number of opens for a campaign."
},
"clicks": {
"type": "integer",
"title": "Total Clicks",
"readOnly": true,
"description": "The total number of clicks for an campaign."
},
"open_rate": {
"type": "number",
"title": "Open Rate",
"readOnly": true,
"description": "The number of unique opens divided by the total number of successful deliveries."
},
"click_rate": {
"type": "number",
"title": "Click Rate",
"readOnly": true,
"description": "The number of unique clicks, divided by the total number of successful deliveries."
},
"unique_opens": {
"type": "integer",
"title": "Unique Opens",
"readOnly": true,
"description": "The number of unique opens."
},
"subscriber_clicks": {
"type": "integer",
"title": "Unique Subscriber Clicks",
"readOnly": true,
"description": "The number of unique clicks."
}
},
"description": "A summary of opens and clicks for sent campaigns."
},
"trigger_settings": {
"type": "object",
"title": "Automation Trigger",
"required": [
"workflow_type"
],
"properties": {
"runtime": {
"type": "object",
"title": "Automation Workflow Runtime Settings",
"properties": {
"days": {
"type": "array",
"items": {
"enum": [
"sunday",
"monday",
"tuesday",
"wednesday",
"thursday",
"friday",
"saturday"
],
"type": "string"
},
"title": "Days",
"description": "The days an Automation workflow can send."
},
"hours": {
"type": "object",
"title": "Hours",
"required": [
"type"
],
"properties": {
"type": {
"enum": [
"send_asap",
"send_between",
"send_at"
],
"type": "string",
"title": "Email Send Time Settings",
"description": "When to send the Automation email."
}
},
"description": "The hours an Automation workflow can send."
}
},
"description": "A workflow's runtime settings for an Automation."
},
"workflow_type": {
"enum": [
"abandonedBrowse",
"abandonedCart",
"api",
"bestCustomers",
"categoryFollowup",
"dateAdded",
"emailFollowup",
"emailSeries",
"groupAdd",
"groupRemove",
"mandrill",
"productFollowup",
"purchaseFollowup",
"recurringEvent",
"specialEvent",
"visitUrl",
"welcomeSeries"
],
"type": "string",
"title": "Workflow Type",
"description": "The type of Automation workflow."
},
"workflow_title": {
"type": "string",
"title": "Workflow Title",
"readOnly": true,
"description": "The title of the workflow type."
},
"workflow_emails_count": {
"type": "integer",
"title": "Workflow Emails Count",
"readOnly": true,
"description": "The number of emails in the Automation workflow."
}
},
"description": "Available triggers for Automation workflows.",
"discriminator": {
"propertyName": "workflow_type"
}
}
},
"description": "A summary of an individual Automation workflow's settings and content."
}
AutomationsCreateClassicdefaultResponse
{
"type": "object",
"title": "Problem Detail Document",
"required": [
"type",
"title",
"status",
"detail",
"instance"
],
"properties": {
"type": {
"type": "string",
"title": "Problem Type",
"example": "https://mailchimp.com/developer/marketing/docs/errors/",
"description": "An absolute URI that identifies the problem type. When dereferenced, it should provide human-readable documentation for the problem type."
},
"title": {
"type": "string",
"title": "Error Title",
"example": "Resource Not Found",
"description": "A short, human-readable summary of the problem type. It shouldn't change based on the occurrence of the problem, except for purposes of localization."
},
"detail": {
"type": "string",
"title": "Error Message",
"example": "The requested resource could not be found.",
"description": "A human-readable explanation specific to this occurrence of the problem. [Learn more about errors](https://mailchimp.com/developer/)."
},
"status": {
"type": "integer",
"title": "HTTP Status Code",
"example": 404,
"description": "The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem."
},
"instance": {
"type": "string",
"title": "Instance ID",
"example": "995c5cb0-3280-4a6e-808b-3b096d0bb219",
"description": "A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support."
}
},
"description": "An error generated by the Mailchimp API. Conforms to IETF draft 'draft-nottingham-http-problem-06'."
}
AutomationsDeleteWorkflowEmailResponse
{
"type": "object",
"title": "Problem Detail Document",
"required": [
"type",
"title",
"status",
"detail",
"instance"
],
"properties": {
"type": {
"type": "string",
"title": "Problem Type",
"example": "https://mailchimp.com/developer/marketing/docs/errors/",
"description": "An absolute URI that identifies the problem type. When dereferenced, it should provide human-readable documentation for the problem type."
},
"title": {
"type": "string",
"title": "Error Title",
"example": "Resource Not Found",
"description": "A short, human-readable summary of the problem type. It shouldn't change based on the occurrence of the problem, except for purposes of localization."
},
"detail": {
"type": "string",
"title": "Error Message",
"example": "The requested resource could not be found.",
"description": "A human-readable explanation specific to this occurrence of the problem. [Learn more about errors](https://mailchimp.com/developer/)."
},
"status": {
"type": "integer",
"title": "HTTP Status Code",
"example": 404,
"description": "The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem."
},
"instance": {
"type": "string",
"title": "Instance ID",
"example": "995c5cb0-3280-4a6e-808b-3b096d0bb219",
"description": "A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support."
}
},
"description": "An error generated by the Mailchimp API. Conforms to IETF draft 'draft-nottingham-http-problem-06'."
}
AutomationsDeleteWorkflowEmaildefaultResponse
{
"type": "object",
"title": "Problem Detail Document",
"required": [
"type",
"title",
"status",
"detail",
"instance"
],
"properties": {
"type": {
"type": "string",
"title": "Problem Type",
"example": "https://mailchimp.com/developer/marketing/docs/errors/",
"description": "An absolute URI that identifies the problem type. When dereferenced, it should provide human-readable documentation for the problem type."
},
"title": {
"type": "string",
"title": "Error Title",
"example": "Resource Not Found",
"description": "A short, human-readable summary of the problem type. It shouldn't change based on the occurrence of the problem, except for purposes of localization."
},
"detail": {
"type": "string",
"title": "Error Message",
"example": "The requested resource could not be found.",
"description": "A human-readable explanation specific to this occurrence of the problem. [Learn more about errors](https://mailchimp.com/developer/)."
},
"status": {
"type": "integer",
"title": "HTTP Status Code",
"example": 404,
"description": "The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem."
},
"instance": {
"type": "string",
"title": "Instance ID",
"example": "995c5cb0-3280-4a6e-808b-3b096d0bb219",
"description": "A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support."
}
},
"description": "An error generated by the Mailchimp API. Conforms to IETF draft 'draft-nottingham-http-problem-06'."
}
AutomationsGetClassicWorkflowEmails200Response
{
"type": "object",
"title": "Automation Emails",
"properties": {
"_links": {
"type": "array",
"items": {
"type": "object",
"title": "Resource Link",
"properties": {
"rel": {
"type": "string",
"title": "Rel",
"readOnly": true,
"description": "As with an HTML 'rel' attribute, this describes the type of link."
},
"href": {
"type": "string",
"title": "Href",
"readOnly": true,
"description": "This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action."
},
"method": {
"enum": [
"GET",
"POST",
"PUT",
"PATCH",
"DELETE",
"OPTIONS",
"HEAD"
],
"type": "string",
"title": "Method",
"readOnly": true,
"description": "The HTTP method that should be used when accessing the URL defined in 'href'."
},
"schema": {
"type": "string",
"title": "Schema",
"readOnly": true,
"description": "For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to."
},
"targetSchema": {
"type": "string",
"title": "Target Schema",
"readOnly": true,
"description": "For GETs, this is a URL representing the schema that the response should conform to."
}
},
"description": "This object represents a link from the resource where it is found to another resource or action that may be performed."
},
"title": "Links",
"readOnly": true,
"description": "A list of link types and descriptions for the API schema documents."
},
"emails": {
"type": "array",
"items": {
"type": "object",
"title": "Automation Workflow Email",
"properties": {
"id": {
"type": "string",
"title": "Automation Email ID",
"readOnly": true,
"description": "A string that uniquely identifies the Automation email."
},
"delay": {
"type": "object",
"title": "Automation Delay",
"properties": {
"type": {
"enum": [
"now",
"day",
"hour",
"week"
],
"type": "string",
"title": "Delay Type",
"description": "The type of delay for an Automation email."
},
"action": {
"enum": [
"previous_campaign_sent",
"previous_campaign_opened",
"previous_campaign_not_opened",
"previous_campaign_clicked_any",
"previous_campaign_not_clicked_any",
"previous_campaign_specific_clicked",
"ecomm_bought_any",
"ecomm_bought_product",
"ecomm_bought_category",
"ecomm_not_bought_any",
"ecomm_abandoned_cart",
"campaign_sent",
"opened_email",
"not_opened_email",
"clicked_email",
"not_clicked_email",
"campaign_specific_clicked",
"manual",
"signup",
"merge_changed",
"group_add",
"group_remove",
"mandrill_sent",
"mandrill_opened",
"mandrill_clicked",
"mandrill_any",
"api",
"goal",
"annual",
"birthday",
"date",
"date_added",
"tag_add"
],
"type": "string",
"title": "Delay Action",
"description": "The action that triggers the delay of an Automation email."
},
"amount": {
"type": "integer",
"title": "Delay Amount",
"readOnly": true,
"description": "The delay amount for an Automation email."
},
"direction": {
"enum": [
"before",
"after"
],
"type": "string",
"title": "Delay Direction",
"description": "Whether the delay settings describe before or after the delay action of an Automation email."
},
"full_description": {
"type": "string",
"title": "Full Delay Description",
"example": "1 day after subscribers purchase anything from your store",
"readOnly": true,
"description": "The user-friendly description of the delay and trigger action settings for an Automation email."
},
"action_description": {
"type": "string",
"title": "Delay Action Description",
"example": "subscribers purchase anything from your store",
"readOnly": true,
"description": "The user-friendly description of the action that triggers an Automation email."
}
},
"description": "The delay settings for an Automation email."
},
"_links": {
"type": "array",
"items": {
"type": "object",
"title": "Resource Link",
"properties": {
"rel": {
"type": "string",
"title": "Rel",
"readOnly": true,
"description": "As with an HTML 'rel' attribute, this describes the type of link."
},
"href": {
"type": "string",
"title": "Href",
"readOnly": true,
"description": "This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action."
},
"method": {
"enum": [
"GET",
"POST",
"PUT",
"PATCH",
"DELETE",
"OPTIONS",
"HEAD"
],
"type": "string",
"title": "Method",
"readOnly": true,
"description": "The HTTP method that should be used when accessing the URL defined in 'href'."
},
"schema": {
"type": "string",
"title": "Schema",
"readOnly": true,
"description": "For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to."
},
"targetSchema": {
"type": "string",
"title": "Target Schema",
"readOnly": true,
"description": "For GETs, this is a URL representing the schema that the response should conform to."
}
},
"description": "This object represents a link from the resource where it is found to another resource or action that may be performed."
},
"title": "Links",
"readOnly": true,
"description": "A list of link types and descriptions for the API schema documents."
},
"status": {
"enum": [
"save",
"paused",
"sending"
],
"type": "string",
"title": "Campaign Status",
"readOnly": true,
"description": "The current status of the campaign."
},
"web_id": {
"type": "integer",
"title": "Automation Web ID",
"example": 33345484,
"readOnly": true,
"description": "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}`."
},
"position": {
"type": "integer",
"title": "Email Position",
"readOnly": true,
"description": "The position of an Automation email in a workflow."
},
"settings": {
"type": "object",
"title": "Campaign Settings",
"properties": {
"title": {
"type": "string",
"title": "Campaign Title",
"description": "The title of the campaign."
},
"reply_to": {
"type": "string",
"title": "Reply To Address",
"description": "The reply-to email address for the campaign."
},
"from_name": {
"type": "string",
"title": "From Name",
"description": "The 'from' name on the campaign (not an email address)."
},
"auto_tweet": {
"type": "boolean",
"title": "Auto-Tweet",
"description": "Automatically tweet a link to the [campaign archive](https://mailchimp.com/help/about-email-campaign-archives-and-pages/) page when the campaign is sent."
},
"inline_css": {
"type": "boolean",
"title": "Inline CSS",
"description": "Automatically inline the CSS included with the campaign content."
},
"auto_footer": {
"type": "boolean",
"title": "Auto-Footer",
"description": "Automatically append Mailchimp's [default footer](https://mailchimp.com/help/about-campaign-footers/) to the campaign."
},
"fb_comments": {
"type": "boolean",
"title": "Facebook Comments",
"description": "Allows Facebook comments on the campaign (also force-enables the Campaign Archive toolbar). Defaults to `true`."
},
"template_id": {
"type": "integer",
"title": "Template ID",
"description": "The id for the template used in this campaign."
},
"authenticate": {
"type": "boolean",
"title": "Authentication",
"description": "Whether Mailchimp [authenticated](https://mailchimp.com/help/about-email-authentication/) the campaign. Defaults to `true`."
},
"auto_fb_post": {
"type": "array",
"items": {
"type": "string"
},
"title": "Auto Post to Facebook",
"description": "An array of [Facebook](https://mailchimp.com/help/connect-or-disconnect-the-facebook-integration/) page ids to auto-post to."
},
"preview_text": {
"type": "string",
"title": "Campaign Preview Text",
"description": "The preview text for the campaign."
},
"subject_line": {
"type": "string",
"title": "Campaign Subject Line",
"description": "The subject line for the campaign."
},
"drag_and_drop": {
"type": "boolean",
"title": "Drag And Drop Campaign",
"readOnly": true,
"description": "Whether the campaign uses the drag-and-drop editor."
}
},
"description": "Settings for the campaign including the email subject, from name, and from email address."
},
"tracking": {
"type": "object",
"title": "Campaign Tracking Options",
"properties": {
"opens": {
"type": "boolean",
"title": "Opens",
"description": "Whether to [track opens](https://mailchimp.com/help/about-open-tracking/). Defaults to `true`."
},
"capsule": {
"type": "object",
"title": "Capsule CRM Tracking",
"properties": {
"notes": {
"type": "boolean",
"title": "Capsule Note",
"description": "Update contact notes for a campaign based on a subscriber's email address."
}
},
"description": "Deprecated"
},
"ecomm360": {
"type": "boolean",
"title": "E-commerce Tracking",
"description": "Whether to enable e-commerce tracking."
},
"clicktale": {
"type": "string",
"title": "ClickTale Analytics Tracking",
"description": "The custom slug for [Click Tale](https://mailchimp.com/help/additional-tracking-options-for-campaigns/) tracking (max of 50 bytes)."
},
"salesforce": {
"type": "object",
"title": "Salesforce CRM Tracking",
"properties": {
"notes": {
"type": "boolean",
"title": "Salesforce Note",
"description": "Update contact notes for a campaign based on a subscriber's email address."
},
"campaign": {
"type": "boolean",
"title": "Salesforce Campaign",
"description": "Create a campaign in a connected Salesforce account."
}
},
"description": "Deprecated"
},
"html_clicks": {
"type": "boolean",
"title": "HTML Click Tracking",
"description": "Whether to [track clicks](https://mailchimp.com/help/enable-and-view-click-tracking/) in the HTML version of the campaign. Defaults to `true`."
},
"text_clicks": {
"type": "boolean",
"title": "Plain-Text Click Tracking",
"description": "Whether to [track clicks](https://mailchimp.com/help/enable-and-view-click-tracking/) in the plain-text version of the campaign. Defaults to `true`."
},
"goal_tracking": {
"type": "boolean",
"title": "Mailchimp Goal Tracking",
"description": "Deprecated"
},
"google_analytics": {
"type": "string",
"title": "Google Analytics Tracking",
"description": "The custom slug for [Google Analytics](https://mailchimp.com/help/integrate-google-analytics-with-mailchimp/) tracking (max of 50 bytes)."
}
},
"description": "The tracking options for a campaign."
},
"send_time": {
"type": "string",
"title": "Send Time",
"format": "date-time",
"readOnly": true,
"description": " The date and time a campaign was sent in ISO 8601 format"
},
"recipients": {
"type": "object",
"title": "List",
"properties": {
"list_id": {
"type": "string",
"title": "List ID",
"description": "The unique list id."
},
"list_name": {
"type": "string",
"title": "List Name",
"readOnly": true,
"description": "The name of the list."
},
"segment_opts": {
"type": "object",
"title": "Segment Options",
"properties": {
"match": {
"enum": [
"any",
"all"
],
"type": "string",
"title": "Match Type",
"description": "Segment match type."
},
"conditions": {
"type": "array",
"items": {
"oneOf": [
{
"type": "object",
"title": "Aim Segment",
"properties": {
"op": {
"enum": [
"open",
"click",
"sent",
"noopen",
"noclick",
"nosent"
],
"type": "string",
"title": "Segment Operator",
"example": "open",
"description": "The status of the member with regard to their campaign interaction. One of the following: opened, clicked, was sent, didn't open, didn't click, or was not sent."
},
"field": {
"enum": [
"aim"
],
"type": "string",
"title": "Segment Field",
"example": "aim",
"description": "Segment by interaction with a specific campaign."
},
"value": {
"type": "string",
"title": "Segment Data",
"example": "any",
"description": "Either the web id value for a specific campaign or 'any' to account for subscribers who have/have not interacted with any campaigns."
},
"condition_type": {
"enum": [
"Aim"
],
"type": "string",
"x-value": "Aim"
}
},
"description": "Segment by interaction with a specific campaign."
},
{
"type": "object",
"title": "Automation Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"started",
"completed",
"not_started",
"not_completed"
],
"type": "string",
"title": "Segment Operator",
"example": "started",
"description": "The status of the member with regard to the automation workflow. One of the following: has started the workflow, has completed the workflow, has not started the workflow, or has not completed the workflow."
},
"field": {
"enum": [
"automation"
],
"type": "string",
"title": "Segment Field",
"example": "automation",
"description": "Segment by interaction with an Automation workflow."
},
"value": {
"type": "string",
"title": "Segment Data",
"example": "2135217",
"description": "The web id for the automation workflow to segment against."
},
"condition_type": {
"enum": [
"Automation"
],
"type": "string",
"x-value": "Automation"
}
},
"description": "Segment by interaction with an Automation workflow."
},
{
"type": "object",
"title": "Poll Activity Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"member",
"notmember"
],
"type": "string",
"title": "Segment Operator",
"example": "member",
"description": "Members have/have not interacted with a specific poll in a Mailchimp email."
},
"field": {
"enum": [
"poll"
],
"type": "string",
"title": "Segment Field",
"example": "poll",
"description": "Segment by poll activity."
},
"value": {
"type": "number",
"title": "Segment Operator",
"example": 409,
"description": "The id for the poll."
},
"condition_type": {
"enum": [
"CampaignPoll"
],
"type": "string",
"x-value": "CampaignPoll"
}
},
"description": "Segment by poll activity."
},
{
"type": "object",
"title": "Conversation Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"member",
"notmember"
],
"type": "string",
"title": "Segment Operator",
"example": "member",
"description": "The status of a member's interaction with a conversation. One of the following: has replied or has not replied."
},
"field": {
"enum": [
"conversation"
],
"type": "string",
"title": "Segment Field",
"example": "conversation",
"description": "Segment by interaction with a campaign via Conversations."
},
"value": {
"type": "string",
"title": "Segment Data",
"example": "any",
"description": "The web id value for a specific campaign or 'any' to account for subscribers who have/have not interacted with any campaigns."
},
"condition_type": {
"enum": [
"Conversation"
],
"type": "string",
"x-value": "Conversation"
}
},
"description": "Segment by interaction with a campaign via Conversations."
},
{
"type": "object",
"title": "Date Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"greater",
"less",
"is",
"not",
"blank",
"blank_not",
"within",
"notwithin"
],
"type": "string",
"title": "Segment Operator",
"example": "greater",
"description": "When the event took place: Before, after, is a specific date, is not a specific date, is blank, or is not blank."
},
"extra": {
"type": "string",
"title": "Segment Extra Value",
"example": "2015-01-30",
"description": "When segmenting on 'date' or 'campaign', the date for the segment formatted as YYYY-MM-DD or the web id for the campaign."
},
"field": {
"enum": [
"timestamp_opt",
"info_changed",
"ecomm_date"
],
"type": "string",
"title": "Segment Field",
"example": "timestamp_opt",
"description": "The type of date field to segment on: The opt-in time for a signup, the date the subscriber was last updated, or the date of their last ecomm purchase."
},
"value": {
"type": "string",
"title": "Segment Data",
"example": "date",
"description": "What type of data to segment on: a specific date, a specific campaign, or the last campaign sent."
},
"condition_type": {
"enum": [
"Date"
],
"type": "string",
"x-value": "Date"
}
},
"description": "Segment by a specific date field."
},
{
"type": "object",
"title": "Email Client Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"client_is",
"client_not"
],
"type": "string",
"title": "Segment Operator",
"example": "client_is",
"description": "The operation to determine whether we select clients that match the value, or clients that do not match the value."
},
"field": {
"enum": [
"email_client"
],
"type": "string",
"title": "Segment Field",
"example": "email_client",
"description": "Segment by use of a particular email client."
},
"value": {
"type": "string",
"title": "Segment Data",
"example": "Gmail",
"description": "The name of the email client."
},
"condition_type": {
"enum": [
"EmailClient"
],
"type": "string",
"x-value": "EmailClient"
}
},
"description": "Segment by use of a particular email client."
},
{
"type": "object",
"title": "Language Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"is",
"not"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Whether the member's language is or is not set to a specific language."
},
"field": {
"enum": [
"language"
],
"type": "string",
"title": "Segment Field",
"example": "language",
"description": "Segmenting based off of a subscriber's language."
},
"value": {
"type": "string",
"title": "Segment Data",
"example": "en",
"description": "A two-letter language identifier."
},
"condition_type": {
"enum": [
"Language"
],
"type": "string",
"x-value": "Language"
}
},
"description": "Segment by language."
},
{
"type": "object",
"title": "Member Rating Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"is",
"not",
"greater",
"less"
],
"type": "string",
"title": "Segment Operator",
"example": "greater",
"description": "Members who have have a rating that is/not exactly a given number or members who have a rating greater/less than a given number."
},
"field": {
"enum": [
"rating"
],
"type": "string",
"title": "Segment Field",
"example": "rating",
"description": "Segment by member rating."
},
"value": {
"type": "number",
"title": "Segment Operator",
"example": 4,
"description": "The star rating number to segment against."
},
"condition_type": {
"enum": [
"MemberRating"
],
"type": "string",
"x-value": "MemberRating"
}
},
"description": "Segment by member rating."
},
{
"type": "object",
"title": "Signup Source Segment",
"required": [
"field",
"condition_type",
"op"
],
"properties": {
"op": {
"enum": [
"source_is",
"source_not"
],
"type": "string",
"title": "Segment Operator",
"example": "source_is",
"description": "Whether the member's signup source was/was not a particular value."
},
"field": {
"enum": [
"source"
],
"type": "string",
"title": "Segment Field",
"example": "source"
},
"value": {
"type": "string",
"title": "Segment Data",
"example": "List Import",
"description": "The signup source."
},
"condition_type": {
"enum": [
"SignupSource"
],
"type": "string",
"title": "Type",
"x-value": "SignupSource"
}
},
"description": "Segment by signup source."
},
{
"type": "object",
"title": "Survey Monkey Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"started",
"completed",
"not_started",
"not_completed"
],
"type": "string",
"title": "Segment Operator",
"example": "started",
"description": "The status of the member with regard to the survey.One of the following: has started the survey, has completed the survey, has not started the survey, or has not completed the survey."
},
"field": {
"enum": [
"survey_monkey"
],
"type": "string",
"title": "Segment Field",
"example": "survey_monkey",
"description": "Segment by interaction with a SurveyMonkey survey."
},
"value": {
"type": "string",
"title": "Survey ID",
"example": "32179586",
"description": "The unique ID of the survey monkey survey."
},
"condition_type": {
"enum": [
"SurveyMonkey"
],
"type": "string",
"x-value": "SurveyMonkey"
}
},
"description": "Segment by interaction with a SurveyMonkey survey."
},
{
"type": "object",
"title": "VIP Segment",
"required": [
"field",
"op"
],
"properties": {
"op": {
"enum": [
"member",
"notmember"
],
"type": "string",
"title": "Segment Operator",
"example": "member",
"description": "Whether the member is or is not marked as VIP."
},
"field": {
"enum": [
"gmonkey"
],
"type": "string",
"title": "Segment Field",
"example": "gmonkey",
"description": "Segment by VIP status."
},
"condition_type": {
"enum": [
"VIP"
],
"type": "string",
"x-value": "VIP"
}
},
"description": "Segment by VIP status."
},
{
"type": "object",
"title": "Interests Segment",
"properties": {
"op": {
"enum": [
"interestcontains",
"interestcontainsall",
"interestnotcontains"
],
"type": "string",
"title": "Segment Operator",
"example": "interestcontains",
"description": "Whether the member is a part of one, all, or none of the groups."
},
"field": {
"type": "string",
"title": "Segment Field",
"example": "interests-123",
"description": "Segmenting based on interest group information. This should start with 'interests-' followed by the grouping id. Ex. 'interests-123'."
},
"value": {
"type": "array",
"items": {
"type": "string",
"example": [
"44401",
"44405",
"44409"
]
},
"title": "Segment Value",
"description": "An array containing strings, each representing a group id."
},
"condition_type": {
"enum": [
"Interests"
],
"type": "string",
"x-value": "Interests"
}
},
"description": "Segment by an interest group merge field."
},
{
"type": "object",
"title": "Ecommerce Category Segment",
"properties": {
"op": {
"enum": [
"is",
"not",
"contains",
"notcontain",
"starts",
"ends"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "A member who has purchased from a category/specific item that is/is not a specific name, where the category/item name contains/doesn't contain a specific phrase or string, or a category/item name that starts/ends with a string."
},
"field": {
"enum": [
"ecomm_cat",
"ecomm_prod"
],
"type": "string",
"title": "Segment Field",
"example": "ecomm_cat",
"description": "Segment by purchases in specific items or categories."
},
"value": {
"type": "string",
"title": "Segment Data",
"example": "Product",
"description": "The ecommerce category/item information."
},
"condition_type": {
"enum": [
"EcommCategory"
],
"type": "string",
"x-value": "EcommCategory"
}
},
"description": "Segment by purchases in specific items or categories."
},
{
"type": "object",
"title": "Ecommerce Number Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"is",
"not",
"greater",
"less"
],
"type": "string",
"title": "Segment Operator",
"example": "greater",
"description": "Members who have spent exactly, have not spent exactly, spent more, or spent less than the segment value."
},
"field": {
"enum": [
"ecomm_spent_avg",
"ecomm_orders",
"ecomm_prod_all",
"ecomm_avg_ord"
],
"type": "string",
"title": "Segment Field",
"example": "ecomm_orders",
"description": "Segment by average spent total, number of orders, total number of products purchased, or average number of products per order."
},
"value": {
"type": "number",
"title": "Segment Operator",
"example": 42,
"description": "Members who have spent exactly, have not spent exactly, spent more, or spent less than this amount."
},
"condition_type": {
"enum": [
"EcommNumber"
],
"type": "string",
"x-value": "EcommNumber"
}
},
"description": "Segment by average spent total, number of orders, total number of products purchased, or average number of products per order."
},
{
"type": "object",
"title": "Ecommerce Purchased Segment",
"properties": {
"op": {
"enum": [
"member",
"notmember"
],
"type": "string",
"title": "Segment Operator",
"example": "member",
"description": "Members who have have ('member') or have not ('notmember') purchased."
},
"field": {
"enum": [
"ecomm_purchased"
],
"type": "string",
"title": "Segment Field",
"example": "ecomm_purchased",
"description": "Segment by whether someone has purchased anything."
},
"condition_type": {
"enum": [
"EcommPurchased"
],
"type": "string",
"x-value": "EcommPurchased"
}
},
"description": "Segment by whether someone has purchased anything."
},
{
"type": "object",
"title": "Ecommerce Spent Segment",
"properties": {
"op": {
"enum": [
"greater",
"less"
],
"type": "string",
"title": "Segment Operator",
"example": "greater",
"description": "Members who have spent 'more' or 'less' than then specified value."
},
"field": {
"enum": [
"ecomm_spent_one",
"ecomm_spent_all"
],
"type": "string",
"title": "Segment Field",
"example": "ecomm_spent_one",
"description": "Segment by amount spent on a single order or across all orders."
},
"value": {
"type": "integer",
"title": "Segment Data",
"example": 42,
"description": "The total amount a member spent."
},
"condition_type": {
"enum": [
"EcommSpent"
],
"type": "string",
"x-value": "EcommSpent"
}
},
"description": "Segment by amount spent on a single order or across all orders."
},
{
"type": "object",
"title": "Ecommerce Purchased Store Segment",
"properties": {
"op": {
"enum": [
"is",
"not"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Members who have or have not purchased from a specific store."
},
"field": {
"enum": [
"ecomm_store"
],
"type": "string",
"title": "Segment Field",
"example": "ecomm_store",
"description": "Segment by purchases from a specific store."
},
"value": {
"type": "string",
"title": "Segment Operator",
"example": "289",
"description": "The store id to segment against."
},
"condition_type": {
"enum": [
"EcommStore"
],
"type": "string",
"x-value": "EcommStore"
}
},
"description": "Segment by purchases from a specific store."
},
{
"type": "object",
"title": "Goal Activity Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"is",
"goal_not",
"contains",
"goal_notcontain",
"starts",
"ends"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Whether the website URL is/not exactly, contains/doesn't contain, starts with/ends with a string."
},
"field": {
"enum": [
"goal"
],
"type": "string",
"title": "Segment Field",
"example": "goal",
"description": "Segment by Goal activity."
},
"value": {
"type": "string",
"title": "Segment Value",
"description": "The URL to check Goal activity against."
},
"condition_type": {
"enum": [
"GoalActivity"
],
"type": "string",
"x-value": "GoalActivity"
}
},
"description": "Segment by Goal activity."
},
{
"type": "object",
"title": "Goal Timestamp Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"greater",
"less",
"is"
],
"type": "string",
"title": "Segment Operator",
"example": "greater",
"description": "Whether the website activity happened after, before, or at a given timestamp."
},
"field": {
"enum": [
"goal_last_visited"
],
"type": "string",
"title": "Segment Field",
"example": "goal_last_visited",
"description": "Segment by most recent interaction with a website."
},
"value": {
"type": "string",
"title": "Segment Value",
"example": "2015-07-20 19:45:21",
"description": "The date to check Goal activity against."
},
"condition_type": {
"enum": [
"GoalTimestamp"
],
"type": "string",
"x-value": "GoalTimestamp"
}
},
"description": "Segment by most recent interaction with a website."
},
{
"type": "object",
"title": "Similar Subscribers Segment Member Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"fuzzy_is",
"fuzzy_not"
],
"type": "string",
"title": "Segment Operator",
"example": "fuzzy_is",
"description": "Members who are/are not apart of a 'similar subscribers' segment."
},
"field": {
"enum": [
"fuzzy_segment"
],
"type": "string",
"title": "Segment Field",
"example": "fuzzy_segment",
"description": "Segment by similar subscribers."
},
"value": {
"type": "number",
"title": "Segment Operator",
"example": 48433,
"description": "The id for the 'similar subscribers' segment."
},
"condition_type": {
"enum": [
"FuzzySegment"
],
"type": "string",
"x-value": "FuzzySegment"
}
},
"description": "Segment by similar subscribers."
},
{
"type": "object",
"title": "Static Segment Member Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"static_is",
"static_not"
],
"type": "string",
"title": "Segment Operator",
"example": "static_is",
"description": "Members who are/are not apart of a static segment."
},
"field": {
"enum": [
"static_segment"
],
"type": "string",
"title": "Segment Field",
"example": "static_segment",
"description": "Segment by a given static segment."
},
"value": {
"type": "number",
"title": "Segment Operator",
"example": 48433,
"description": "The id for the static segment."
},
"condition_type": {
"enum": [
"StaticSegment"
],
"type": "string",
"x-value": "StaticSegment"
}
},
"description": "Segment by a given static segment."
},
{
"type": "object",
"title": "Location-Based Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"ipgeocountry",
"ipgeonotcountry",
"ipgeostate",
"ipgeonotstate"
],
"type": "string",
"title": "Segment Operator",
"example": "ipgeocountry",
"description": "Segment members who are within a specific country or US state."
},
"field": {
"enum": [
"ipgeo"
],
"type": "string",
"title": "Segment Field",
"example": "ipgeo",
"description": "Segmenting subscribers who are within a specific location."
},
"value": {
"type": "string",
"title": "Segment Data",
"example": "US",
"description": "The two-letter country code or US state abbreviation."
},
"condition_type": {
"enum": [
"IPGeoCountryState"
],
"type": "string",
"x-value": "IPGeoCountryState"
}
},
"description": "Segment by a specific country or US state."
},
{
"type": "object",
"title": "Geolocation Segment",
"required": [
"field",
"op",
"value",
"addr",
"lat",
"lng"
],
"properties": {
"op": {
"enum": [
"ipgeoin",
"ipgeonotin"
],
"type": "string",
"title": "Segment Operator",
"example": "ipgeoin",
"description": "Segment members who are within a specific geographic region."
},
"lat": {
"type": "string",
"title": "Segment Location Latitude",
"example": "33.7489954",
"description": "The latitude of the target location."
},
"lng": {
"type": "string",
"title": "Segment Location Longitude",
"example": "-84.3879824",
"description": "The longitude of the target location."
},
"addr": {
"type": "string",
"title": "Segment Location Address",
"example": "Atlanta, GA, USA",
"description": "The address of the target location."
},
"field": {
"enum": [
"ipgeo"
],
"type": "string",
"title": "Segment Field",
"example": "ipgeo",
"description": "Segmenting subscribers who are within a specific location."
},
"value": {
"type": "integer",
"title": "Segment Data",
"example": 42,
"description": "The radius of the target location."
},
"condition_type": {
"enum": [
"IPGeoIn"
],
"type": "string",
"x-value": "IPGeoIn"
}
},
"description": "Segment by a specific geographic region."
},
{
"type": "object",
"title": "US Zip Code Segment",
"required": [
"field",
"op",
"value",
"extra"
],
"properties": {
"op": {
"enum": [
"ipgeoinzip"
],
"type": "string",
"title": "Segment Operator",
"example": "ipgeoinzip",
"description": "Segment members who are within a specific US zip code."
},
"extra": {
"type": "integer",
"title": "Extra Data",
"example": 30318,
"description": "The zip code to segment against."
},
"field": {
"enum": [
"ipgeo"
],
"type": "string",
"title": "Segment Field",
"example": "ipgeo",
"description": "Segmenting subscribers who are within a specific location."
},
"value": {
"type": "integer",
"title": "Segment Data",
"example": 25,
"description": "The radius of the target location."
},
"condition_type": {
"enum": [
"IPGeoInZip"
],
"type": "string",
"x-value": "IPGeoInZip"
}
},
"description": "Segment by a specific US ZIP code."
},
{
"type": "object",
"title": "Unknown Location-Based Segment",
"required": [
"field",
"op"
],
"properties": {
"op": {
"enum": [
"ipgeounknown"
],
"type": "string",
"title": "Segment Operator",
"example": "ipgeounknown",
"description": "Segment members for which location information is unknown."
},
"field": {
"enum": [
"ipgeo"
],
"type": "string",
"title": "Segment Field",
"example": "ipgeo",
"description": "Segmenting subscribers who are within a specific location."
},
"condition_type": {
"enum": [
"IPGeoUnknown"
],
"type": "string",
"x-value": "IPGeoUnknown"
}
},
"description": "Segment members whose location information is unknown."
},
{
"type": "object",
"title": "Zip Code Location-Based Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"ipgeoiszip",
"ipgeonotzip"
],
"type": "string",
"title": "Segment Operator",
"example": "ipgeonotzip",
"description": "Segment members who are/are not within a specific US zip code."
},
"field": {
"enum": [
"ipgeo"
],
"type": "string",
"title": "Segment Field",
"example": "ipgeo",
"description": "Segmenting subscribers who are within a specific location."
},
"value": {
"type": "integer",
"title": "Segment Data",
"example": 30318,
"description": "The 5-digit zip code."
},
"condition_type": {
"enum": [
"IPGeoZip"
],
"type": "string",
"x-value": "IPGeoZip"
}
},
"description": "Segment by a specific US ZIP code."
},
{
"type": "object",
"title": "Social Profiles Age Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"is",
"not"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Members who are/not the exact criteria listed."
},
"field": {
"enum": [
"social_age"
],
"type": "string",
"title": "Segment Field",
"example": "social_age",
"description": "Segment by age ranges in Social Profiles data."
},
"value": {
"enum": [
"18-24",
"25-34",
"35-54",
"55+"
],
"type": "string",
"title": "Segment Operator",
"example": "35-54",
"description": "The age range to segment."
},
"condition_type": {
"enum": [
"SocialAge"
],
"type": "string",
"x-value": "SocialAge"
}
},
"description": "Segment by age ranges in Social Profiles data."
},
{
"type": "object",
"title": "Social Profiles Gender Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"is",
"not"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Members who are/not the exact criteria listed."
},
"field": {
"enum": [
"social_gender"
],
"type": "string",
"title": "Segment Field",
"example": "social_gender",
"description": "Segment by listed gender in Social Profiles data."
},
"value": {
"enum": [
"male",
"female"
],
"type": "string",
"title": "Segment Operator",
"example": "female",
"description": "The Social Profiles gender to segment."
},
"condition_type": {
"enum": [
"SocialGender"
],
"type": "string",
"x-value": "SocialGender"
}
},
"description": "Segment by listed gender in Social Profiles data."
},
{
"type": "object",
"title": "Social Profiles Influence Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"is",
"not",
"greater",
"less"
],
"type": "string",
"title": "Segment Operator",
"example": "greater",
"description": "Members who have a rating that is/not or greater/less than the rating provided."
},
"field": {
"enum": [
"social_influence"
],
"type": "string",
"title": "Segment Field",
"example": "social_influence",
"description": "Segment by influence rating in Social Profiles data."
},
"value": {
"type": "number",
"title": "Segment Operator",
"example": 2,
"description": "The Social Profiles influence rating to segment."
},
"condition_type": {
"enum": [
"SocialInfluence"
],
"type": "string",
"x-value": "SocialInfluence"
}
},
"description": "Segment by influence rating in Social Profiles data."
},
{
"type": "object",
"title": "Social Profiles Social Network Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"member",
"notmember"
],
"type": "string",
"title": "Segment Operator",
"example": "member",
"description": "Members who are/not on a given social network."
},
"field": {
"enum": [
"social_network"
],
"type": "string",
"title": "Segment Field",
"example": "social_network",
"description": "Segment by social network in Social Profiles data."
},
"value": {
"enum": [
"twitter",
"facebook",
"linkedin",
"flickr",
"foursquare",
"lastfm",
"myspace",
"quora",
"vimeo",
"yelp",
"youtube"
],
"type": "string",
"title": "Segment Operator",
"example": "twitter",
"description": "The social network to segment against."
},
"condition_type": {
"enum": [
"SocialNetworkMember"
],
"type": "string",
"x-value": "SocialNetworkMember"
}
},
"description": "Segment by social network in Social Profiles data."
},
{
"type": "object",
"title": "Social Profiles Social Network Follow Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"follow",
"notfollow"
],
"type": "string",
"title": "Segment Operator",
"example": "follow",
"description": "Members who are/not following a linked account on a given social network."
},
"field": {
"enum": [
"social_network"
],
"type": "string",
"title": "Segment Field",
"example": "social_network",
"description": "Segment by social network in Social Profiles data."
},
"value": {
"enum": [
"twitter_follow"
],
"type": "string",
"title": "Segment Operator",
"example": "twitter_follow",
"description": "The social network to segment against."
},
"condition_type": {
"enum": [
"SocialNetworkFollow"
],
"type": "string",
"x-value": "SocialNetworkFollow"
}
},
"description": "Segment by social network in Social Profiles data."
},
{
"type": "object",
"title": "Address Merge Field Segment",
"required": [
"field",
"op"
],
"properties": {
"op": {
"enum": [
"contains",
"notcontain",
"blank",
"blank_not"
],
"type": "string",
"title": "Segment Operator",
"example": "contains",
"description": "Whether the member's address merge field contains/does not contain a value or is/is not blank."
},
"field": {
"type": "string",
"title": "Segment Field",
"example": "MMERGE3",
"description": "An address-type merge field to segment."
},
"value": {
"type": "string",
"title": "Segment Value",
"example": "Atlanta",
"description": "The value to segment a text merge field with."
},
"condition_type": {
"enum": [
"AddressMerge"
],
"type": "string",
"x-value": "AddressMerge"
}
},
"description": "Segment by an address-type merge field."
},
{
"type": "object",
"title": "Address/Zip Merge Field Segment",
"required": [
"field",
"op",
"value",
"extra"
],
"properties": {
"op": {
"enum": [
"geoin"
],
"type": "string",
"title": "Segment Operator",
"example": "geoin",
"description": "Whether the member's address merge field is within a given distance from a city or zip."
},
"extra": {
"type": "string",
"title": "Segment Extra",
"example": "30318",
"description": "The city or the zip being used to segment against."
},
"field": {
"type": "string",
"title": "Segment Field",
"example": "MMERGE2",
"description": "An address or zip-type merge field to segment."
},
"value": {
"type": "string",
"title": "Segment Value",
"example": "25",
"description": "The distance from the city/zip."
},
"condition_type": {
"enum": [
"ZipMerge"
],
"type": "string",
"x-value": "ZipMerge"
}
},
"description": "Segment by an address-type merge field within a given distance."
},
{
"type": "object",
"title": "Birthday Merge Field Segment",
"required": [
"field",
"op"
],
"properties": {
"op": {
"enum": [
"is",
"not",
"blank",
"blank_not"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Whether the member's birthday merge information is/is not a certain date or is/is not blank."
},
"field": {
"type": "string",
"title": "Segment Field",
"example": "MMERGE4",
"description": "A date merge field to segment."
},
"value": {
"type": "string",
"title": "Segment Value",
"example": "01/30",
"description": "A date to segment against (mm/dd)."
},
"condition_type": {
"enum": [
"BirthdayMerge"
],
"type": "string",
"x-value": "BirthdayMerge"
}
},
"description": "Segment by a contact's birthday."
},
{
"type": "object",
"title": "Date Merge Field Segment",
"required": [
"field",
"op"
],
"properties": {
"op": {
"enum": [
"is",
"not",
"less",
"blank",
"blank_not",
"greater"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Whether the member's merge information is/is not, is greater/less than a value or is/is not blank."
},
"field": {
"type": "string",
"title": "Segment Field",
"example": "MMERGE5",
"description": "A date merge field to segment."
},
"value": {
"type": "string",
"title": "Segment Value",
"example": "01/30/2015",
"description": "A date to segment against."
},
"condition_type": {
"enum": [
"DateMerge"
],
"type": "string",
"x-value": "DateMerge"
}
},
"description": "Segment by a given date merge field."
},
{
"type": "object",
"title": "Dropdown/Radio Merge Field Segment",
"required": [
"field",
"op"
],
"properties": {
"op": {
"enum": [
"is",
"not",
"blank",
"blank_not",
"notcontain",
"contains"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Whether the member's merge information is/is not a value or is/is not blank."
},
"field": {
"type": "string",
"title": "Segment Field",
"example": "MMERGE6",
"description": "A merge field to segment."
},
"value": {
"type": "string",
"title": "Segment Value",
"example": "Second Choice",
"description": "The value to segment a text merge field with."
},
"condition_type": {
"enum": [
"SelectMerge"
],
"type": "string",
"x-value": "SelectMerge"
}
},
"description": "An individual segment condition"
},
{
"type": "object",
"title": "Text or Number Merge Field Segment",
"required": [
"field",
"op"
],
"properties": {
"op": {
"enum": [
"is",
"not",
"contains",
"notcontain",
"starts",
"ends",
"greater",
"less",
"blank",
"blank_not"
],
"type": "string",
"title": "Segment Operator",
"example": "contains",
"description": "Whether the member's merge information is/is not, contains/does not contain, starts/ends with, or is greater/less than a value"
},
"field": {
"type": "string",
"title": "Segment Field",
"example": "MMERGE7",
"description": "A text or number merge field to segment."
},
"value": {
"type": "string",
"title": "Segment Value",
"example": "Freddie's Jokes",
"description": "The value to segment a text or number merge field with."
},
"condition_type": {
"enum": [
"TextMerge"
],
"type": "string",
"x-value": "TextMerge"
}
},
"description": "Segment by a given text or number merge field."
},
{
"type": "object",
"title": "Email Segment",
"required": [
"field",
"op"
],
"properties": {
"op": {
"enum": [
"is",
"not",
"contains",
"notcontain",
"starts",
"ends",
"greater",
"less"
],
"type": "string",
"title": "Segment Operator",
"description": "Whether the email address is/not exactly, contains/doesn't contain, starts/ends with a string."
},
"field": {
"enum": [
"merge0",
"EMAIL"
],
"type": "string",
"title": "Segment Field",
"example": "EMAIL",
"description": "Segmenting based off of a subscriber's email address."
},
"value": {
"type": "string",
"title": "Segment Value",
"example": "urist.mcvankab@freddiesjokes.com",
"description": "The value to compare the email against."
},
"condition_type": {
"enum": [
"EmailAddress"
],
"type": "string",
"x-value": "EmailAddress"
}
},
"description": "Segment by email address."
},
{
"type": "object",
"title": "Predicted Gender Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"is",
"not"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Members who are/not the exact criteria listed."
},
"field": {
"enum": [
"predicted_gender"
],
"type": "string",
"title": "Segment Field",
"description": "Segment by predicted gender."
},
"value": {
"enum": [
"male",
"female"
],
"type": "string",
"title": "Segment Operator",
"example": "female",
"description": "The predicted gender to segment."
},
"condition_type": {
"enum": [
"PredictedGender"
],
"type": "string",
"x-value": "PredictedGender"
}
},
"description": "Segment by predicted gender."
},
{
"type": "object",
"title": "Predicted Age Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"is"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Members who are/not the exact criteria listed."
},
"field": {
"enum": [
"predicted_age_range"
],
"type": "string",
"title": "Segment Field",
"description": "Segment by predicted age."
},
"value": {
"enum": [
"18-24",
"25-34",
"35-44",
"45-54",
"55-64",
"65+"
],
"type": "string",
"title": "Segment Operator",
"example": "female",
"description": "The predicted age to segment."
},
"condition_type": {
"enum": [
"PredictedAge"
],
"type": "string",
"x-value": "PredictedAge"
}
},
"description": "Segment by predicted age."
},
{
"type": "object",
"title": "New Subscribers Prebuilt Segment",
"properties": {
"op": {
"enum": [
"date_within"
],
"type": "string",
"title": "Segment Operator",
"description": "Whe the event took place, namely within a time frame."
},
"field": {
"enum": [
"timestamp_opt"
],
"type": "string",
"title": "Segment Field",
"description": "Segment by when people subscribed."
},
"value": {
"type": "string",
"title": "Segment Data",
"description": "What type of data to segment on: a specific date, a specific campaign, or the last campaign sent."
},
"condition_type": {
"enum": [
"NewSubscribers"
],
"type": "string",
"x-value": "NewSubscribers"
}
},
"description": "Segment by when people subscribed."
}
],
"discriminator": {
"type": "string",
"propertyName": "condition_type"
}
},
"title": "Segment Type",
"description": "Segment match conditions. There are multiple possible types, see the [condition types documentation](https://mailchimp.com/developer/marketing/docs/alternative-schemas/#segment-condition-schemas)."
},
"saved_segment_id": {
"type": "integer",
"title": "Saved Segment ID",
"description": "The id for an existing saved segment."
},
"prebuilt_segment_id": {
"type": "string",
"title": "Prebuilt Segment Id",
"example": "subscribers-female",
"description": "The prebuilt segment id, if a prebuilt segment has been designated for this campaign."
}
},
"description": "An object representing all segmentation options. This object should contain a `saved_segment_id` to use an existing segment, or you can create a new segment by including both `match` and `conditions` options."
},
"segment_text": {
"type": "string",
"title": "Segment Text",
"readOnly": true,
"description": "A description of the [segment](https://mailchimp.com/help/getting-started-with-groups/) used for the campaign. Formatted as a string marked up with HTML."
},
"list_is_active": {
"type": "boolean",
"title": "List Status",
"readOnly": true,
"description": "The status of the list used, namely if it's deleted or disabled."
},
"recipient_count": {
"type": "integer",
"title": "Recipient Count",
"readOnly": true,
"description": "Count of the recipients on the associated list. Formatted as an integer."
}
},
"description": "List settings for the campaign."
},
"start_time": {
"type": "string",
"title": "Start Time",
"format": "date-time",
"readOnly": true,
"description": "The date and time the campaign was started in ISO 8601 format."
},
"archive_url": {
"type": "string",
"title": "Archive URL",
"readOnly": true,
"description": "The link to the campaign's archive version in ISO 8601 format."
},
"create_time": {
"type": "string",
"title": "Create Time",
"format": "date-time",
"readOnly": true,
"description": "The date and time the campaign was created in ISO 8601 format."
},
"emails_sent": {
"type": "integer",
"title": "Emails Sent",
"readOnly": true,
"description": "The total number of emails sent for this campaign."
},
"social_card": {
"type": "object",
"title": "Campaign Social Card",
"properties": {
"title": {
"type": "string",
"title": "Title",
"description": "The title for the card. Typically the subject line of the campaign."
},
"image_url": {
"type": "string",
"title": "Image URL",
"description": "The url for the header image for the card."
},
"description": {
"type": "string",
"title": "Campaign Description",
"description": "A short summary of the campaign to display."
}
},
"description": "The preview for the campaign, rendered by social networks like Facebook and Twitter. [Learn more](https://mailchimp.com/help/enable-and-customize-social-cards/)."
},
"workflow_id": {
"type": "string",
"title": "Workflow ID",
"readOnly": true,
"description": "A string that uniquely identifies an Automation workflow."
},
"content_type": {
"type": "string",
"title": "Content Type",
"readOnly": true,
"description": "How the campaign's content is put together ('template', 'drag_and_drop', 'html', 'url')."
},
"report_summary": {
"type": "object",
"title": "Campaign Report Summary",
"properties": {
"opens": {
"type": "integer",
"title": "Automation Opens",
"readOnly": true,
"description": "The total number of opens for a campaign."
},
"clicks": {
"type": "integer",
"title": "Total Clicks",
"readOnly": true,
"description": "The total number of clicks for an campaign."
},
"open_rate": {
"type": "number",
"title": "Open Rate",
"readOnly": true,
"description": "The number of unique opens divided by the total number of successful deliveries."
},
"click_rate": {
"type": "number",
"title": "Click Rate",
"readOnly": true,
"description": "The number of unique clicks divided by the total number of successful deliveries."
},
"unique_opens": {
"type": "integer",
"title": "Unique Opens",
"readOnly": true,
"description": "The number of unique opens."
},
"subscriber_clicks": {
"type": "integer",
"title": "Unique Subscriber Clicks",
"readOnly": true,
"description": "The number of unique clicks."
}
},
"description": "For sent campaigns, a summary of opens and clicks."
},
"trigger_settings": {
"type": "object",
"title": "Automation Trigger",
"required": [
"workflow_type"
],
"properties": {
"runtime": {
"type": "object",
"title": "Automation Workflow Runtime Settings",
"properties": {
"days": {
"type": "array",
"items": {
"enum": [
"sunday",
"monday",
"tuesday",
"wednesday",
"thursday",
"friday",
"saturday"
],
"type": "string"
},
"title": "Days",
"description": "The days an Automation workflow can send."
},
"hours": {
"type": "object",
"title": "Hours",
"required": [
"type"
],
"properties": {
"type": {
"enum": [
"send_asap",
"send_between",
"send_at"
],
"type": "string",
"title": "Email Send Time Settings",
"description": "When to send the Automation email."
}
},
"description": "The hours an Automation workflow can send."
}
},
"description": "A workflow's runtime settings for an Automation."
},
"workflow_type": {
"enum": [
"abandonedBrowse",
"abandonedCart",
"api",
"bestCustomers",
"categoryFollowup",
"dateAdded",
"emailFollowup",
"emailSeries",
"groupAdd",
"groupRemove",
"mandrill",
"productFollowup",
"purchaseFollowup",
"recurringEvent",
"specialEvent",
"visitUrl",
"welcomeSeries"
],
"type": "string",
"title": "Workflow Type",
"description": "The type of Automation workflow."
},
"workflow_title": {
"type": "string",
"title": "Workflow Title",
"readOnly": true,
"description": "The title of the workflow type."
},
"workflow_emails_count": {
"type": "integer",
"title": "Workflow Emails Count",
"readOnly": true,
"description": "The number of emails in the Automation workflow."
}
},
"description": "Available triggers for Automation workflows.",
"discriminator": {
"propertyName": "workflow_type"
}
},
"has_logo_merge_tag": {
"type": "boolean",
"title": "Has Logo Merge Tag",
"example": true,
"readOnly": true,
"description": "Determines if the campaign contains the *|BRAND:LOGO|* merge tag."
},
"needs_block_refresh": {
"type": "boolean",
"title": "Needs Block Refresh",
"example": true,
"readOnly": true,
"description": "Determines if the automation email needs its blocks refreshed by opening the web-based campaign editor."
}
},
"description": "A summary of an individual Automation workflow email."
},
"title": "Emails",
"description": "An array of objects, each representing an email in an Automation workflow."
},
"total_items": {
"type": "integer",
"title": "Item Count",
"readOnly": true,
"description": "The total number of items matching the query regardless of pagination."
}
},
"description": "A summary of the emails in an Automation workflow."
}
AutomationsGetClassicWorkflowEmailsResponse
{
"type": "object",
"title": "Automation Emails",
"properties": {
"_links": {
"type": "array",
"items": {
"type": "object",
"title": "Resource Link",
"properties": {
"rel": {
"type": "string",
"title": "Rel",
"readOnly": true,
"description": "As with an HTML 'rel' attribute, this describes the type of link."
},
"href": {
"type": "string",
"title": "Href",
"readOnly": true,
"description": "This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action."
},
"method": {
"enum": [
"GET",
"POST",
"PUT",
"PATCH",
"DELETE",
"OPTIONS",
"HEAD"
],
"type": "string",
"title": "Method",
"readOnly": true,
"description": "The HTTP method that should be used when accessing the URL defined in 'href'."
},
"schema": {
"type": "string",
"title": "Schema",
"readOnly": true,
"description": "For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to."
},
"targetSchema": {
"type": "string",
"title": "Target Schema",
"readOnly": true,
"description": "For GETs, this is a URL representing the schema that the response should conform to."
}
},
"description": "This object represents a link from the resource where it is found to another resource or action that may be performed."
},
"title": "Links",
"readOnly": true,
"description": "A list of link types and descriptions for the API schema documents."
},
"emails": {
"type": "array",
"items": {
"type": "object",
"title": "Automation Workflow Email",
"properties": {
"id": {
"type": "string",
"title": "Automation Email ID",
"readOnly": true,
"description": "A string that uniquely identifies the Automation email."
},
"delay": {
"type": "object",
"title": "Automation Delay",
"properties": {
"type": {
"enum": [
"now",
"day",
"hour",
"week"
],
"type": "string",
"title": "Delay Type",
"description": "The type of delay for an Automation email."
},
"action": {
"enum": [
"previous_campaign_sent",
"previous_campaign_opened",
"previous_campaign_not_opened",
"previous_campaign_clicked_any",
"previous_campaign_not_clicked_any",
"previous_campaign_specific_clicked",
"ecomm_bought_any",
"ecomm_bought_product",
"ecomm_bought_category",
"ecomm_not_bought_any",
"ecomm_abandoned_cart",
"campaign_sent",
"opened_email",
"not_opened_email",
"clicked_email",
"not_clicked_email",
"campaign_specific_clicked",
"manual",
"signup",
"merge_changed",
"group_add",
"group_remove",
"mandrill_sent",
"mandrill_opened",
"mandrill_clicked",
"mandrill_any",
"api",
"goal",
"annual",
"birthday",
"date",
"date_added",
"tag_add"
],
"type": "string",
"title": "Delay Action",
"description": "The action that triggers the delay of an Automation email."
},
"amount": {
"type": "integer",
"title": "Delay Amount",
"readOnly": true,
"description": "The delay amount for an Automation email."
},
"direction": {
"enum": [
"before",
"after"
],
"type": "string",
"title": "Delay Direction",
"description": "Whether the delay settings describe before or after the delay action of an Automation email."
},
"full_description": {
"type": "string",
"title": "Full Delay Description",
"example": "1 day after subscribers purchase anything from your store",
"readOnly": true,
"description": "The user-friendly description of the delay and trigger action settings for an Automation email."
},
"action_description": {
"type": "string",
"title": "Delay Action Description",
"example": "subscribers purchase anything from your store",
"readOnly": true,
"description": "The user-friendly description of the action that triggers an Automation email."
}
},
"description": "The delay settings for an Automation email."
},
"_links": {
"type": "array",
"items": {
"type": "object",
"title": "Resource Link",
"properties": {
"rel": {
"type": "string",
"title": "Rel",
"readOnly": true,
"description": "As with an HTML 'rel' attribute, this describes the type of link."
},
"href": {
"type": "string",
"title": "Href",
"readOnly": true,
"description": "This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action."
},
"method": {
"enum": [
"GET",
"POST",
"PUT",
"PATCH",
"DELETE",
"OPTIONS",
"HEAD"
],
"type": "string",
"title": "Method",
"readOnly": true,
"description": "The HTTP method that should be used when accessing the URL defined in 'href'."
},
"schema": {
"type": "string",
"title": "Schema",
"readOnly": true,
"description": "For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to."
},
"targetSchema": {
"type": "string",
"title": "Target Schema",
"readOnly": true,
"description": "For GETs, this is a URL representing the schema that the response should conform to."
}
},
"description": "This object represents a link from the resource where it is found to another resource or action that may be performed."
},
"title": "Links",
"readOnly": true,
"description": "A list of link types and descriptions for the API schema documents."
},
"status": {
"enum": [
"save",
"paused",
"sending"
],
"type": "string",
"title": "Campaign Status",
"readOnly": true,
"description": "The current status of the campaign."
},
"web_id": {
"type": "integer",
"title": "Automation Web ID",
"example": 33345484,
"readOnly": true,
"description": "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}`."
},
"position": {
"type": "integer",
"title": "Email Position",
"readOnly": true,
"description": "The position of an Automation email in a workflow."
},
"settings": {
"type": "object",
"title": "Campaign Settings",
"properties": {
"title": {
"type": "string",
"title": "Campaign Title",
"description": "The title of the campaign."
},
"reply_to": {
"type": "string",
"title": "Reply To Address",
"description": "The reply-to email address for the campaign."
},
"from_name": {
"type": "string",
"title": "From Name",
"description": "The 'from' name on the campaign (not an email address)."
},
"auto_tweet": {
"type": "boolean",
"title": "Auto-Tweet",
"description": "Automatically tweet a link to the [campaign archive](https://mailchimp.com/help/about-email-campaign-archives-and-pages/) page when the campaign is sent."
},
"inline_css": {
"type": "boolean",
"title": "Inline CSS",
"description": "Automatically inline the CSS included with the campaign content."
},
"auto_footer": {
"type": "boolean",
"title": "Auto-Footer",
"description": "Automatically append Mailchimp's [default footer](https://mailchimp.com/help/about-campaign-footers/) to the campaign."
},
"fb_comments": {
"type": "boolean",
"title": "Facebook Comments",
"description": "Allows Facebook comments on the campaign (also force-enables the Campaign Archive toolbar). Defaults to `true`."
},
"template_id": {
"type": "integer",
"title": "Template ID",
"description": "The id for the template used in this campaign."
},
"authenticate": {
"type": "boolean",
"title": "Authentication",
"description": "Whether Mailchimp [authenticated](https://mailchimp.com/help/about-email-authentication/) the campaign. Defaults to `true`."
},
"auto_fb_post": {
"type": "array",
"items": {
"type": "string"
},
"title": "Auto Post to Facebook",
"description": "An array of [Facebook](https://mailchimp.com/help/connect-or-disconnect-the-facebook-integration/) page ids to auto-post to."
},
"preview_text": {
"type": "string",
"title": "Campaign Preview Text",
"description": "The preview text for the campaign."
},
"subject_line": {
"type": "string",
"title": "Campaign Subject Line",
"description": "The subject line for the campaign."
},
"drag_and_drop": {
"type": "boolean",
"title": "Drag And Drop Campaign",
"readOnly": true,
"description": "Whether the campaign uses the drag-and-drop editor."
}
},
"description": "Settings for the campaign including the email subject, from name, and from email address."
},
"tracking": {
"type": "object",
"title": "Campaign Tracking Options",
"properties": {
"opens": {
"type": "boolean",
"title": "Opens",
"description": "Whether to [track opens](https://mailchimp.com/help/about-open-tracking/). Defaults to `true`."
},
"capsule": {
"type": "object",
"title": "Capsule CRM Tracking",
"properties": {
"notes": {
"type": "boolean",
"title": "Capsule Note",
"description": "Update contact notes for a campaign based on a subscriber's email address."
}
},
"description": "Deprecated"
},
"ecomm360": {
"type": "boolean",
"title": "E-commerce Tracking",
"description": "Whether to enable e-commerce tracking."
},
"clicktale": {
"type": "string",
"title": "ClickTale Analytics Tracking",
"description": "The custom slug for [Click Tale](https://mailchimp.com/help/additional-tracking-options-for-campaigns/) tracking (max of 50 bytes)."
},
"salesforce": {
"type": "object",
"title": "Salesforce CRM Tracking",
"properties": {
"notes": {
"type": "boolean",
"title": "Salesforce Note",
"description": "Update contact notes for a campaign based on a subscriber's email address."
},
"campaign": {
"type": "boolean",
"title": "Salesforce Campaign",
"description": "Create a campaign in a connected Salesforce account."
}
},
"description": "Deprecated"
},
"html_clicks": {
"type": "boolean",
"title": "HTML Click Tracking",
"description": "Whether to [track clicks](https://mailchimp.com/help/enable-and-view-click-tracking/) in the HTML version of the campaign. Defaults to `true`."
},
"text_clicks": {
"type": "boolean",
"title": "Plain-Text Click Tracking",
"description": "Whether to [track clicks](https://mailchimp.com/help/enable-and-view-click-tracking/) in the plain-text version of the campaign. Defaults to `true`."
},
"goal_tracking": {
"type": "boolean",
"title": "Mailchimp Goal Tracking",
"description": "Deprecated"
},
"google_analytics": {
"type": "string",
"title": "Google Analytics Tracking",
"description": "The custom slug for [Google Analytics](https://mailchimp.com/help/integrate-google-analytics-with-mailchimp/) tracking (max of 50 bytes)."
}
},
"description": "The tracking options for a campaign."
},
"send_time": {
"type": "string",
"title": "Send Time",
"format": "date-time",
"readOnly": true,
"description": " The date and time a campaign was sent in ISO 8601 format"
},
"recipients": {
"type": "object",
"title": "List",
"properties": {
"list_id": {
"type": "string",
"title": "List ID",
"description": "The unique list id."
},
"list_name": {
"type": "string",
"title": "List Name",
"readOnly": true,
"description": "The name of the list."
},
"segment_opts": {
"type": "object",
"title": "Segment Options",
"properties": {
"match": {
"enum": [
"any",
"all"
],
"type": "string",
"title": "Match Type",
"description": "Segment match type."
},
"conditions": {
"type": "array",
"items": {
"oneOf": [
{
"type": "object",
"title": "Aim Segment",
"properties": {
"op": {
"enum": [
"open",
"click",
"sent",
"noopen",
"noclick",
"nosent"
],
"type": "string",
"title": "Segment Operator",
"example": "open",
"description": "The status of the member with regard to their campaign interaction. One of the following: opened, clicked, was sent, didn't open, didn't click, or was not sent."
},
"field": {
"enum": [
"aim"
],
"type": "string",
"title": "Segment Field",
"example": "aim",
"description": "Segment by interaction with a specific campaign."
},
"value": {
"type": "string",
"title": "Segment Data",
"example": "any",
"description": "Either the web id value for a specific campaign or 'any' to account for subscribers who have/have not interacted with any campaigns."
},
"condition_type": {
"enum": [
"Aim"
],
"type": "string",
"x-value": "Aim"
}
},
"description": "Segment by interaction with a specific campaign."
},
{
"type": "object",
"title": "Automation Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"started",
"completed",
"not_started",
"not_completed"
],
"type": "string",
"title": "Segment Operator",
"example": "started",
"description": "The status of the member with regard to the automation workflow. One of the following: has started the workflow, has completed the workflow, has not started the workflow, or has not completed the workflow."
},
"field": {
"enum": [
"automation"
],
"type": "string",
"title": "Segment Field",
"example": "automation",
"description": "Segment by interaction with an Automation workflow."
},
"value": {
"type": "string",
"title": "Segment Data",
"example": "2135217",
"description": "The web id for the automation workflow to segment against."
},
"condition_type": {
"enum": [
"Automation"
],
"type": "string",
"x-value": "Automation"
}
},
"description": "Segment by interaction with an Automation workflow."
},
{
"type": "object",
"title": "Poll Activity Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"member",
"notmember"
],
"type": "string",
"title": "Segment Operator",
"example": "member",
"description": "Members have/have not interacted with a specific poll in a Mailchimp email."
},
"field": {
"enum": [
"poll"
],
"type": "string",
"title": "Segment Field",
"example": "poll",
"description": "Segment by poll activity."
},
"value": {
"type": "number",
"title": "Segment Operator",
"example": 409,
"description": "The id for the poll."
},
"condition_type": {
"enum": [
"CampaignPoll"
],
"type": "string",
"x-value": "CampaignPoll"
}
},
"description": "Segment by poll activity."
},
{
"type": "object",
"title": "Conversation Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"member",
"notmember"
],
"type": "string",
"title": "Segment Operator",
"example": "member",
"description": "The status of a member's interaction with a conversation. One of the following: has replied or has not replied."
},
"field": {
"enum": [
"conversation"
],
"type": "string",
"title": "Segment Field",
"example": "conversation",
"description": "Segment by interaction with a campaign via Conversations."
},
"value": {
"type": "string",
"title": "Segment Data",
"example": "any",
"description": "The web id value for a specific campaign or 'any' to account for subscribers who have/have not interacted with any campaigns."
},
"condition_type": {
"enum": [
"Conversation"
],
"type": "string",
"x-value": "Conversation"
}
},
"description": "Segment by interaction with a campaign via Conversations."
},
{
"type": "object",
"title": "Date Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"greater",
"less",
"is",
"not",
"blank",
"blank_not",
"within",
"notwithin"
],
"type": "string",
"title": "Segment Operator",
"example": "greater",
"description": "When the event took place: Before, after, is a specific date, is not a specific date, is blank, or is not blank."
},
"extra": {
"type": "string",
"title": "Segment Extra Value",
"example": "2015-01-30",
"description": "When segmenting on 'date' or 'campaign', the date for the segment formatted as YYYY-MM-DD or the web id for the campaign."
},
"field": {
"enum": [
"timestamp_opt",
"info_changed",
"ecomm_date"
],
"type": "string",
"title": "Segment Field",
"example": "timestamp_opt",
"description": "The type of date field to segment on: The opt-in time for a signup, the date the subscriber was last updated, or the date of their last ecomm purchase."
},
"value": {
"type": "string",
"title": "Segment Data",
"example": "date",
"description": "What type of data to segment on: a specific date, a specific campaign, or the last campaign sent."
},
"condition_type": {
"enum": [
"Date"
],
"type": "string",
"x-value": "Date"
}
},
"description": "Segment by a specific date field."
},
{
"type": "object",
"title": "Email Client Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"client_is",
"client_not"
],
"type": "string",
"title": "Segment Operator",
"example": "client_is",
"description": "The operation to determine whether we select clients that match the value, or clients that do not match the value."
},
"field": {
"enum": [
"email_client"
],
"type": "string",
"title": "Segment Field",
"example": "email_client",
"description": "Segment by use of a particular email client."
},
"value": {
"type": "string",
"title": "Segment Data",
"example": "Gmail",
"description": "The name of the email client."
},
"condition_type": {
"enum": [
"EmailClient"
],
"type": "string",
"x-value": "EmailClient"
}
},
"description": "Segment by use of a particular email client."
},
{
"type": "object",
"title": "Language Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"is",
"not"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Whether the member's language is or is not set to a specific language."
},
"field": {
"enum": [
"language"
],
"type": "string",
"title": "Segment Field",
"example": "language",
"description": "Segmenting based off of a subscriber's language."
},
"value": {
"type": "string",
"title": "Segment Data",
"example": "en",
"description": "A two-letter language identifier."
},
"condition_type": {
"enum": [
"Language"
],
"type": "string",
"x-value": "Language"
}
},
"description": "Segment by language."
},
{
"type": "object",
"title": "Member Rating Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"is",
"not",
"greater",
"less"
],
"type": "string",
"title": "Segment Operator",
"example": "greater",
"description": "Members who have have a rating that is/not exactly a given number or members who have a rating greater/less than a given number."
},
"field": {
"enum": [
"rating"
],
"type": "string",
"title": "Segment Field",
"example": "rating",
"description": "Segment by member rating."
},
"value": {
"type": "number",
"title": "Segment Operator",
"example": 4,
"description": "The star rating number to segment against."
},
"condition_type": {
"enum": [
"MemberRating"
],
"type": "string",
"x-value": "MemberRating"
}
},
"description": "Segment by member rating."
},
{
"type": "object",
"title": "Signup Source Segment",
"required": [
"field",
"condition_type",
"op"
],
"properties": {
"op": {
"enum": [
"source_is",
"source_not"
],
"type": "string",
"title": "Segment Operator",
"example": "source_is",
"description": "Whether the member's signup source was/was not a particular value."
},
"field": {
"enum": [
"source"
],
"type": "string",
"title": "Segment Field",
"example": "source"
},
"value": {
"type": "string",
"title": "Segment Data",
"example": "List Import",
"description": "The signup source."
},
"condition_type": {
"enum": [
"SignupSource"
],
"type": "string",
"title": "Type",
"x-value": "SignupSource"
}
},
"description": "Segment by signup source."
},
{
"type": "object",
"title": "Survey Monkey Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"started",
"completed",
"not_started",
"not_completed"
],
"type": "string",
"title": "Segment Operator",
"example": "started",
"description": "The status of the member with regard to the survey.One of the following: has started the survey, has completed the survey, has not started the survey, or has not completed the survey."
},
"field": {
"enum": [
"survey_monkey"
],
"type": "string",
"title": "Segment Field",
"example": "survey_monkey",
"description": "Segment by interaction with a SurveyMonkey survey."
},
"value": {
"type": "string",
"title": "Survey ID",
"example": "32179586",
"description": "The unique ID of the survey monkey survey."
},
"condition_type": {
"enum": [
"SurveyMonkey"
],
"type": "string",
"x-value": "SurveyMonkey"
}
},
"description": "Segment by interaction with a SurveyMonkey survey."
},
{
"type": "object",
"title": "VIP Segment",
"required": [
"field",
"op"
],
"properties": {
"op": {
"enum": [
"member",
"notmember"
],
"type": "string",
"title": "Segment Operator",
"example": "member",
"description": "Whether the member is or is not marked as VIP."
},
"field": {
"enum": [
"gmonkey"
],
"type": "string",
"title": "Segment Field",
"example": "gmonkey",
"description": "Segment by VIP status."
},
"condition_type": {
"enum": [
"VIP"
],
"type": "string",
"x-value": "VIP"
}
},
"description": "Segment by VIP status."
},
{
"type": "object",
"title": "Interests Segment",
"properties": {
"op": {
"enum": [
"interestcontains",
"interestcontainsall",
"interestnotcontains"
],
"type": "string",
"title": "Segment Operator",
"example": "interestcontains",
"description": "Whether the member is a part of one, all, or none of the groups."
},
"field": {
"type": "string",
"title": "Segment Field",
"example": "interests-123",
"description": "Segmenting based on interest group information. This should start with 'interests-' followed by the grouping id. Ex. 'interests-123'."
},
"value": {
"type": "array",
"items": {
"type": "string",
"example": [
"44401",
"44405",
"44409"
]
},
"title": "Segment Value",
"description": "An array containing strings, each representing a group id."
},
"condition_type": {
"enum": [
"Interests"
],
"type": "string",
"x-value": "Interests"
}
},
"description": "Segment by an interest group merge field."
},
{
"type": "object",
"title": "Ecommerce Category Segment",
"properties": {
"op": {
"enum": [
"is",
"not",
"contains",
"notcontain",
"starts",
"ends"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "A member who has purchased from a category/specific item that is/is not a specific name, where the category/item name contains/doesn't contain a specific phrase or string, or a category/item name that starts/ends with a string."
},
"field": {
"enum": [
"ecomm_cat",
"ecomm_prod"
],
"type": "string",
"title": "Segment Field",
"example": "ecomm_cat",
"description": "Segment by purchases in specific items or categories."
},
"value": {
"type": "string",
"title": "Segment Data",
"example": "Product",
"description": "The ecommerce category/item information."
},
"condition_type": {
"enum": [
"EcommCategory"
],
"type": "string",
"x-value": "EcommCategory"
}
},
"description": "Segment by purchases in specific items or categories."
},
{
"type": "object",
"title": "Ecommerce Number Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"is",
"not",
"greater",
"less"
],
"type": "string",
"title": "Segment Operator",
"example": "greater",
"description": "Members who have spent exactly, have not spent exactly, spent more, or spent less than the segment value."
},
"field": {
"enum": [
"ecomm_spent_avg",
"ecomm_orders",
"ecomm_prod_all",
"ecomm_avg_ord"
],
"type": "string",
"title": "Segment Field",
"example": "ecomm_orders",
"description": "Segment by average spent total, number of orders, total number of products purchased, or average number of products per order."
},
"value": {
"type": "number",
"title": "Segment Operator",
"example": 42,
"description": "Members who have spent exactly, have not spent exactly, spent more, or spent less than this amount."
},
"condition_type": {
"enum": [
"EcommNumber"
],
"type": "string",
"x-value": "EcommNumber"
}
},
"description": "Segment by average spent total, number of orders, total number of products purchased, or average number of products per order."
},
{
"type": "object",
"title": "Ecommerce Purchased Segment",
"properties": {
"op": {
"enum": [
"member",
"notmember"
],
"type": "string",
"title": "Segment Operator",
"example": "member",
"description": "Members who have have ('member') or have not ('notmember') purchased."
},
"field": {
"enum": [
"ecomm_purchased"
],
"type": "string",
"title": "Segment Field",
"example": "ecomm_purchased",
"description": "Segment by whether someone has purchased anything."
},
"condition_type": {
"enum": [
"EcommPurchased"
],
"type": "string",
"x-value": "EcommPurchased"
}
},
"description": "Segment by whether someone has purchased anything."
},
{
"type": "object",
"title": "Ecommerce Spent Segment",
"properties": {
"op": {
"enum": [
"greater",
"less"
],
"type": "string",
"title": "Segment Operator",
"example": "greater",
"description": "Members who have spent 'more' or 'less' than then specified value."
},
"field": {
"enum": [
"ecomm_spent_one",
"ecomm_spent_all"
],
"type": "string",
"title": "Segment Field",
"example": "ecomm_spent_one",
"description": "Segment by amount spent on a single order or across all orders."
},
"value": {
"type": "integer",
"title": "Segment Data",
"example": 42,
"description": "The total amount a member spent."
},
"condition_type": {
"enum": [
"EcommSpent"
],
"type": "string",
"x-value": "EcommSpent"
}
},
"description": "Segment by amount spent on a single order or across all orders."
},
{
"type": "object",
"title": "Ecommerce Purchased Store Segment",
"properties": {
"op": {
"enum": [
"is",
"not"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Members who have or have not purchased from a specific store."
},
"field": {
"enum": [
"ecomm_store"
],
"type": "string",
"title": "Segment Field",
"example": "ecomm_store",
"description": "Segment by purchases from a specific store."
},
"value": {
"type": "string",
"title": "Segment Operator",
"example": "289",
"description": "The store id to segment against."
},
"condition_type": {
"enum": [
"EcommStore"
],
"type": "string",
"x-value": "EcommStore"
}
},
"description": "Segment by purchases from a specific store."
},
{
"type": "object",
"title": "Goal Activity Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"is",
"goal_not",
"contains",
"goal_notcontain",
"starts",
"ends"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Whether the website URL is/not exactly, contains/doesn't contain, starts with/ends with a string."
},
"field": {
"enum": [
"goal"
],
"type": "string",
"title": "Segment Field",
"example": "goal",
"description": "Segment by Goal activity."
},
"value": {
"type": "string",
"title": "Segment Value",
"description": "The URL to check Goal activity against."
},
"condition_type": {
"enum": [
"GoalActivity"
],
"type": "string",
"x-value": "GoalActivity"
}
},
"description": "Segment by Goal activity."
},
{
"type": "object",
"title": "Goal Timestamp Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"greater",
"less",
"is"
],
"type": "string",
"title": "Segment Operator",
"example": "greater",
"description": "Whether the website activity happened after, before, or at a given timestamp."
},
"field": {
"enum": [
"goal_last_visited"
],
"type": "string",
"title": "Segment Field",
"example": "goal_last_visited",
"description": "Segment by most recent interaction with a website."
},
"value": {
"type": "string",
"title": "Segment Value",
"example": "2015-07-20 19:45:21",
"description": "The date to check Goal activity against."
},
"condition_type": {
"enum": [
"GoalTimestamp"
],
"type": "string",
"x-value": "GoalTimestamp"
}
},
"description": "Segment by most recent interaction with a website."
},
{
"type": "object",
"title": "Similar Subscribers Segment Member Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"fuzzy_is",
"fuzzy_not"
],
"type": "string",
"title": "Segment Operator",
"example": "fuzzy_is",
"description": "Members who are/are not apart of a 'similar subscribers' segment."
},
"field": {
"enum": [
"fuzzy_segment"
],
"type": "string",
"title": "Segment Field",
"example": "fuzzy_segment",
"description": "Segment by similar subscribers."
},
"value": {
"type": "number",
"title": "Segment Operator",
"example": 48433,
"description": "The id for the 'similar subscribers' segment."
},
"condition_type": {
"enum": [
"FuzzySegment"
],
"type": "string",
"x-value": "FuzzySegment"
}
},
"description": "Segment by similar subscribers."
},
{
"type": "object",
"title": "Static Segment Member Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"static_is",
"static_not"
],
"type": "string",
"title": "Segment Operator",
"example": "static_is",
"description": "Members who are/are not apart of a static segment."
},
"field": {
"enum": [
"static_segment"
],
"type": "string",
"title": "Segment Field",
"example": "static_segment",
"description": "Segment by a given static segment."
},
"value": {
"type": "number",
"title": "Segment Operator",
"example": 48433,
"description": "The id for the static segment."
},
"condition_type": {
"enum": [
"StaticSegment"
],
"type": "string",
"x-value": "StaticSegment"
}
},
"description": "Segment by a given static segment."
},
{
"type": "object",
"title": "Location-Based Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"ipgeocountry",
"ipgeonotcountry",
"ipgeostate",
"ipgeonotstate"
],
"type": "string",
"title": "Segment Operator",
"example": "ipgeocountry",
"description": "Segment members who are within a specific country or US state."
},
"field": {
"enum": [
"ipgeo"
],
"type": "string",
"title": "Segment Field",
"example": "ipgeo",
"description": "Segmenting subscribers who are within a specific location."
},
"value": {
"type": "string",
"title": "Segment Data",
"example": "US",
"description": "The two-letter country code or US state abbreviation."
},
"condition_type": {
"enum": [
"IPGeoCountryState"
],
"type": "string",
"x-value": "IPGeoCountryState"
}
},
"description": "Segment by a specific country or US state."
},
{
"type": "object",
"title": "Geolocation Segment",
"required": [
"field",
"op",
"value",
"addr",
"lat",
"lng"
],
"properties": {
"op": {
"enum": [
"ipgeoin",
"ipgeonotin"
],
"type": "string",
"title": "Segment Operator",
"example": "ipgeoin",
"description": "Segment members who are within a specific geographic region."
},
"lat": {
"type": "string",
"title": "Segment Location Latitude",
"example": "33.7489954",
"description": "The latitude of the target location."
},
"lng": {
"type": "string",
"title": "Segment Location Longitude",
"example": "-84.3879824",
"description": "The longitude of the target location."
},
"addr": {
"type": "string",
"title": "Segment Location Address",
"example": "Atlanta, GA, USA",
"description": "The address of the target location."
},
"field": {
"enum": [
"ipgeo"
],
"type": "string",
"title": "Segment Field",
"example": "ipgeo",
"description": "Segmenting subscribers who are within a specific location."
},
"value": {
"type": "integer",
"title": "Segment Data",
"example": 42,
"description": "The radius of the target location."
},
"condition_type": {
"enum": [
"IPGeoIn"
],
"type": "string",
"x-value": "IPGeoIn"
}
},
"description": "Segment by a specific geographic region."
},
{
"type": "object",
"title": "US Zip Code Segment",
"required": [
"field",
"op",
"value",
"extra"
],
"properties": {
"op": {
"enum": [
"ipgeoinzip"
],
"type": "string",
"title": "Segment Operator",
"example": "ipgeoinzip",
"description": "Segment members who are within a specific US zip code."
},
"extra": {
"type": "integer",
"title": "Extra Data",
"example": 30318,
"description": "The zip code to segment against."
},
"field": {
"enum": [
"ipgeo"
],
"type": "string",
"title": "Segment Field",
"example": "ipgeo",
"description": "Segmenting subscribers who are within a specific location."
},
"value": {
"type": "integer",
"title": "Segment Data",
"example": 25,
"description": "The radius of the target location."
},
"condition_type": {
"enum": [
"IPGeoInZip"
],
"type": "string",
"x-value": "IPGeoInZip"
}
},
"description": "Segment by a specific US ZIP code."
},
{
"type": "object",
"title": "Unknown Location-Based Segment",
"required": [
"field",
"op"
],
"properties": {
"op": {
"enum": [
"ipgeounknown"
],
"type": "string",
"title": "Segment Operator",
"example": "ipgeounknown",
"description": "Segment members for which location information is unknown."
},
"field": {
"enum": [
"ipgeo"
],
"type": "string",
"title": "Segment Field",
"example": "ipgeo",
"description": "Segmenting subscribers who are within a specific location."
},
"condition_type": {
"enum": [
"IPGeoUnknown"
],
"type": "string",
"x-value": "IPGeoUnknown"
}
},
"description": "Segment members whose location information is unknown."
},
{
"type": "object",
"title": "Zip Code Location-Based Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"ipgeoiszip",
"ipgeonotzip"
],
"type": "string",
"title": "Segment Operator",
"example": "ipgeonotzip",
"description": "Segment members who are/are not within a specific US zip code."
},
"field": {
"enum": [
"ipgeo"
],
"type": "string",
"title": "Segment Field",
"example": "ipgeo",
"description": "Segmenting subscribers who are within a specific location."
},
"value": {
"type": "integer",
"title": "Segment Data",
"example": 30318,
"description": "The 5-digit zip code."
},
"condition_type": {
"enum": [
"IPGeoZip"
],
"type": "string",
"x-value": "IPGeoZip"
}
},
"description": "Segment by a specific US ZIP code."
},
{
"type": "object",
"title": "Social Profiles Age Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"is",
"not"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Members who are/not the exact criteria listed."
},
"field": {
"enum": [
"social_age"
],
"type": "string",
"title": "Segment Field",
"example": "social_age",
"description": "Segment by age ranges in Social Profiles data."
},
"value": {
"enum": [
"18-24",
"25-34",
"35-54",
"55+"
],
"type": "string",
"title": "Segment Operator",
"example": "35-54",
"description": "The age range to segment."
},
"condition_type": {
"enum": [
"SocialAge"
],
"type": "string",
"x-value": "SocialAge"
}
},
"description": "Segment by age ranges in Social Profiles data."
},
{
"type": "object",
"title": "Social Profiles Gender Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"is",
"not"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Members who are/not the exact criteria listed."
},
"field": {
"enum": [
"social_gender"
],
"type": "string",
"title": "Segment Field",
"example": "social_gender",
"description": "Segment by listed gender in Social Profiles data."
},
"value": {
"enum": [
"male",
"female"
],
"type": "string",
"title": "Segment Operator",
"example": "female",
"description": "The Social Profiles gender to segment."
},
"condition_type": {
"enum": [
"SocialGender"
],
"type": "string",
"x-value": "SocialGender"
}
},
"description": "Segment by listed gender in Social Profiles data."
},
{
"type": "object",
"title": "Social Profiles Influence Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"is",
"not",
"greater",
"less"
],
"type": "string",
"title": "Segment Operator",
"example": "greater",
"description": "Members who have a rating that is/not or greater/less than the rating provided."
},
"field": {
"enum": [
"social_influence"
],
"type": "string",
"title": "Segment Field",
"example": "social_influence",
"description": "Segment by influence rating in Social Profiles data."
},
"value": {
"type": "number",
"title": "Segment Operator",
"example": 2,
"description": "The Social Profiles influence rating to segment."
},
"condition_type": {
"enum": [
"SocialInfluence"
],
"type": "string",
"x-value": "SocialInfluence"
}
},
"description": "Segment by influence rating in Social Profiles data."
},
{
"type": "object",
"title": "Social Profiles Social Network Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"member",
"notmember"
],
"type": "string",
"title": "Segment Operator",
"example": "member",
"description": "Members who are/not on a given social network."
},
"field": {
"enum": [
"social_network"
],
"type": "string",
"title": "Segment Field",
"example": "social_network",
"description": "Segment by social network in Social Profiles data."
},
"value": {
"enum": [
"twitter",
"facebook",
"linkedin",
"flickr",
"foursquare",
"lastfm",
"myspace",
"quora",
"vimeo",
"yelp",
"youtube"
],
"type": "string",
"title": "Segment Operator",
"example": "twitter",
"description": "The social network to segment against."
},
"condition_type": {
"enum": [
"SocialNetworkMember"
],
"type": "string",
"x-value": "SocialNetworkMember"
}
},
"description": "Segment by social network in Social Profiles data."
},
{
"type": "object",
"title": "Social Profiles Social Network Follow Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"follow",
"notfollow"
],
"type": "string",
"title": "Segment Operator",
"example": "follow",
"description": "Members who are/not following a linked account on a given social network."
},
"field": {
"enum": [
"social_network"
],
"type": "string",
"title": "Segment Field",
"example": "social_network",
"description": "Segment by social network in Social Profiles data."
},
"value": {
"enum": [
"twitter_follow"
],
"type": "string",
"title": "Segment Operator",
"example": "twitter_follow",
"description": "The social network to segment against."
},
"condition_type": {
"enum": [
"SocialNetworkFollow"
],
"type": "string",
"x-value": "SocialNetworkFollow"
}
},
"description": "Segment by social network in Social Profiles data."
},
{
"type": "object",
"title": "Address Merge Field Segment",
"required": [
"field",
"op"
],
"properties": {
"op": {
"enum": [
"contains",
"notcontain",
"blank",
"blank_not"
],
"type": "string",
"title": "Segment Operator",
"example": "contains",
"description": "Whether the member's address merge field contains/does not contain a value or is/is not blank."
},
"field": {
"type": "string",
"title": "Segment Field",
"example": "MMERGE3",
"description": "An address-type merge field to segment."
},
"value": {
"type": "string",
"title": "Segment Value",
"example": "Atlanta",
"description": "The value to segment a text merge field with."
},
"condition_type": {
"enum": [
"AddressMerge"
],
"type": "string",
"x-value": "AddressMerge"
}
},
"description": "Segment by an address-type merge field."
},
{
"type": "object",
"title": "Address/Zip Merge Field Segment",
"required": [
"field",
"op",
"value",
"extra"
],
"properties": {
"op": {
"enum": [
"geoin"
],
"type": "string",
"title": "Segment Operator",
"example": "geoin",
"description": "Whether the member's address merge field is within a given distance from a city or zip."
},
"extra": {
"type": "string",
"title": "Segment Extra",
"example": "30318",
"description": "The city or the zip being used to segment against."
},
"field": {
"type": "string",
"title": "Segment Field",
"example": "MMERGE2",
"description": "An address or zip-type merge field to segment."
},
"value": {
"type": "string",
"title": "Segment Value",
"example": "25",
"description": "The distance from the city/zip."
},
"condition_type": {
"enum": [
"ZipMerge"
],
"type": "string",
"x-value": "ZipMerge"
}
},
"description": "Segment by an address-type merge field within a given distance."
},
{
"type": "object",
"title": "Birthday Merge Field Segment",
"required": [
"field",
"op"
],
"properties": {
"op": {
"enum": [
"is",
"not",
"blank",
"blank_not"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Whether the member's birthday merge information is/is not a certain date or is/is not blank."
},
"field": {
"type": "string",
"title": "Segment Field",
"example": "MMERGE4",
"description": "A date merge field to segment."
},
"value": {
"type": "string",
"title": "Segment Value",
"example": "01/30",
"description": "A date to segment against (mm/dd)."
},
"condition_type": {
"enum": [
"BirthdayMerge"
],
"type": "string",
"x-value": "BirthdayMerge"
}
},
"description": "Segment by a contact's birthday."
},
{
"type": "object",
"title": "Date Merge Field Segment",
"required": [
"field",
"op"
],
"properties": {
"op": {
"enum": [
"is",
"not",
"less",
"blank",
"blank_not",
"greater"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Whether the member's merge information is/is not, is greater/less than a value or is/is not blank."
},
"field": {
"type": "string",
"title": "Segment Field",
"example": "MMERGE5",
"description": "A date merge field to segment."
},
"value": {
"type": "string",
"title": "Segment Value",
"example": "01/30/2015",
"description": "A date to segment against."
},
"condition_type": {
"enum": [
"DateMerge"
],
"type": "string",
"x-value": "DateMerge"
}
},
"description": "Segment by a given date merge field."
},
{
"type": "object",
"title": "Dropdown/Radio Merge Field Segment",
"required": [
"field",
"op"
],
"properties": {
"op": {
"enum": [
"is",
"not",
"blank",
"blank_not",
"notcontain",
"contains"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Whether the member's merge information is/is not a value or is/is not blank."
},
"field": {
"type": "string",
"title": "Segment Field",
"example": "MMERGE6",
"description": "A merge field to segment."
},
"value": {
"type": "string",
"title": "Segment Value",
"example": "Second Choice",
"description": "The value to segment a text merge field with."
},
"condition_type": {
"enum": [
"SelectMerge"
],
"type": "string",
"x-value": "SelectMerge"
}
},
"description": "An individual segment condition"
},
{
"type": "object",
"title": "Text or Number Merge Field Segment",
"required": [
"field",
"op"
],
"properties": {
"op": {
"enum": [
"is",
"not",
"contains",
"notcontain",
"starts",
"ends",
"greater",
"less",
"blank",
"blank_not"
],
"type": "string",
"title": "Segment Operator",
"example": "contains",
"description": "Whether the member's merge information is/is not, contains/does not contain, starts/ends with, or is greater/less than a value"
},
"field": {
"type": "string",
"title": "Segment Field",
"example": "MMERGE7",
"description": "A text or number merge field to segment."
},
"value": {
"type": "string",
"title": "Segment Value",
"example": "Freddie's Jokes",
"description": "The value to segment a text or number merge field with."
},
"condition_type": {
"enum": [
"TextMerge"
],
"type": "string",
"x-value": "TextMerge"
}
},
"description": "Segment by a given text or number merge field."
},
{
"type": "object",
"title": "Email Segment",
"required": [
"field",
"op"
],
"properties": {
"op": {
"enum": [
"is",
"not",
"contains",
"notcontain",
"starts",
"ends",
"greater",
"less"
],
"type": "string",
"title": "Segment Operator",
"description": "Whether the email address is/not exactly, contains/doesn't contain, starts/ends with a string."
},
"field": {
"enum": [
"merge0",
"EMAIL"
],
"type": "string",
"title": "Segment Field",
"example": "EMAIL",
"description": "Segmenting based off of a subscriber's email address."
},
"value": {
"type": "string",
"title": "Segment Value",
"example": "urist.mcvankab@freddiesjokes.com",
"description": "The value to compare the email against."
},
"condition_type": {
"enum": [
"EmailAddress"
],
"type": "string",
"x-value": "EmailAddress"
}
},
"description": "Segment by email address."
},
{
"type": "object",
"title": "Predicted Gender Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"is",
"not"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Members who are/not the exact criteria listed."
},
"field": {
"enum": [
"predicted_gender"
],
"type": "string",
"title": "Segment Field",
"description": "Segment by predicted gender."
},
"value": {
"enum": [
"male",
"female"
],
"type": "string",
"title": "Segment Operator",
"example": "female",
"description": "The predicted gender to segment."
},
"condition_type": {
"enum": [
"PredictedGender"
],
"type": "string",
"x-value": "PredictedGender"
}
},
"description": "Segment by predicted gender."
},
{
"type": "object",
"title": "Predicted Age Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"is"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Members who are/not the exact criteria listed."
},
"field": {
"enum": [
"predicted_age_range"
],
"type": "string",
"title": "Segment Field",
"description": "Segment by predicted age."
},
"value": {
"enum": [
"18-24",
"25-34",
"35-44",
"45-54",
"55-64",
"65+"
],
"type": "string",
"title": "Segment Operator",
"example": "female",
"description": "The predicted age to segment."
},
"condition_type": {
"enum": [
"PredictedAge"
],
"type": "string",
"x-value": "PredictedAge"
}
},
"description": "Segment by predicted age."
},
{
"type": "object",
"title": "New Subscribers Prebuilt Segment",
"properties": {
"op": {
"enum": [
"date_within"
],
"type": "string",
"title": "Segment Operator",
"description": "Whe the event took place, namely within a time frame."
},
"field": {
"enum": [
"timestamp_opt"
],
"type": "string",
"title": "Segment Field",
"description": "Segment by when people subscribed."
},
"value": {
"type": "string",
"title": "Segment Data",
"description": "What type of data to segment on: a specific date, a specific campaign, or the last campaign sent."
},
"condition_type": {
"enum": [
"NewSubscribers"
],
"type": "string",
"x-value": "NewSubscribers"
}
},
"description": "Segment by when people subscribed."
}
],
"discriminator": {
"type": "string",
"propertyName": "condition_type"
}
},
"title": "Segment Type",
"description": "Segment match conditions. There are multiple possible types, see the [condition types documentation](https://mailchimp.com/developer/marketing/docs/alternative-schemas/#segment-condition-schemas)."
},
"saved_segment_id": {
"type": "integer",
"title": "Saved Segment ID",
"description": "The id for an existing saved segment."
},
"prebuilt_segment_id": {
"type": "string",
"title": "Prebuilt Segment Id",
"example": "subscribers-female",
"description": "The prebuilt segment id, if a prebuilt segment has been designated for this campaign."
}
},
"description": "An object representing all segmentation options. This object should contain a `saved_segment_id` to use an existing segment, or you can create a new segment by including both `match` and `conditions` options."
},
"segment_text": {
"type": "string",
"title": "Segment Text",
"readOnly": true,
"description": "A description of the [segment](https://mailchimp.com/help/getting-started-with-groups/) used for the campaign. Formatted as a string marked up with HTML."
},
"list_is_active": {
"type": "boolean",
"title": "List Status",
"readOnly": true,
"description": "The status of the list used, namely if it's deleted or disabled."
},
"recipient_count": {
"type": "integer",
"title": "Recipient Count",
"readOnly": true,
"description": "Count of the recipients on the associated list. Formatted as an integer."
}
},
"description": "List settings for the campaign."
},
"start_time": {
"type": "string",
"title": "Start Time",
"format": "date-time",
"readOnly": true,
"description": "The date and time the campaign was started in ISO 8601 format."
},
"archive_url": {
"type": "string",
"title": "Archive URL",
"readOnly": true,
"description": "The link to the campaign's archive version in ISO 8601 format."
},
"create_time": {
"type": "string",
"title": "Create Time",
"format": "date-time",
"readOnly": true,
"description": "The date and time the campaign was created in ISO 8601 format."
},
"emails_sent": {
"type": "integer",
"title": "Emails Sent",
"readOnly": true,
"description": "The total number of emails sent for this campaign."
},
"social_card": {
"type": "object",
"title": "Campaign Social Card",
"properties": {
"title": {
"type": "string",
"title": "Title",
"description": "The title for the card. Typically the subject line of the campaign."
},
"image_url": {
"type": "string",
"title": "Image URL",
"description": "The url for the header image for the card."
},
"description": {
"type": "string",
"title": "Campaign Description",
"description": "A short summary of the campaign to display."
}
},
"description": "The preview for the campaign, rendered by social networks like Facebook and Twitter. [Learn more](https://mailchimp.com/help/enable-and-customize-social-cards/)."
},
"workflow_id": {
"type": "string",
"title": "Workflow ID",
"readOnly": true,
"description": "A string that uniquely identifies an Automation workflow."
},
"content_type": {
"type": "string",
"title": "Content Type",
"readOnly": true,
"description": "How the campaign's content is put together ('template', 'drag_and_drop', 'html', 'url')."
},
"report_summary": {
"type": "object",
"title": "Campaign Report Summary",
"properties": {
"opens": {
"type": "integer",
"title": "Automation Opens",
"readOnly": true,
"description": "The total number of opens for a campaign."
},
"clicks": {
"type": "integer",
"title": "Total Clicks",
"readOnly": true,
"description": "The total number of clicks for an campaign."
},
"open_rate": {
"type": "number",
"title": "Open Rate",
"readOnly": true,
"description": "The number of unique opens divided by the total number of successful deliveries."
},
"click_rate": {
"type": "number",
"title": "Click Rate",
"readOnly": true,
"description": "The number of unique clicks divided by the total number of successful deliveries."
},
"unique_opens": {
"type": "integer",
"title": "Unique Opens",
"readOnly": true,
"description": "The number of unique opens."
},
"subscriber_clicks": {
"type": "integer",
"title": "Unique Subscriber Clicks",
"readOnly": true,
"description": "The number of unique clicks."
}
},
"description": "For sent campaigns, a summary of opens and clicks."
},
"trigger_settings": {
"type": "object",
"title": "Automation Trigger",
"required": [
"workflow_type"
],
"properties": {
"runtime": {
"type": "object",
"title": "Automation Workflow Runtime Settings",
"properties": {
"days": {
"type": "array",
"items": {
"enum": [
"sunday",
"monday",
"tuesday",
"wednesday",
"thursday",
"friday",
"saturday"
],
"type": "string"
},
"title": "Days",
"description": "The days an Automation workflow can send."
},
"hours": {
"type": "object",
"title": "Hours",
"required": [
"type"
],
"properties": {
"type": {
"enum": [
"send_asap",
"send_between",
"send_at"
],
"type": "string",
"title": "Email Send Time Settings",
"description": "When to send the Automation email."
}
},
"description": "The hours an Automation workflow can send."
}
},
"description": "A workflow's runtime settings for an Automation."
},
"workflow_type": {
"enum": [
"abandonedBrowse",
"abandonedCart",
"api",
"bestCustomers",
"categoryFollowup",
"dateAdded",
"emailFollowup",
"emailSeries",
"groupAdd",
"groupRemove",
"mandrill",
"productFollowup",
"purchaseFollowup",
"recurringEvent",
"specialEvent",
"visitUrl",
"welcomeSeries"
],
"type": "string",
"title": "Workflow Type",
"description": "The type of Automation workflow."
},
"workflow_title": {
"type": "string",
"title": "Workflow Title",
"readOnly": true,
"description": "The title of the workflow type."
},
"workflow_emails_count": {
"type": "integer",
"title": "Workflow Emails Count",
"readOnly": true,
"description": "The number of emails in the Automation workflow."
}
},
"description": "Available triggers for Automation workflows.",
"discriminator": {
"propertyName": "workflow_type"
}
},
"has_logo_merge_tag": {
"type": "boolean",
"title": "Has Logo Merge Tag",
"example": true,
"readOnly": true,
"description": "Determines if the campaign contains the *|BRAND:LOGO|* merge tag."
},
"needs_block_refresh": {
"type": "boolean",
"title": "Needs Block Refresh",
"example": true,
"readOnly": true,
"description": "Determines if the automation email needs its blocks refreshed by opening the web-based campaign editor."
}
},
"description": "A summary of an individual Automation workflow email."
},
"title": "Emails",
"description": "An array of objects, each representing an email in an Automation workflow."
},
"total_items": {
"type": "integer",
"title": "Item Count",
"readOnly": true,
"description": "The total number of items matching the query regardless of pagination."
}
},
"description": "A summary of the emails in an Automation workflow."
}
AutomationsGetClassicWorkflowEmailsdefaultResponse
{
"type": "object",
"title": "Problem Detail Document",
"required": [
"type",
"title",
"status",
"detail",
"instance"
],
"properties": {
"type": {
"type": "string",
"title": "Problem Type",
"example": "https://mailchimp.com/developer/marketing/docs/errors/",
"description": "An absolute URI that identifies the problem type. When dereferenced, it should provide human-readable documentation for the problem type."
},
"title": {
"type": "string",
"title": "Error Title",
"example": "Resource Not Found",
"description": "A short, human-readable summary of the problem type. It shouldn't change based on the occurrence of the problem, except for purposes of localization."
},
"detail": {
"type": "string",
"title": "Error Message",
"example": "The requested resource could not be found.",
"description": "A human-readable explanation specific to this occurrence of the problem. [Learn more about errors](https://mailchimp.com/developer/)."
},
"status": {
"type": "integer",
"title": "HTTP Status Code",
"example": 404,
"description": "The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem."
},
"instance": {
"type": "string",
"title": "Instance ID",
"example": "995c5cb0-3280-4a6e-808b-3b096d0bb219",
"description": "A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support."
}
},
"description": "An error generated by the Mailchimp API. Conforms to IETF draft 'draft-nottingham-http-problem-06'."
}
AutomationsGetClassicWorkflowInfo200Response
{
"type": "object",
"title": "Automation Workflow",
"properties": {
"id": {
"type": "string",
"title": "Automation Campaign ID",
"readOnly": true,
"description": "A string that identifies the Automation."
},
"_links": {
"type": "array",
"items": {
"type": "object",
"title": "Resource Link",
"properties": {
"rel": {
"type": "string",
"title": "Rel",
"readOnly": true,
"description": "As with an HTML 'rel' attribute, this describes the type of link."
},
"href": {
"type": "string",
"title": "Href",
"readOnly": true,
"description": "This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action."
},
"method": {
"enum": [
"GET",
"POST",
"PUT",
"PATCH",
"DELETE",
"OPTIONS",
"HEAD"
],
"type": "string",
"title": "Method",
"readOnly": true,
"description": "The HTTP method that should be used when accessing the URL defined in 'href'."
},
"schema": {
"type": "string",
"title": "Schema",
"readOnly": true,
"description": "For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to."
},
"targetSchema": {
"type": "string",
"title": "Target Schema",
"readOnly": true,
"description": "For GETs, this is a URL representing the schema that the response should conform to."
}
},
"description": "This object represents a link from the resource where it is found to another resource or action that may be performed."
},
"title": "Links",
"readOnly": true,
"description": "A list of link types and descriptions for the API schema documents."
},
"status": {
"enum": [
"save",
"paused",
"sending"
],
"type": "string",
"title": "Automation Status",
"readOnly": true,
"description": "The current status of the Automation."
},
"settings": {
"type": "object",
"title": "Automation Campaign Settings",
"properties": {
"title": {
"type": "string",
"title": "Automation Title",
"description": "The title of the Automation."
},
"to_name": {
"type": "string",
"title": "To Name",
"description": "The Automation's custom 'To' name, typically the first name [audience field](https://mailchimp.com/help/getting-started-with-merge-tags/)."
},
"reply_to": {
"type": "string",
"title": "Reply To Address",
"description": "The reply-to email address for the Automation."
},
"from_name": {
"type": "string",
"title": "From Name",
"description": "The 'from' name for the Automation (not an email address)."
},
"inline_css": {
"type": "boolean",
"title": "Inline CSS",
"description": "Whether to automatically inline the CSS included with the Automation content."
},
"auto_footer": {
"type": "boolean",
"title": "Auto-Footer",
"description": "Whether to automatically append Mailchimp's [default footer](https://mailchimp.com/help/about-campaign-footers/) to the Automation."
},
"authenticate": {
"type": "boolean",
"title": "Authentication",
"description": "Whether Mailchimp [authenticated](https://mailchimp.com/help/about-email-authentication/) the Automation. Defaults to `true`."
},
"use_conversation": {
"type": "boolean",
"title": "Conversations",
"description": "Whether to use Mailchimp Conversation feature to manage replies"
}
},
"description": "The settings for the Automation workflow."
},
"tracking": {
"type": "object",
"title": "Automation Tracking Options",
"properties": {
"opens": {
"type": "boolean",
"title": "Opens",
"description": "Whether to [track opens](https://mailchimp.com/help/about-open-tracking/). Defaults to `true`."
},
"capsule": {
"type": "object",
"title": "Capsule CRM Tracking",
"properties": {
"notes": {
"type": "boolean",
"title": "Capsule Note",
"description": "Update contact notes for a campaign based on a subscriber's email addresses."
}
},
"description": "Deprecated"
},
"ecomm360": {
"type": "boolean",
"title": "E-commerce Tracking",
"description": "Whether to enable e-commerce tracking."
},
"clicktale": {
"type": "string",
"title": "ClickTale Analytics Tracking",
"description": "The custom slug for [ClickTale](https://mailchimp.com/help/additional-tracking-options-for-campaigns/) tracking (max of 50 bytes)."
},
"salesforce": {
"type": "object",
"title": "Salesforce CRM Tracking",
"properties": {
"notes": {
"type": "boolean",
"title": "Salesforce Note",
"description": "Update contact notes for a campaign based on a subscriber's email address."
},
"campaign": {
"type": "boolean",
"title": "Salesforce Campaign",
"description": "Create a campaign in a connected Salesforce account."
}
},
"description": "Deprecated"
},
"html_clicks": {
"type": "boolean",
"title": "HTML Click Tracking",
"description": "Whether to [track clicks](https://mailchimp.com/help/enable-and-view-click-tracking/) in the HTML version of the Automation. Defaults to `true`."
},
"text_clicks": {
"type": "boolean",
"title": "Plain-Text Click Tracking",
"description": "Whether to [track clicks](https://mailchimp.com/help/enable-and-view-click-tracking/) in the plain-text version of the Automation. Defaults to `true`."
},
"goal_tracking": {
"type": "boolean",
"title": "Mailchimp Goal Tracking",
"description": "Deprecated"
},
"google_analytics": {
"type": "string",
"title": "Google Analytics Tracking",
"description": "The custom slug for [Google Analytics](https://mailchimp.com/help/integrate-google-analytics-with-mailchimp/) tracking (max of 50 bytes)."
}
},
"description": "The tracking options for the Automation."
},
"recipients": {
"type": "object",
"title": "List",
"properties": {
"list_id": {
"type": "string",
"title": "List ID",
"description": "The unique list id."
},
"store_id": {
"type": "string",
"title": "Store ID",
"example": "1a2df69xxx",
"description": "The id of the store."
},
"list_name": {
"type": "string",
"title": "List Name",
"description": "List Name."
},
"segment_opts": {
"type": "object",
"title": "Segment Options",
"properties": {
"match": {
"enum": [
"any",
"all"
],
"type": "string",
"title": "Match Type",
"description": "Segment match type."
},
"conditions": {
"type": "array",
"items": {
"oneOf": [
{
"type": "object",
"title": "Aim Segment",
"properties": {
"op": {
"enum": [
"open",
"click",
"sent",
"noopen",
"noclick",
"nosent"
],
"type": "string",
"title": "Segment Operator",
"example": "open",
"description": "The status of the member with regard to their campaign interaction. One of the following: opened, clicked, was sent, didn't open, didn't click, or was not sent."
},
"field": {
"enum": [
"aim"
],
"type": "string",
"title": "Segment Field",
"example": "aim",
"description": "Segment by interaction with a specific campaign."
},
"value": {
"type": "string",
"title": "Segment Data",
"example": "any",
"description": "Either the web id value for a specific campaign or 'any' to account for subscribers who have/have not interacted with any campaigns."
},
"condition_type": {
"enum": [
"Aim"
],
"type": "string",
"x-value": "Aim"
}
},
"description": "Segment by interaction with a specific campaign."
},
{
"type": "object",
"title": "Automation Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"started",
"completed",
"not_started",
"not_completed"
],
"type": "string",
"title": "Segment Operator",
"example": "started",
"description": "The status of the member with regard to the automation workflow. One of the following: has started the workflow, has completed the workflow, has not started the workflow, or has not completed the workflow."
},
"field": {
"enum": [
"automation"
],
"type": "string",
"title": "Segment Field",
"example": "automation",
"description": "Segment by interaction with an Automation workflow."
},
"value": {
"type": "string",
"title": "Segment Data",
"example": "2135217",
"description": "The web id for the automation workflow to segment against."
},
"condition_type": {
"enum": [
"Automation"
],
"type": "string",
"x-value": "Automation"
}
},
"description": "Segment by interaction with an Automation workflow."
},
{
"type": "object",
"title": "Poll Activity Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"member",
"notmember"
],
"type": "string",
"title": "Segment Operator",
"example": "member",
"description": "Members have/have not interacted with a specific poll in a Mailchimp email."
},
"field": {
"enum": [
"poll"
],
"type": "string",
"title": "Segment Field",
"example": "poll",
"description": "Segment by poll activity."
},
"value": {
"type": "number",
"title": "Segment Operator",
"example": 409,
"description": "The id for the poll."
},
"condition_type": {
"enum": [
"CampaignPoll"
],
"type": "string",
"x-value": "CampaignPoll"
}
},
"description": "Segment by poll activity."
},
{
"type": "object",
"title": "Conversation Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"member",
"notmember"
],
"type": "string",
"title": "Segment Operator",
"example": "member",
"description": "The status of a member's interaction with a conversation. One of the following: has replied or has not replied."
},
"field": {
"enum": [
"conversation"
],
"type": "string",
"title": "Segment Field",
"example": "conversation",
"description": "Segment by interaction with a campaign via Conversations."
},
"value": {
"type": "string",
"title": "Segment Data",
"example": "any",
"description": "The web id value for a specific campaign or 'any' to account for subscribers who have/have not interacted with any campaigns."
},
"condition_type": {
"enum": [
"Conversation"
],
"type": "string",
"x-value": "Conversation"
}
},
"description": "Segment by interaction with a campaign via Conversations."
},
{
"type": "object",
"title": "Date Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"greater",
"less",
"is",
"not",
"blank",
"blank_not",
"within",
"notwithin"
],
"type": "string",
"title": "Segment Operator",
"example": "greater",
"description": "When the event took place: Before, after, is a specific date, is not a specific date, is blank, or is not blank."
},
"extra": {
"type": "string",
"title": "Segment Extra Value",
"example": "2015-01-30",
"description": "When segmenting on 'date' or 'campaign', the date for the segment formatted as YYYY-MM-DD or the web id for the campaign."
},
"field": {
"enum": [
"timestamp_opt",
"info_changed",
"ecomm_date"
],
"type": "string",
"title": "Segment Field",
"example": "timestamp_opt",
"description": "The type of date field to segment on: The opt-in time for a signup, the date the subscriber was last updated, or the date of their last ecomm purchase."
},
"value": {
"type": "string",
"title": "Segment Data",
"example": "date",
"description": "What type of data to segment on: a specific date, a specific campaign, or the last campaign sent."
},
"condition_type": {
"enum": [
"Date"
],
"type": "string",
"x-value": "Date"
}
},
"description": "Segment by a specific date field."
},
{
"type": "object",
"title": "Email Client Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"client_is",
"client_not"
],
"type": "string",
"title": "Segment Operator",
"example": "client_is",
"description": "The operation to determine whether we select clients that match the value, or clients that do not match the value."
},
"field": {
"enum": [
"email_client"
],
"type": "string",
"title": "Segment Field",
"example": "email_client",
"description": "Segment by use of a particular email client."
},
"value": {
"type": "string",
"title": "Segment Data",
"example": "Gmail",
"description": "The name of the email client."
},
"condition_type": {
"enum": [
"EmailClient"
],
"type": "string",
"x-value": "EmailClient"
}
},
"description": "Segment by use of a particular email client."
},
{
"type": "object",
"title": "Language Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"is",
"not"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Whether the member's language is or is not set to a specific language."
},
"field": {
"enum": [
"language"
],
"type": "string",
"title": "Segment Field",
"example": "language",
"description": "Segmenting based off of a subscriber's language."
},
"value": {
"type": "string",
"title": "Segment Data",
"example": "en",
"description": "A two-letter language identifier."
},
"condition_type": {
"enum": [
"Language"
],
"type": "string",
"x-value": "Language"
}
},
"description": "Segment by language."
},
{
"type": "object",
"title": "Member Rating Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"is",
"not",
"greater",
"less"
],
"type": "string",
"title": "Segment Operator",
"example": "greater",
"description": "Members who have have a rating that is/not exactly a given number or members who have a rating greater/less than a given number."
},
"field": {
"enum": [
"rating"
],
"type": "string",
"title": "Segment Field",
"example": "rating",
"description": "Segment by member rating."
},
"value": {
"type": "number",
"title": "Segment Operator",
"example": 4,
"description": "The star rating number to segment against."
},
"condition_type": {
"enum": [
"MemberRating"
],
"type": "string",
"x-value": "MemberRating"
}
},
"description": "Segment by member rating."
},
{
"type": "object",
"title": "Signup Source Segment",
"required": [
"field",
"condition_type",
"op"
],
"properties": {
"op": {
"enum": [
"source_is",
"source_not"
],
"type": "string",
"title": "Segment Operator",
"example": "source_is",
"description": "Whether the member's signup source was/was not a particular value."
},
"field": {
"enum": [
"source"
],
"type": "string",
"title": "Segment Field",
"example": "source"
},
"value": {
"type": "string",
"title": "Segment Data",
"example": "List Import",
"description": "The signup source."
},
"condition_type": {
"enum": [
"SignupSource"
],
"type": "string",
"title": "Type",
"x-value": "SignupSource"
}
},
"description": "Segment by signup source."
},
{
"type": "object",
"title": "Survey Monkey Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"started",
"completed",
"not_started",
"not_completed"
],
"type": "string",
"title": "Segment Operator",
"example": "started",
"description": "The status of the member with regard to the survey.One of the following: has started the survey, has completed the survey, has not started the survey, or has not completed the survey."
},
"field": {
"enum": [
"survey_monkey"
],
"type": "string",
"title": "Segment Field",
"example": "survey_monkey",
"description": "Segment by interaction with a SurveyMonkey survey."
},
"value": {
"type": "string",
"title": "Survey ID",
"example": "32179586",
"description": "The unique ID of the survey monkey survey."
},
"condition_type": {
"enum": [
"SurveyMonkey"
],
"type": "string",
"x-value": "SurveyMonkey"
}
},
"description": "Segment by interaction with a SurveyMonkey survey."
},
{
"type": "object",
"title": "VIP Segment",
"required": [
"field",
"op"
],
"properties": {
"op": {
"enum": [
"member",
"notmember"
],
"type": "string",
"title": "Segment Operator",
"example": "member",
"description": "Whether the member is or is not marked as VIP."
},
"field": {
"enum": [
"gmonkey"
],
"type": "string",
"title": "Segment Field",
"example": "gmonkey",
"description": "Segment by VIP status."
},
"condition_type": {
"enum": [
"VIP"
],
"type": "string",
"x-value": "VIP"
}
},
"description": "Segment by VIP status."
},
{
"type": "object",
"title": "Interests Segment",
"properties": {
"op": {
"enum": [
"interestcontains",
"interestcontainsall",
"interestnotcontains"
],
"type": "string",
"title": "Segment Operator",
"example": "interestcontains",
"description": "Whether the member is a part of one, all, or none of the groups."
},
"field": {
"type": "string",
"title": "Segment Field",
"example": "interests-123",
"description": "Segmenting based on interest group information. This should start with 'interests-' followed by the grouping id. Ex. 'interests-123'."
},
"value": {
"type": "array",
"items": {
"type": "string",
"example": [
"44401",
"44405",
"44409"
]
},
"title": "Segment Value",
"description": "An array containing strings, each representing a group id."
},
"condition_type": {
"enum": [
"Interests"
],
"type": "string",
"x-value": "Interests"
}
},
"description": "Segment by an interest group merge field."
},
{
"type": "object",
"title": "Ecommerce Category Segment",
"properties": {
"op": {
"enum": [
"is",
"not",
"contains",
"notcontain",
"starts",
"ends"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "A member who has purchased from a category/specific item that is/is not a specific name, where the category/item name contains/doesn't contain a specific phrase or string, or a category/item name that starts/ends with a string."
},
"field": {
"enum": [
"ecomm_cat",
"ecomm_prod"
],
"type": "string",
"title": "Segment Field",
"example": "ecomm_cat",
"description": "Segment by purchases in specific items or categories."
},
"value": {
"type": "string",
"title": "Segment Data",
"example": "Product",
"description": "The ecommerce category/item information."
},
"condition_type": {
"enum": [
"EcommCategory"
],
"type": "string",
"x-value": "EcommCategory"
}
},
"description": "Segment by purchases in specific items or categories."
},
{
"type": "object",
"title": "Ecommerce Number Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"is",
"not",
"greater",
"less"
],
"type": "string",
"title": "Segment Operator",
"example": "greater",
"description": "Members who have spent exactly, have not spent exactly, spent more, or spent less than the segment value."
},
"field": {
"enum": [
"ecomm_spent_avg",
"ecomm_orders",
"ecomm_prod_all",
"ecomm_avg_ord"
],
"type": "string",
"title": "Segment Field",
"example": "ecomm_orders",
"description": "Segment by average spent total, number of orders, total number of products purchased, or average number of products per order."
},
"value": {
"type": "number",
"title": "Segment Operator",
"example": 42,
"description": "Members who have spent exactly, have not spent exactly, spent more, or spent less than this amount."
},
"condition_type": {
"enum": [
"EcommNumber"
],
"type": "string",
"x-value": "EcommNumber"
}
},
"description": "Segment by average spent total, number of orders, total number of products purchased, or average number of products per order."
},
{
"type": "object",
"title": "Ecommerce Purchased Segment",
"properties": {
"op": {
"enum": [
"member",
"notmember"
],
"type": "string",
"title": "Segment Operator",
"example": "member",
"description": "Members who have have ('member') or have not ('notmember') purchased."
},
"field": {
"enum": [
"ecomm_purchased"
],
"type": "string",
"title": "Segment Field",
"example": "ecomm_purchased",
"description": "Segment by whether someone has purchased anything."
},
"condition_type": {
"enum": [
"EcommPurchased"
],
"type": "string",
"x-value": "EcommPurchased"
}
},
"description": "Segment by whether someone has purchased anything."
},
{
"type": "object",
"title": "Ecommerce Spent Segment",
"properties": {
"op": {
"enum": [
"greater",
"less"
],
"type": "string",
"title": "Segment Operator",
"example": "greater",
"description": "Members who have spent 'more' or 'less' than then specified value."
},
"field": {
"enum": [
"ecomm_spent_one",
"ecomm_spent_all"
],
"type": "string",
"title": "Segment Field",
"example": "ecomm_spent_one",
"description": "Segment by amount spent on a single order or across all orders."
},
"value": {
"type": "integer",
"title": "Segment Data",
"example": 42,
"description": "The total amount a member spent."
},
"condition_type": {
"enum": [
"EcommSpent"
],
"type": "string",
"x-value": "EcommSpent"
}
},
"description": "Segment by amount spent on a single order or across all orders."
},
{
"type": "object",
"title": "Ecommerce Purchased Store Segment",
"properties": {
"op": {
"enum": [
"is",
"not"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Members who have or have not purchased from a specific store."
},
"field": {
"enum": [
"ecomm_store"
],
"type": "string",
"title": "Segment Field",
"example": "ecomm_store",
"description": "Segment by purchases from a specific store."
},
"value": {
"type": "string",
"title": "Segment Operator",
"example": "289",
"description": "The store id to segment against."
},
"condition_type": {
"enum": [
"EcommStore"
],
"type": "string",
"x-value": "EcommStore"
}
},
"description": "Segment by purchases from a specific store."
},
{
"type": "object",
"title": "Goal Activity Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"is",
"goal_not",
"contains",
"goal_notcontain",
"starts",
"ends"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Whether the website URL is/not exactly, contains/doesn't contain, starts with/ends with a string."
},
"field": {
"enum": [
"goal"
],
"type": "string",
"title": "Segment Field",
"example": "goal",
"description": "Segment by Goal activity."
},
"value": {
"type": "string",
"title": "Segment Value",
"description": "The URL to check Goal activity against."
},
"condition_type": {
"enum": [
"GoalActivity"
],
"type": "string",
"x-value": "GoalActivity"
}
},
"description": "Segment by Goal activity."
},
{
"type": "object",
"title": "Goal Timestamp Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"greater",
"less",
"is"
],
"type": "string",
"title": "Segment Operator",
"example": "greater",
"description": "Whether the website activity happened after, before, or at a given timestamp."
},
"field": {
"enum": [
"goal_last_visited"
],
"type": "string",
"title": "Segment Field",
"example": "goal_last_visited",
"description": "Segment by most recent interaction with a website."
},
"value": {
"type": "string",
"title": "Segment Value",
"example": "2015-07-20 19:45:21",
"description": "The date to check Goal activity against."
},
"condition_type": {
"enum": [
"GoalTimestamp"
],
"type": "string",
"x-value": "GoalTimestamp"
}
},
"description": "Segment by most recent interaction with a website."
},
{
"type": "object",
"title": "Similar Subscribers Segment Member Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"fuzzy_is",
"fuzzy_not"
],
"type": "string",
"title": "Segment Operator",
"example": "fuzzy_is",
"description": "Members who are/are not apart of a 'similar subscribers' segment."
},
"field": {
"enum": [
"fuzzy_segment"
],
"type": "string",
"title": "Segment Field",
"example": "fuzzy_segment",
"description": "Segment by similar subscribers."
},
"value": {
"type": "number",
"title": "Segment Operator",
"example": 48433,
"description": "The id for the 'similar subscribers' segment."
},
"condition_type": {
"enum": [
"FuzzySegment"
],
"type": "string",
"x-value": "FuzzySegment"
}
},
"description": "Segment by similar subscribers."
},
{
"type": "object",
"title": "Static Segment Member Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"static_is",
"static_not"
],
"type": "string",
"title": "Segment Operator",
"example": "static_is",
"description": "Members who are/are not apart of a static segment."
},
"field": {
"enum": [
"static_segment"
],
"type": "string",
"title": "Segment Field",
"example": "static_segment",
"description": "Segment by a given static segment."
},
"value": {
"type": "number",
"title": "Segment Operator",
"example": 48433,
"description": "The id for the static segment."
},
"condition_type": {
"enum": [
"StaticSegment"
],
"type": "string",
"x-value": "StaticSegment"
}
},
"description": "Segment by a given static segment."
},
{
"type": "object",
"title": "Location-Based Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"ipgeocountry",
"ipgeonotcountry",
"ipgeostate",
"ipgeonotstate"
],
"type": "string",
"title": "Segment Operator",
"example": "ipgeocountry",
"description": "Segment members who are within a specific country or US state."
},
"field": {
"enum": [
"ipgeo"
],
"type": "string",
"title": "Segment Field",
"example": "ipgeo",
"description": "Segmenting subscribers who are within a specific location."
},
"value": {
"type": "string",
"title": "Segment Data",
"example": "US",
"description": "The two-letter country code or US state abbreviation."
},
"condition_type": {
"enum": [
"IPGeoCountryState"
],
"type": "string",
"x-value": "IPGeoCountryState"
}
},
"description": "Segment by a specific country or US state."
},
{
"type": "object",
"title": "Geolocation Segment",
"required": [
"field",
"op",
"value",
"addr",
"lat",
"lng"
],
"properties": {
"op": {
"enum": [
"ipgeoin",
"ipgeonotin"
],
"type": "string",
"title": "Segment Operator",
"example": "ipgeoin",
"description": "Segment members who are within a specific geographic region."
},
"lat": {
"type": "string",
"title": "Segment Location Latitude",
"example": "33.7489954",
"description": "The latitude of the target location."
},
"lng": {
"type": "string",
"title": "Segment Location Longitude",
"example": "-84.3879824",
"description": "The longitude of the target location."
},
"addr": {
"type": "string",
"title": "Segment Location Address",
"example": "Atlanta, GA, USA",
"description": "The address of the target location."
},
"field": {
"enum": [
"ipgeo"
],
"type": "string",
"title": "Segment Field",
"example": "ipgeo",
"description": "Segmenting subscribers who are within a specific location."
},
"value": {
"type": "integer",
"title": "Segment Data",
"example": 42,
"description": "The radius of the target location."
},
"condition_type": {
"enum": [
"IPGeoIn"
],
"type": "string",
"x-value": "IPGeoIn"
}
},
"description": "Segment by a specific geographic region."
},
{
"type": "object",
"title": "US Zip Code Segment",
"required": [
"field",
"op",
"value",
"extra"
],
"properties": {
"op": {
"enum": [
"ipgeoinzip"
],
"type": "string",
"title": "Segment Operator",
"example": "ipgeoinzip",
"description": "Segment members who are within a specific US zip code."
},
"extra": {
"type": "integer",
"title": "Extra Data",
"example": 30318,
"description": "The zip code to segment against."
},
"field": {
"enum": [
"ipgeo"
],
"type": "string",
"title": "Segment Field",
"example": "ipgeo",
"description": "Segmenting subscribers who are within a specific location."
},
"value": {
"type": "integer",
"title": "Segment Data",
"example": 25,
"description": "The radius of the target location."
},
"condition_type": {
"enum": [
"IPGeoInZip"
],
"type": "string",
"x-value": "IPGeoInZip"
}
},
"description": "Segment by a specific US ZIP code."
},
{
"type": "object",
"title": "Unknown Location-Based Segment",
"required": [
"field",
"op"
],
"properties": {
"op": {
"enum": [
"ipgeounknown"
],
"type": "string",
"title": "Segment Operator",
"example": "ipgeounknown",
"description": "Segment members for which location information is unknown."
},
"field": {
"enum": [
"ipgeo"
],
"type": "string",
"title": "Segment Field",
"example": "ipgeo",
"description": "Segmenting subscribers who are within a specific location."
},
"condition_type": {
"enum": [
"IPGeoUnknown"
],
"type": "string",
"x-value": "IPGeoUnknown"
}
},
"description": "Segment members whose location information is unknown."
},
{
"type": "object",
"title": "Zip Code Location-Based Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"ipgeoiszip",
"ipgeonotzip"
],
"type": "string",
"title": "Segment Operator",
"example": "ipgeonotzip",
"description": "Segment members who are/are not within a specific US zip code."
},
"field": {
"enum": [
"ipgeo"
],
"type": "string",
"title": "Segment Field",
"example": "ipgeo",
"description": "Segmenting subscribers who are within a specific location."
},
"value": {
"type": "integer",
"title": "Segment Data",
"example": 30318,
"description": "The 5-digit zip code."
},
"condition_type": {
"enum": [
"IPGeoZip"
],
"type": "string",
"x-value": "IPGeoZip"
}
},
"description": "Segment by a specific US ZIP code."
},
{
"type": "object",
"title": "Social Profiles Age Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"is",
"not"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Members who are/not the exact criteria listed."
},
"field": {
"enum": [
"social_age"
],
"type": "string",
"title": "Segment Field",
"example": "social_age",
"description": "Segment by age ranges in Social Profiles data."
},
"value": {
"enum": [
"18-24",
"25-34",
"35-54",
"55+"
],
"type": "string",
"title": "Segment Operator",
"example": "35-54",
"description": "The age range to segment."
},
"condition_type": {
"enum": [
"SocialAge"
],
"type": "string",
"x-value": "SocialAge"
}
},
"description": "Segment by age ranges in Social Profiles data."
},
{
"type": "object",
"title": "Social Profiles Gender Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"is",
"not"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Members who are/not the exact criteria listed."
},
"field": {
"enum": [
"social_gender"
],
"type": "string",
"title": "Segment Field",
"example": "social_gender",
"description": "Segment by listed gender in Social Profiles data."
},
"value": {
"enum": [
"male",
"female"
],
"type": "string",
"title": "Segment Operator",
"example": "female",
"description": "The Social Profiles gender to segment."
},
"condition_type": {
"enum": [
"SocialGender"
],
"type": "string",
"x-value": "SocialGender"
}
},
"description": "Segment by listed gender in Social Profiles data."
},
{
"type": "object",
"title": "Social Profiles Influence Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"is",
"not",
"greater",
"less"
],
"type": "string",
"title": "Segment Operator",
"example": "greater",
"description": "Members who have a rating that is/not or greater/less than the rating provided."
},
"field": {
"enum": [
"social_influence"
],
"type": "string",
"title": "Segment Field",
"example": "social_influence",
"description": "Segment by influence rating in Social Profiles data."
},
"value": {
"type": "number",
"title": "Segment Operator",
"example": 2,
"description": "The Social Profiles influence rating to segment."
},
"condition_type": {
"enum": [
"SocialInfluence"
],
"type": "string",
"x-value": "SocialInfluence"
}
},
"description": "Segment by influence rating in Social Profiles data."
},
{
"type": "object",
"title": "Social Profiles Social Network Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"member",
"notmember"
],
"type": "string",
"title": "Segment Operator",
"example": "member",
"description": "Members who are/not on a given social network."
},
"field": {
"enum": [
"social_network"
],
"type": "string",
"title": "Segment Field",
"example": "social_network",
"description": "Segment by social network in Social Profiles data."
},
"value": {
"enum": [
"twitter",
"facebook",
"linkedin",
"flickr",
"foursquare",
"lastfm",
"myspace",
"quora",
"vimeo",
"yelp",
"youtube"
],
"type": "string",
"title": "Segment Operator",
"example": "twitter",
"description": "The social network to segment against."
},
"condition_type": {
"enum": [
"SocialNetworkMember"
],
"type": "string",
"x-value": "SocialNetworkMember"
}
},
"description": "Segment by social network in Social Profiles data."
},
{
"type": "object",
"title": "Social Profiles Social Network Follow Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"follow",
"notfollow"
],
"type": "string",
"title": "Segment Operator",
"example": "follow",
"description": "Members who are/not following a linked account on a given social network."
},
"field": {
"enum": [
"social_network"
],
"type": "string",
"title": "Segment Field",
"example": "social_network",
"description": "Segment by social network in Social Profiles data."
},
"value": {
"enum": [
"twitter_follow"
],
"type": "string",
"title": "Segment Operator",
"example": "twitter_follow",
"description": "The social network to segment against."
},
"condition_type": {
"enum": [
"SocialNetworkFollow"
],
"type": "string",
"x-value": "SocialNetworkFollow"
}
},
"description": "Segment by social network in Social Profiles data."
},
{
"type": "object",
"title": "Address Merge Field Segment",
"required": [
"field",
"op"
],
"properties": {
"op": {
"enum": [
"contains",
"notcontain",
"blank",
"blank_not"
],
"type": "string",
"title": "Segment Operator",
"example": "contains",
"description": "Whether the member's address merge field contains/does not contain a value or is/is not blank."
},
"field": {
"type": "string",
"title": "Segment Field",
"example": "MMERGE3",
"description": "An address-type merge field to segment."
},
"value": {
"type": "string",
"title": "Segment Value",
"example": "Atlanta",
"description": "The value to segment a text merge field with."
},
"condition_type": {
"enum": [
"AddressMerge"
],
"type": "string",
"x-value": "AddressMerge"
}
},
"description": "Segment by an address-type merge field."
},
{
"type": "object",
"title": "Address/Zip Merge Field Segment",
"required": [
"field",
"op",
"value",
"extra"
],
"properties": {
"op": {
"enum": [
"geoin"
],
"type": "string",
"title": "Segment Operator",
"example": "geoin",
"description": "Whether the member's address merge field is within a given distance from a city or zip."
},
"extra": {
"type": "string",
"title": "Segment Extra",
"example": "30318",
"description": "The city or the zip being used to segment against."
},
"field": {
"type": "string",
"title": "Segment Field",
"example": "MMERGE2",
"description": "An address or zip-type merge field to segment."
},
"value": {
"type": "string",
"title": "Segment Value",
"example": "25",
"description": "The distance from the city/zip."
},
"condition_type": {
"enum": [
"ZipMerge"
],
"type": "string",
"x-value": "ZipMerge"
}
},
"description": "Segment by an address-type merge field within a given distance."
},
{
"type": "object",
"title": "Birthday Merge Field Segment",
"required": [
"field",
"op"
],
"properties": {
"op": {
"enum": [
"is",
"not",
"blank",
"blank_not"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Whether the member's birthday merge information is/is not a certain date or is/is not blank."
},
"field": {
"type": "string",
"title": "Segment Field",
"example": "MMERGE4",
"description": "A date merge field to segment."
},
"value": {
"type": "string",
"title": "Segment Value",
"example": "01/30",
"description": "A date to segment against (mm/dd)."
},
"condition_type": {
"enum": [
"BirthdayMerge"
],
"type": "string",
"x-value": "BirthdayMerge"
}
},
"description": "Segment by a contact's birthday."
},
{
"type": "object",
"title": "Date Merge Field Segment",
"required": [
"field",
"op"
],
"properties": {
"op": {
"enum": [
"is",
"not",
"less",
"blank",
"blank_not",
"greater"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Whether the member's merge information is/is not, is greater/less than a value or is/is not blank."
},
"field": {
"type": "string",
"title": "Segment Field",
"example": "MMERGE5",
"description": "A date merge field to segment."
},
"value": {
"type": "string",
"title": "Segment Value",
"example": "01/30/2015",
"description": "A date to segment against."
},
"condition_type": {
"enum": [
"DateMerge"
],
"type": "string",
"x-value": "DateMerge"
}
},
"description": "Segment by a given date merge field."
},
{
"type": "object",
"title": "Dropdown/Radio Merge Field Segment",
"required": [
"field",
"op"
],
"properties": {
"op": {
"enum": [
"is",
"not",
"blank",
"blank_not",
"notcontain",
"contains"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Whether the member's merge information is/is not a value or is/is not blank."
},
"field": {
"type": "string",
"title": "Segment Field",
"example": "MMERGE6",
"description": "A merge field to segment."
},
"value": {
"type": "string",
"title": "Segment Value",
"example": "Second Choice",
"description": "The value to segment a text merge field with."
},
"condition_type": {
"enum": [
"SelectMerge"
],
"type": "string",
"x-value": "SelectMerge"
}
},
"description": "An individual segment condition"
},
{
"type": "object",
"title": "Text or Number Merge Field Segment",
"required": [
"field",
"op"
],
"properties": {
"op": {
"enum": [
"is",
"not",
"contains",
"notcontain",
"starts",
"ends",
"greater",
"less",
"blank",
"blank_not"
],
"type": "string",
"title": "Segment Operator",
"example": "contains",
"description": "Whether the member's merge information is/is not, contains/does not contain, starts/ends with, or is greater/less than a value"
},
"field": {
"type": "string",
"title": "Segment Field",
"example": "MMERGE7",
"description": "A text or number merge field to segment."
},
"value": {
"type": "string",
"title": "Segment Value",
"example": "Freddie's Jokes",
"description": "The value to segment a text or number merge field with."
},
"condition_type": {
"enum": [
"TextMerge"
],
"type": "string",
"x-value": "TextMerge"
}
},
"description": "Segment by a given text or number merge field."
},
{
"type": "object",
"title": "Email Segment",
"required": [
"field",
"op"
],
"properties": {
"op": {
"enum": [
"is",
"not",
"contains",
"notcontain",
"starts",
"ends",
"greater",
"less"
],
"type": "string",
"title": "Segment Operator",
"description": "Whether the email address is/not exactly, contains/doesn't contain, starts/ends with a string."
},
"field": {
"enum": [
"merge0",
"EMAIL"
],
"type": "string",
"title": "Segment Field",
"example": "EMAIL",
"description": "Segmenting based off of a subscriber's email address."
},
"value": {
"type": "string",
"title": "Segment Value",
"example": "urist.mcvankab@freddiesjokes.com",
"description": "The value to compare the email against."
},
"condition_type": {
"enum": [
"EmailAddress"
],
"type": "string",
"x-value": "EmailAddress"
}
},
"description": "Segment by email address."
},
{
"type": "object",
"title": "Predicted Gender Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"is",
"not"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Members who are/not the exact criteria listed."
},
"field": {
"enum": [
"predicted_gender"
],
"type": "string",
"title": "Segment Field",
"description": "Segment by predicted gender."
},
"value": {
"enum": [
"male",
"female"
],
"type": "string",
"title": "Segment Operator",
"example": "female",
"description": "The predicted gender to segment."
},
"condition_type": {
"enum": [
"PredictedGender"
],
"type": "string",
"x-value": "PredictedGender"
}
},
"description": "Segment by predicted gender."
},
{
"type": "object",
"title": "Predicted Age Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"is"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Members who are/not the exact criteria listed."
},
"field": {
"enum": [
"predicted_age_range"
],
"type": "string",
"title": "Segment Field",
"description": "Segment by predicted age."
},
"value": {
"enum": [
"18-24",
"25-34",
"35-44",
"45-54",
"55-64",
"65+"
],
"type": "string",
"title": "Segment Operator",
"example": "female",
"description": "The predicted age to segment."
},
"condition_type": {
"enum": [
"PredictedAge"
],
"type": "string",
"x-value": "PredictedAge"
}
},
"description": "Segment by predicted age."
},
{
"type": "object",
"title": "New Subscribers Prebuilt Segment",
"properties": {
"op": {
"enum": [
"date_within"
],
"type": "string",
"title": "Segment Operator",
"description": "Whe the event took place, namely within a time frame."
},
"field": {
"enum": [
"timestamp_opt"
],
"type": "string",
"title": "Segment Field",
"description": "Segment by when people subscribed."
},
"value": {
"type": "string",
"title": "Segment Data",
"description": "What type of data to segment on: a specific date, a specific campaign, or the last campaign sent."
},
"condition_type": {
"enum": [
"NewSubscribers"
],
"type": "string",
"x-value": "NewSubscribers"
}
},
"description": "Segment by when people subscribed."
}
],
"discriminator": {
"type": "string",
"propertyName": "condition_type"
}
},
"title": "Segment Type",
"description": "Segment match conditions. There are multiple possible types, see the [condition types documentation](https://mailchimp.com/developer/marketing/docs/alternative-schemas/#segment-condition-schemas)."
},
"saved_segment_id": {
"type": "integer",
"title": "Saved Segment ID",
"description": "The id for an existing saved segment."
}
},
"description": "An object representing all segmentation options."
},
"list_is_active": {
"type": "boolean",
"title": "List Status",
"readOnly": true,
"description": "The status of the list used, namely if it's deleted or disabled."
}
},
"description": "List settings for the Automation."
},
"start_time": {
"type": "string",
"title": "Start Time",
"format": "date-time",
"readOnly": true,
"description": "The date and time the Automation was started in ISO 8601 format."
},
"create_time": {
"type": "string",
"title": "Create Time",
"format": "date-time",
"readOnly": true,
"description": "The date and time the Automation was created in ISO 8601 format."
},
"emails_sent": {
"type": "integer",
"title": "Emails Sent",
"readOnly": true,
"description": "The total number of emails sent for the Automation."
},
"report_summary": {
"type": "object",
"title": "Campaign Report Summary",
"properties": {
"opens": {
"type": "integer",
"title": "Automation Opens",
"readOnly": true,
"description": "The total number of opens for a campaign."
},
"clicks": {
"type": "integer",
"title": "Total Clicks",
"readOnly": true,
"description": "The total number of clicks for an campaign."
},
"open_rate": {
"type": "number",
"title": "Open Rate",
"readOnly": true,
"description": "The number of unique opens divided by the total number of successful deliveries."
},
"click_rate": {
"type": "number",
"title": "Click Rate",
"readOnly": true,
"description": "The number of unique clicks, divided by the total number of successful deliveries."
},
"unique_opens": {
"type": "integer",
"title": "Unique Opens",
"readOnly": true,
"description": "The number of unique opens."
},
"subscriber_clicks": {
"type": "integer",
"title": "Unique Subscriber Clicks",
"readOnly": true,
"description": "The number of unique clicks."
}
},
"description": "A summary of opens and clicks for sent campaigns."
},
"trigger_settings": {
"type": "object",
"title": "Automation Trigger",
"required": [
"workflow_type"
],
"properties": {
"runtime": {
"type": "object",
"title": "Automation Workflow Runtime Settings",
"properties": {
"days": {
"type": "array",
"items": {
"enum": [
"sunday",
"monday",
"tuesday",
"wednesday",
"thursday",
"friday",
"saturday"
],
"type": "string"
},
"title": "Days",
"description": "The days an Automation workflow can send."
},
"hours": {
"type": "object",
"title": "Hours",
"required": [
"type"
],
"properties": {
"type": {
"enum": [
"send_asap",
"send_between",
"send_at"
],
"type": "string",
"title": "Email Send Time Settings",
"description": "When to send the Automation email."
}
},
"description": "The hours an Automation workflow can send."
}
},
"description": "A workflow's runtime settings for an Automation."
},
"workflow_type": {
"enum": [
"abandonedBrowse",
"abandonedCart",
"api",
"bestCustomers",
"categoryFollowup",
"dateAdded",
"emailFollowup",
"emailSeries",
"groupAdd",
"groupRemove",
"mandrill",
"productFollowup",
"purchaseFollowup",
"recurringEvent",
"specialEvent",
"visitUrl",
"welcomeSeries"
],
"type": "string",
"title": "Workflow Type",
"description": "The type of Automation workflow."
},
"workflow_title": {
"type": "string",
"title": "Workflow Title",
"readOnly": true,
"description": "The title of the workflow type."
},
"workflow_emails_count": {
"type": "integer",
"title": "Workflow Emails Count",
"readOnly": true,
"description": "The number of emails in the Automation workflow."
}
},
"description": "Available triggers for Automation workflows.",
"discriminator": {
"propertyName": "workflow_type"
}
}
},
"description": "A summary of an individual Automation workflow's settings and content."
}
AutomationsGetClassicWorkflowInfoResponse
{
"type": "object",
"title": "Automation Workflow",
"properties": {
"id": {
"type": "string",
"title": "Automation Campaign ID",
"readOnly": true,
"description": "A string that identifies the Automation."
},
"_links": {
"type": "array",
"items": {
"type": "object",
"title": "Resource Link",
"properties": {
"rel": {
"type": "string",
"title": "Rel",
"readOnly": true,
"description": "As with an HTML 'rel' attribute, this describes the type of link."
},
"href": {
"type": "string",
"title": "Href",
"readOnly": true,
"description": "This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action."
},
"method": {
"enum": [
"GET",
"POST",
"PUT",
"PATCH",
"DELETE",
"OPTIONS",
"HEAD"
],
"type": "string",
"title": "Method",
"readOnly": true,
"description": "The HTTP method that should be used when accessing the URL defined in 'href'."
},
"schema": {
"type": "string",
"title": "Schema",
"readOnly": true,
"description": "For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to."
},
"targetSchema": {
"type": "string",
"title": "Target Schema",
"readOnly": true,
"description": "For GETs, this is a URL representing the schema that the response should conform to."
}
},
"description": "This object represents a link from the resource where it is found to another resource or action that may be performed."
},
"title": "Links",
"readOnly": true,
"description": "A list of link types and descriptions for the API schema documents."
},
"status": {
"enum": [
"save",
"paused",
"sending"
],
"type": "string",
"title": "Automation Status",
"readOnly": true,
"description": "The current status of the Automation."
},
"settings": {
"type": "object",
"title": "Automation Campaign Settings",
"properties": {
"title": {
"type": "string",
"title": "Automation Title",
"description": "The title of the Automation."
},
"to_name": {
"type": "string",
"title": "To Name",
"description": "The Automation's custom 'To' name, typically the first name [audience field](https://mailchimp.com/help/getting-started-with-merge-tags/)."
},
"reply_to": {
"type": "string",
"title": "Reply To Address",
"description": "The reply-to email address for the Automation."
},
"from_name": {
"type": "string",
"title": "From Name",
"description": "The 'from' name for the Automation (not an email address)."
},
"inline_css": {
"type": "boolean",
"title": "Inline CSS",
"description": "Whether to automatically inline the CSS included with the Automation content."
},
"auto_footer": {
"type": "boolean",
"title": "Auto-Footer",
"description": "Whether to automatically append Mailchimp's [default footer](https://mailchimp.com/help/about-campaign-footers/) to the Automation."
},
"authenticate": {
"type": "boolean",
"title": "Authentication",
"description": "Whether Mailchimp [authenticated](https://mailchimp.com/help/about-email-authentication/) the Automation. Defaults to `true`."
},
"use_conversation": {
"type": "boolean",
"title": "Conversations",
"description": "Whether to use Mailchimp Conversation feature to manage replies"
}
},
"description": "The settings for the Automation workflow."
},
"tracking": {
"type": "object",
"title": "Automation Tracking Options",
"properties": {
"opens": {
"type": "boolean",
"title": "Opens",
"description": "Whether to [track opens](https://mailchimp.com/help/about-open-tracking/). Defaults to `true`."
},
"capsule": {
"type": "object",
"title": "Capsule CRM Tracking",
"properties": {
"notes": {
"type": "boolean",
"title": "Capsule Note",
"description": "Update contact notes for a campaign based on a subscriber's email addresses."
}
},
"description": "Deprecated"
},
"ecomm360": {
"type": "boolean",
"title": "E-commerce Tracking",
"description": "Whether to enable e-commerce tracking."
},
"clicktale": {
"type": "string",
"title": "ClickTale Analytics Tracking",
"description": "The custom slug for [ClickTale](https://mailchimp.com/help/additional-tracking-options-for-campaigns/) tracking (max of 50 bytes)."
},
"salesforce": {
"type": "object",
"title": "Salesforce CRM Tracking",
"properties": {
"notes": {
"type": "boolean",
"title": "Salesforce Note",
"description": "Update contact notes for a campaign based on a subscriber's email address."
},
"campaign": {
"type": "boolean",
"title": "Salesforce Campaign",
"description": "Create a campaign in a connected Salesforce account."
}
},
"description": "Deprecated"
},
"html_clicks": {
"type": "boolean",
"title": "HTML Click Tracking",
"description": "Whether to [track clicks](https://mailchimp.com/help/enable-and-view-click-tracking/) in the HTML version of the Automation. Defaults to `true`."
},
"text_clicks": {
"type": "boolean",
"title": "Plain-Text Click Tracking",
"description": "Whether to [track clicks](https://mailchimp.com/help/enable-and-view-click-tracking/) in the plain-text version of the Automation. Defaults to `true`."
},
"goal_tracking": {
"type": "boolean",
"title": "Mailchimp Goal Tracking",
"description": "Deprecated"
},
"google_analytics": {
"type": "string",
"title": "Google Analytics Tracking",
"description": "The custom slug for [Google Analytics](https://mailchimp.com/help/integrate-google-analytics-with-mailchimp/) tracking (max of 50 bytes)."
}
},
"description": "The tracking options for the Automation."
},
"recipients": {
"type": "object",
"title": "List",
"properties": {
"list_id": {
"type": "string",
"title": "List ID",
"description": "The unique list id."
},
"store_id": {
"type": "string",
"title": "Store ID",
"example": "1a2df69xxx",
"description": "The id of the store."
},
"list_name": {
"type": "string",
"title": "List Name",
"description": "List Name."
},
"segment_opts": {
"type": "object",
"title": "Segment Options",
"properties": {
"match": {
"enum": [
"any",
"all"
],
"type": "string",
"title": "Match Type",
"description": "Segment match type."
},
"conditions": {
"type": "array",
"items": {
"oneOf": [
{
"type": "object",
"title": "Aim Segment",
"properties": {
"op": {
"enum": [
"open",
"click",
"sent",
"noopen",
"noclick",
"nosent"
],
"type": "string",
"title": "Segment Operator",
"example": "open",
"description": "The status of the member with regard to their campaign interaction. One of the following: opened, clicked, was sent, didn't open, didn't click, or was not sent."
},
"field": {
"enum": [
"aim"
],
"type": "string",
"title": "Segment Field",
"example": "aim",
"description": "Segment by interaction with a specific campaign."
},
"value": {
"type": "string",
"title": "Segment Data",
"example": "any",
"description": "Either the web id value for a specific campaign or 'any' to account for subscribers who have/have not interacted with any campaigns."
},
"condition_type": {
"enum": [
"Aim"
],
"type": "string",
"x-value": "Aim"
}
},
"description": "Segment by interaction with a specific campaign."
},
{
"type": "object",
"title": "Automation Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"started",
"completed",
"not_started",
"not_completed"
],
"type": "string",
"title": "Segment Operator",
"example": "started",
"description": "The status of the member with regard to the automation workflow. One of the following: has started the workflow, has completed the workflow, has not started the workflow, or has not completed the workflow."
},
"field": {
"enum": [
"automation"
],
"type": "string",
"title": "Segment Field",
"example": "automation",
"description": "Segment by interaction with an Automation workflow."
},
"value": {
"type": "string",
"title": "Segment Data",
"example": "2135217",
"description": "The web id for the automation workflow to segment against."
},
"condition_type": {
"enum": [
"Automation"
],
"type": "string",
"x-value": "Automation"
}
},
"description": "Segment by interaction with an Automation workflow."
},
{
"type": "object",
"title": "Poll Activity Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"member",
"notmember"
],
"type": "string",
"title": "Segment Operator",
"example": "member",
"description": "Members have/have not interacted with a specific poll in a Mailchimp email."
},
"field": {
"enum": [
"poll"
],
"type": "string",
"title": "Segment Field",
"example": "poll",
"description": "Segment by poll activity."
},
"value": {
"type": "number",
"title": "Segment Operator",
"example": 409,
"description": "The id for the poll."
},
"condition_type": {
"enum": [
"CampaignPoll"
],
"type": "string",
"x-value": "CampaignPoll"
}
},
"description": "Segment by poll activity."
},
{
"type": "object",
"title": "Conversation Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"member",
"notmember"
],
"type": "string",
"title": "Segment Operator",
"example": "member",
"description": "The status of a member's interaction with a conversation. One of the following: has replied or has not replied."
},
"field": {
"enum": [
"conversation"
],
"type": "string",
"title": "Segment Field",
"example": "conversation",
"description": "Segment by interaction with a campaign via Conversations."
},
"value": {
"type": "string",
"title": "Segment Data",
"example": "any",
"description": "The web id value for a specific campaign or 'any' to account for subscribers who have/have not interacted with any campaigns."
},
"condition_type": {
"enum": [
"Conversation"
],
"type": "string",
"x-value": "Conversation"
}
},
"description": "Segment by interaction with a campaign via Conversations."
},
{
"type": "object",
"title": "Date Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"greater",
"less",
"is",
"not",
"blank",
"blank_not",
"within",
"notwithin"
],
"type": "string",
"title": "Segment Operator",
"example": "greater",
"description": "When the event took place: Before, after, is a specific date, is not a specific date, is blank, or is not blank."
},
"extra": {
"type": "string",
"title": "Segment Extra Value",
"example": "2015-01-30",
"description": "When segmenting on 'date' or 'campaign', the date for the segment formatted as YYYY-MM-DD or the web id for the campaign."
},
"field": {
"enum": [
"timestamp_opt",
"info_changed",
"ecomm_date"
],
"type": "string",
"title": "Segment Field",
"example": "timestamp_opt",
"description": "The type of date field to segment on: The opt-in time for a signup, the date the subscriber was last updated, or the date of their last ecomm purchase."
},
"value": {
"type": "string",
"title": "Segment Data",
"example": "date",
"description": "What type of data to segment on: a specific date, a specific campaign, or the last campaign sent."
},
"condition_type": {
"enum": [
"Date"
],
"type": "string",
"x-value": "Date"
}
},
"description": "Segment by a specific date field."
},
{
"type": "object",
"title": "Email Client Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"client_is",
"client_not"
],
"type": "string",
"title": "Segment Operator",
"example": "client_is",
"description": "The operation to determine whether we select clients that match the value, or clients that do not match the value."
},
"field": {
"enum": [
"email_client"
],
"type": "string",
"title": "Segment Field",
"example": "email_client",
"description": "Segment by use of a particular email client."
},
"value": {
"type": "string",
"title": "Segment Data",
"example": "Gmail",
"description": "The name of the email client."
},
"condition_type": {
"enum": [
"EmailClient"
],
"type": "string",
"x-value": "EmailClient"
}
},
"description": "Segment by use of a particular email client."
},
{
"type": "object",
"title": "Language Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"is",
"not"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Whether the member's language is or is not set to a specific language."
},
"field": {
"enum": [
"language"
],
"type": "string",
"title": "Segment Field",
"example": "language",
"description": "Segmenting based off of a subscriber's language."
},
"value": {
"type": "string",
"title": "Segment Data",
"example": "en",
"description": "A two-letter language identifier."
},
"condition_type": {
"enum": [
"Language"
],
"type": "string",
"x-value": "Language"
}
},
"description": "Segment by language."
},
{
"type": "object",
"title": "Member Rating Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"is",
"not",
"greater",
"less"
],
"type": "string",
"title": "Segment Operator",
"example": "greater",
"description": "Members who have have a rating that is/not exactly a given number or members who have a rating greater/less than a given number."
},
"field": {
"enum": [
"rating"
],
"type": "string",
"title": "Segment Field",
"example": "rating",
"description": "Segment by member rating."
},
"value": {
"type": "number",
"title": "Segment Operator",
"example": 4,
"description": "The star rating number to segment against."
},
"condition_type": {
"enum": [
"MemberRating"
],
"type": "string",
"x-value": "MemberRating"
}
},
"description": "Segment by member rating."
},
{
"type": "object",
"title": "Signup Source Segment",
"required": [
"field",
"condition_type",
"op"
],
"properties": {
"op": {
"enum": [
"source_is",
"source_not"
],
"type": "string",
"title": "Segment Operator",
"example": "source_is",
"description": "Whether the member's signup source was/was not a particular value."
},
"field": {
"enum": [
"source"
],
"type": "string",
"title": "Segment Field",
"example": "source"
},
"value": {
"type": "string",
"title": "Segment Data",
"example": "List Import",
"description": "The signup source."
},
"condition_type": {
"enum": [
"SignupSource"
],
"type": "string",
"title": "Type",
"x-value": "SignupSource"
}
},
"description": "Segment by signup source."
},
{
"type": "object",
"title": "Survey Monkey Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"started",
"completed",
"not_started",
"not_completed"
],
"type": "string",
"title": "Segment Operator",
"example": "started",
"description": "The status of the member with regard to the survey.One of the following: has started the survey, has completed the survey, has not started the survey, or has not completed the survey."
},
"field": {
"enum": [
"survey_monkey"
],
"type": "string",
"title": "Segment Field",
"example": "survey_monkey",
"description": "Segment by interaction with a SurveyMonkey survey."
},
"value": {
"type": "string",
"title": "Survey ID",
"example": "32179586",
"description": "The unique ID of the survey monkey survey."
},
"condition_type": {
"enum": [
"SurveyMonkey"
],
"type": "string",
"x-value": "SurveyMonkey"
}
},
"description": "Segment by interaction with a SurveyMonkey survey."
},
{
"type": "object",
"title": "VIP Segment",
"required": [
"field",
"op"
],
"properties": {
"op": {
"enum": [
"member",
"notmember"
],
"type": "string",
"title": "Segment Operator",
"example": "member",
"description": "Whether the member is or is not marked as VIP."
},
"field": {
"enum": [
"gmonkey"
],
"type": "string",
"title": "Segment Field",
"example": "gmonkey",
"description": "Segment by VIP status."
},
"condition_type": {
"enum": [
"VIP"
],
"type": "string",
"x-value": "VIP"
}
},
"description": "Segment by VIP status."
},
{
"type": "object",
"title": "Interests Segment",
"properties": {
"op": {
"enum": [
"interestcontains",
"interestcontainsall",
"interestnotcontains"
],
"type": "string",
"title": "Segment Operator",
"example": "interestcontains",
"description": "Whether the member is a part of one, all, or none of the groups."
},
"field": {
"type": "string",
"title": "Segment Field",
"example": "interests-123",
"description": "Segmenting based on interest group information. This should start with 'interests-' followed by the grouping id. Ex. 'interests-123'."
},
"value": {
"type": "array",
"items": {
"type": "string",
"example": [
"44401",
"44405",
"44409"
]
},
"title": "Segment Value",
"description": "An array containing strings, each representing a group id."
},
"condition_type": {
"enum": [
"Interests"
],
"type": "string",
"x-value": "Interests"
}
},
"description": "Segment by an interest group merge field."
},
{
"type": "object",
"title": "Ecommerce Category Segment",
"properties": {
"op": {
"enum": [
"is",
"not",
"contains",
"notcontain",
"starts",
"ends"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "A member who has purchased from a category/specific item that is/is not a specific name, where the category/item name contains/doesn't contain a specific phrase or string, or a category/item name that starts/ends with a string."
},
"field": {
"enum": [
"ecomm_cat",
"ecomm_prod"
],
"type": "string",
"title": "Segment Field",
"example": "ecomm_cat",
"description": "Segment by purchases in specific items or categories."
},
"value": {
"type": "string",
"title": "Segment Data",
"example": "Product",
"description": "The ecommerce category/item information."
},
"condition_type": {
"enum": [
"EcommCategory"
],
"type": "string",
"x-value": "EcommCategory"
}
},
"description": "Segment by purchases in specific items or categories."
},
{
"type": "object",
"title": "Ecommerce Number Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"is",
"not",
"greater",
"less"
],
"type": "string",
"title": "Segment Operator",
"example": "greater",
"description": "Members who have spent exactly, have not spent exactly, spent more, or spent less than the segment value."
},
"field": {
"enum": [
"ecomm_spent_avg",
"ecomm_orders",
"ecomm_prod_all",
"ecomm_avg_ord"
],
"type": "string",
"title": "Segment Field",
"example": "ecomm_orders",
"description": "Segment by average spent total, number of orders, total number of products purchased, or average number of products per order."
},
"value": {
"type": "number",
"title": "Segment Operator",
"example": 42,
"description": "Members who have spent exactly, have not spent exactly, spent more, or spent less than this amount."
},
"condition_type": {
"enum": [
"EcommNumber"
],
"type": "string",
"x-value": "EcommNumber"
}
},
"description": "Segment by average spent total, number of orders, total number of products purchased, or average number of products per order."
},
{
"type": "object",
"title": "Ecommerce Purchased Segment",
"properties": {
"op": {
"enum": [
"member",
"notmember"
],
"type": "string",
"title": "Segment Operator",
"example": "member",
"description": "Members who have have ('member') or have not ('notmember') purchased."
},
"field": {
"enum": [
"ecomm_purchased"
],
"type": "string",
"title": "Segment Field",
"example": "ecomm_purchased",
"description": "Segment by whether someone has purchased anything."
},
"condition_type": {
"enum": [
"EcommPurchased"
],
"type": "string",
"x-value": "EcommPurchased"
}
},
"description": "Segment by whether someone has purchased anything."
},
{
"type": "object",
"title": "Ecommerce Spent Segment",
"properties": {
"op": {
"enum": [
"greater",
"less"
],
"type": "string",
"title": "Segment Operator",
"example": "greater",
"description": "Members who have spent 'more' or 'less' than then specified value."
},
"field": {
"enum": [
"ecomm_spent_one",
"ecomm_spent_all"
],
"type": "string",
"title": "Segment Field",
"example": "ecomm_spent_one",
"description": "Segment by amount spent on a single order or across all orders."
},
"value": {
"type": "integer",
"title": "Segment Data",
"example": 42,
"description": "The total amount a member spent."
},
"condition_type": {
"enum": [
"EcommSpent"
],
"type": "string",
"x-value": "EcommSpent"
}
},
"description": "Segment by amount spent on a single order or across all orders."
},
{
"type": "object",
"title": "Ecommerce Purchased Store Segment",
"properties": {
"op": {
"enum": [
"is",
"not"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Members who have or have not purchased from a specific store."
},
"field": {
"enum": [
"ecomm_store"
],
"type": "string",
"title": "Segment Field",
"example": "ecomm_store",
"description": "Segment by purchases from a specific store."
},
"value": {
"type": "string",
"title": "Segment Operator",
"example": "289",
"description": "The store id to segment against."
},
"condition_type": {
"enum": [
"EcommStore"
],
"type": "string",
"x-value": "EcommStore"
}
},
"description": "Segment by purchases from a specific store."
},
{
"type": "object",
"title": "Goal Activity Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"is",
"goal_not",
"contains",
"goal_notcontain",
"starts",
"ends"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Whether the website URL is/not exactly, contains/doesn't contain, starts with/ends with a string."
},
"field": {
"enum": [
"goal"
],
"type": "string",
"title": "Segment Field",
"example": "goal",
"description": "Segment by Goal activity."
},
"value": {
"type": "string",
"title": "Segment Value",
"description": "The URL to check Goal activity against."
},
"condition_type": {
"enum": [
"GoalActivity"
],
"type": "string",
"x-value": "GoalActivity"
}
},
"description": "Segment by Goal activity."
},
{
"type": "object",
"title": "Goal Timestamp Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"greater",
"less",
"is"
],
"type": "string",
"title": "Segment Operator",
"example": "greater",
"description": "Whether the website activity happened after, before, or at a given timestamp."
},
"field": {
"enum": [
"goal_last_visited"
],
"type": "string",
"title": "Segment Field",
"example": "goal_last_visited",
"description": "Segment by most recent interaction with a website."
},
"value": {
"type": "string",
"title": "Segment Value",
"example": "2015-07-20 19:45:21",
"description": "The date to check Goal activity against."
},
"condition_type": {
"enum": [
"GoalTimestamp"
],
"type": "string",
"x-value": "GoalTimestamp"
}
},
"description": "Segment by most recent interaction with a website."
},
{
"type": "object",
"title": "Similar Subscribers Segment Member Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"fuzzy_is",
"fuzzy_not"
],
"type": "string",
"title": "Segment Operator",
"example": "fuzzy_is",
"description": "Members who are/are not apart of a 'similar subscribers' segment."
},
"field": {
"enum": [
"fuzzy_segment"
],
"type": "string",
"title": "Segment Field",
"example": "fuzzy_segment",
"description": "Segment by similar subscribers."
},
"value": {
"type": "number",
"title": "Segment Operator",
"example": 48433,
"description": "The id for the 'similar subscribers' segment."
},
"condition_type": {
"enum": [
"FuzzySegment"
],
"type": "string",
"x-value": "FuzzySegment"
}
},
"description": "Segment by similar subscribers."
},
{
"type": "object",
"title": "Static Segment Member Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"static_is",
"static_not"
],
"type": "string",
"title": "Segment Operator",
"example": "static_is",
"description": "Members who are/are not apart of a static segment."
},
"field": {
"enum": [
"static_segment"
],
"type": "string",
"title": "Segment Field",
"example": "static_segment",
"description": "Segment by a given static segment."
},
"value": {
"type": "number",
"title": "Segment Operator",
"example": 48433,
"description": "The id for the static segment."
},
"condition_type": {
"enum": [
"StaticSegment"
],
"type": "string",
"x-value": "StaticSegment"
}
},
"description": "Segment by a given static segment."
},
{
"type": "object",
"title": "Location-Based Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"ipgeocountry",
"ipgeonotcountry",
"ipgeostate",
"ipgeonotstate"
],
"type": "string",
"title": "Segment Operator",
"example": "ipgeocountry",
"description": "Segment members who are within a specific country or US state."
},
"field": {
"enum": [
"ipgeo"
],
"type": "string",
"title": "Segment Field",
"example": "ipgeo",
"description": "Segmenting subscribers who are within a specific location."
},
"value": {
"type": "string",
"title": "Segment Data",
"example": "US",
"description": "The two-letter country code or US state abbreviation."
},
"condition_type": {
"enum": [
"IPGeoCountryState"
],
"type": "string",
"x-value": "IPGeoCountryState"
}
},
"description": "Segment by a specific country or US state."
},
{
"type": "object",
"title": "Geolocation Segment",
"required": [
"field",
"op",
"value",
"addr",
"lat",
"lng"
],
"properties": {
"op": {
"enum": [
"ipgeoin",
"ipgeonotin"
],
"type": "string",
"title": "Segment Operator",
"example": "ipgeoin",
"description": "Segment members who are within a specific geographic region."
},
"lat": {
"type": "string",
"title": "Segment Location Latitude",
"example": "33.7489954",
"description": "The latitude of the target location."
},
"lng": {
"type": "string",
"title": "Segment Location Longitude",
"example": "-84.3879824",
"description": "The longitude of the target location."
},
"addr": {
"type": "string",
"title": "Segment Location Address",
"example": "Atlanta, GA, USA",
"description": "The address of the target location."
},
"field": {
"enum": [
"ipgeo"
],
"type": "string",
"title": "Segment Field",
"example": "ipgeo",
"description": "Segmenting subscribers who are within a specific location."
},
"value": {
"type": "integer",
"title": "Segment Data",
"example": 42,
"description": "The radius of the target location."
},
"condition_type": {
"enum": [
"IPGeoIn"
],
"type": "string",
"x-value": "IPGeoIn"
}
},
"description": "Segment by a specific geographic region."
},
{
"type": "object",
"title": "US Zip Code Segment",
"required": [
"field",
"op",
"value",
"extra"
],
"properties": {
"op": {
"enum": [
"ipgeoinzip"
],
"type": "string",
"title": "Segment Operator",
"example": "ipgeoinzip",
"description": "Segment members who are within a specific US zip code."
},
"extra": {
"type": "integer",
"title": "Extra Data",
"example": 30318,
"description": "The zip code to segment against."
},
"field": {
"enum": [
"ipgeo"
],
"type": "string",
"title": "Segment Field",
"example": "ipgeo",
"description": "Segmenting subscribers who are within a specific location."
},
"value": {
"type": "integer",
"title": "Segment Data",
"example": 25,
"description": "The radius of the target location."
},
"condition_type": {
"enum": [
"IPGeoInZip"
],
"type": "string",
"x-value": "IPGeoInZip"
}
},
"description": "Segment by a specific US ZIP code."
},
{
"type": "object",
"title": "Unknown Location-Based Segment",
"required": [
"field",
"op"
],
"properties": {
"op": {
"enum": [
"ipgeounknown"
],
"type": "string",
"title": "Segment Operator",
"example": "ipgeounknown",
"description": "Segment members for which location information is unknown."
},
"field": {
"enum": [
"ipgeo"
],
"type": "string",
"title": "Segment Field",
"example": "ipgeo",
"description": "Segmenting subscribers who are within a specific location."
},
"condition_type": {
"enum": [
"IPGeoUnknown"
],
"type": "string",
"x-value": "IPGeoUnknown"
}
},
"description": "Segment members whose location information is unknown."
},
{
"type": "object",
"title": "Zip Code Location-Based Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"ipgeoiszip",
"ipgeonotzip"
],
"type": "string",
"title": "Segment Operator",
"example": "ipgeonotzip",
"description": "Segment members who are/are not within a specific US zip code."
},
"field": {
"enum": [
"ipgeo"
],
"type": "string",
"title": "Segment Field",
"example": "ipgeo",
"description": "Segmenting subscribers who are within a specific location."
},
"value": {
"type": "integer",
"title": "Segment Data",
"example": 30318,
"description": "The 5-digit zip code."
},
"condition_type": {
"enum": [
"IPGeoZip"
],
"type": "string",
"x-value": "IPGeoZip"
}
},
"description": "Segment by a specific US ZIP code."
},
{
"type": "object",
"title": "Social Profiles Age Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"is",
"not"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Members who are/not the exact criteria listed."
},
"field": {
"enum": [
"social_age"
],
"type": "string",
"title": "Segment Field",
"example": "social_age",
"description": "Segment by age ranges in Social Profiles data."
},
"value": {
"enum": [
"18-24",
"25-34",
"35-54",
"55+"
],
"type": "string",
"title": "Segment Operator",
"example": "35-54",
"description": "The age range to segment."
},
"condition_type": {
"enum": [
"SocialAge"
],
"type": "string",
"x-value": "SocialAge"
}
},
"description": "Segment by age ranges in Social Profiles data."
},
{
"type": "object",
"title": "Social Profiles Gender Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"is",
"not"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Members who are/not the exact criteria listed."
},
"field": {
"enum": [
"social_gender"
],
"type": "string",
"title": "Segment Field",
"example": "social_gender",
"description": "Segment by listed gender in Social Profiles data."
},
"value": {
"enum": [
"male",
"female"
],
"type": "string",
"title": "Segment Operator",
"example": "female",
"description": "The Social Profiles gender to segment."
},
"condition_type": {
"enum": [
"SocialGender"
],
"type": "string",
"x-value": "SocialGender"
}
},
"description": "Segment by listed gender in Social Profiles data."
},
{
"type": "object",
"title": "Social Profiles Influence Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"is",
"not",
"greater",
"less"
],
"type": "string",
"title": "Segment Operator",
"example": "greater",
"description": "Members who have a rating that is/not or greater/less than the rating provided."
},
"field": {
"enum": [
"social_influence"
],
"type": "string",
"title": "Segment Field",
"example": "social_influence",
"description": "Segment by influence rating in Social Profiles data."
},
"value": {
"type": "number",
"title": "Segment Operator",
"example": 2,
"description": "The Social Profiles influence rating to segment."
},
"condition_type": {
"enum": [
"SocialInfluence"
],
"type": "string",
"x-value": "SocialInfluence"
}
},
"description": "Segment by influence rating in Social Profiles data."
},
{
"type": "object",
"title": "Social Profiles Social Network Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"member",
"notmember"
],
"type": "string",
"title": "Segment Operator",
"example": "member",
"description": "Members who are/not on a given social network."
},
"field": {
"enum": [
"social_network"
],
"type": "string",
"title": "Segment Field",
"example": "social_network",
"description": "Segment by social network in Social Profiles data."
},
"value": {
"enum": [
"twitter",
"facebook",
"linkedin",
"flickr",
"foursquare",
"lastfm",
"myspace",
"quora",
"vimeo",
"yelp",
"youtube"
],
"type": "string",
"title": "Segment Operator",
"example": "twitter",
"description": "The social network to segment against."
},
"condition_type": {
"enum": [
"SocialNetworkMember"
],
"type": "string",
"x-value": "SocialNetworkMember"
}
},
"description": "Segment by social network in Social Profiles data."
},
{
"type": "object",
"title": "Social Profiles Social Network Follow Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"follow",
"notfollow"
],
"type": "string",
"title": "Segment Operator",
"example": "follow",
"description": "Members who are/not following a linked account on a given social network."
},
"field": {
"enum": [
"social_network"
],
"type": "string",
"title": "Segment Field",
"example": "social_network",
"description": "Segment by social network in Social Profiles data."
},
"value": {
"enum": [
"twitter_follow"
],
"type": "string",
"title": "Segment Operator",
"example": "twitter_follow",
"description": "The social network to segment against."
},
"condition_type": {
"enum": [
"SocialNetworkFollow"
],
"type": "string",
"x-value": "SocialNetworkFollow"
}
},
"description": "Segment by social network in Social Profiles data."
},
{
"type": "object",
"title": "Address Merge Field Segment",
"required": [
"field",
"op"
],
"properties": {
"op": {
"enum": [
"contains",
"notcontain",
"blank",
"blank_not"
],
"type": "string",
"title": "Segment Operator",
"example": "contains",
"description": "Whether the member's address merge field contains/does not contain a value or is/is not blank."
},
"field": {
"type": "string",
"title": "Segment Field",
"example": "MMERGE3",
"description": "An address-type merge field to segment."
},
"value": {
"type": "string",
"title": "Segment Value",
"example": "Atlanta",
"description": "The value to segment a text merge field with."
},
"condition_type": {
"enum": [
"AddressMerge"
],
"type": "string",
"x-value": "AddressMerge"
}
},
"description": "Segment by an address-type merge field."
},
{
"type": "object",
"title": "Address/Zip Merge Field Segment",
"required": [
"field",
"op",
"value",
"extra"
],
"properties": {
"op": {
"enum": [
"geoin"
],
"type": "string",
"title": "Segment Operator",
"example": "geoin",
"description": "Whether the member's address merge field is within a given distance from a city or zip."
},
"extra": {
"type": "string",
"title": "Segment Extra",
"example": "30318",
"description": "The city or the zip being used to segment against."
},
"field": {
"type": "string",
"title": "Segment Field",
"example": "MMERGE2",
"description": "An address or zip-type merge field to segment."
},
"value": {
"type": "string",
"title": "Segment Value",
"example": "25",
"description": "The distance from the city/zip."
},
"condition_type": {
"enum": [
"ZipMerge"
],
"type": "string",
"x-value": "ZipMerge"
}
},
"description": "Segment by an address-type merge field within a given distance."
},
{
"type": "object",
"title": "Birthday Merge Field Segment",
"required": [
"field",
"op"
],
"properties": {
"op": {
"enum": [
"is",
"not",
"blank",
"blank_not"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Whether the member's birthday merge information is/is not a certain date or is/is not blank."
},
"field": {
"type": "string",
"title": "Segment Field",
"example": "MMERGE4",
"description": "A date merge field to segment."
},
"value": {
"type": "string",
"title": "Segment Value",
"example": "01/30",
"description": "A date to segment against (mm/dd)."
},
"condition_type": {
"enum": [
"BirthdayMerge"
],
"type": "string",
"x-value": "BirthdayMerge"
}
},
"description": "Segment by a contact's birthday."
},
{
"type": "object",
"title": "Date Merge Field Segment",
"required": [
"field",
"op"
],
"properties": {
"op": {
"enum": [
"is",
"not",
"less",
"blank",
"blank_not",
"greater"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Whether the member's merge information is/is not, is greater/less than a value or is/is not blank."
},
"field": {
"type": "string",
"title": "Segment Field",
"example": "MMERGE5",
"description": "A date merge field to segment."
},
"value": {
"type": "string",
"title": "Segment Value",
"example": "01/30/2015",
"description": "A date to segment against."
},
"condition_type": {
"enum": [
"DateMerge"
],
"type": "string",
"x-value": "DateMerge"
}
},
"description": "Segment by a given date merge field."
},
{
"type": "object",
"title": "Dropdown/Radio Merge Field Segment",
"required": [
"field",
"op"
],
"properties": {
"op": {
"enum": [
"is",
"not",
"blank",
"blank_not",
"notcontain",
"contains"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Whether the member's merge information is/is not a value or is/is not blank."
},
"field": {
"type": "string",
"title": "Segment Field",
"example": "MMERGE6",
"description": "A merge field to segment."
},
"value": {
"type": "string",
"title": "Segment Value",
"example": "Second Choice",
"description": "The value to segment a text merge field with."
},
"condition_type": {
"enum": [
"SelectMerge"
],
"type": "string",
"x-value": "SelectMerge"
}
},
"description": "An individual segment condition"
},
{
"type": "object",
"title": "Text or Number Merge Field Segment",
"required": [
"field",
"op"
],
"properties": {
"op": {
"enum": [
"is",
"not",
"contains",
"notcontain",
"starts",
"ends",
"greater",
"less",
"blank",
"blank_not"
],
"type": "string",
"title": "Segment Operator",
"example": "contains",
"description": "Whether the member's merge information is/is not, contains/does not contain, starts/ends with, or is greater/less than a value"
},
"field": {
"type": "string",
"title": "Segment Field",
"example": "MMERGE7",
"description": "A text or number merge field to segment."
},
"value": {
"type": "string",
"title": "Segment Value",
"example": "Freddie's Jokes",
"description": "The value to segment a text or number merge field with."
},
"condition_type": {
"enum": [
"TextMerge"
],
"type": "string",
"x-value": "TextMerge"
}
},
"description": "Segment by a given text or number merge field."
},
{
"type": "object",
"title": "Email Segment",
"required": [
"field",
"op"
],
"properties": {
"op": {
"enum": [
"is",
"not",
"contains",
"notcontain",
"starts",
"ends",
"greater",
"less"
],
"type": "string",
"title": "Segment Operator",
"description": "Whether the email address is/not exactly, contains/doesn't contain, starts/ends with a string."
},
"field": {
"enum": [
"merge0",
"EMAIL"
],
"type": "string",
"title": "Segment Field",
"example": "EMAIL",
"description": "Segmenting based off of a subscriber's email address."
},
"value": {
"type": "string",
"title": "Segment Value",
"example": "urist.mcvankab@freddiesjokes.com",
"description": "The value to compare the email against."
},
"condition_type": {
"enum": [
"EmailAddress"
],
"type": "string",
"x-value": "EmailAddress"
}
},
"description": "Segment by email address."
},
{
"type": "object",
"title": "Predicted Gender Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"is",
"not"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Members who are/not the exact criteria listed."
},
"field": {
"enum": [
"predicted_gender"
],
"type": "string",
"title": "Segment Field",
"description": "Segment by predicted gender."
},
"value": {
"enum": [
"male",
"female"
],
"type": "string",
"title": "Segment Operator",
"example": "female",
"description": "The predicted gender to segment."
},
"condition_type": {
"enum": [
"PredictedGender"
],
"type": "string",
"x-value": "PredictedGender"
}
},
"description": "Segment by predicted gender."
},
{
"type": "object",
"title": "Predicted Age Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"is"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Members who are/not the exact criteria listed."
},
"field": {
"enum": [
"predicted_age_range"
],
"type": "string",
"title": "Segment Field",
"description": "Segment by predicted age."
},
"value": {
"enum": [
"18-24",
"25-34",
"35-44",
"45-54",
"55-64",
"65+"
],
"type": "string",
"title": "Segment Operator",
"example": "female",
"description": "The predicted age to segment."
},
"condition_type": {
"enum": [
"PredictedAge"
],
"type": "string",
"x-value": "PredictedAge"
}
},
"description": "Segment by predicted age."
},
{
"type": "object",
"title": "New Subscribers Prebuilt Segment",
"properties": {
"op": {
"enum": [
"date_within"
],
"type": "string",
"title": "Segment Operator",
"description": "Whe the event took place, namely within a time frame."
},
"field": {
"enum": [
"timestamp_opt"
],
"type": "string",
"title": "Segment Field",
"description": "Segment by when people subscribed."
},
"value": {
"type": "string",
"title": "Segment Data",
"description": "What type of data to segment on: a specific date, a specific campaign, or the last campaign sent."
},
"condition_type": {
"enum": [
"NewSubscribers"
],
"type": "string",
"x-value": "NewSubscribers"
}
},
"description": "Segment by when people subscribed."
}
],
"discriminator": {
"type": "string",
"propertyName": "condition_type"
}
},
"title": "Segment Type",
"description": "Segment match conditions. There are multiple possible types, see the [condition types documentation](https://mailchimp.com/developer/marketing/docs/alternative-schemas/#segment-condition-schemas)."
},
"saved_segment_id": {
"type": "integer",
"title": "Saved Segment ID",
"description": "The id for an existing saved segment."
}
},
"description": "An object representing all segmentation options."
},
"list_is_active": {
"type": "boolean",
"title": "List Status",
"readOnly": true,
"description": "The status of the list used, namely if it's deleted or disabled."
}
},
"description": "List settings for the Automation."
},
"start_time": {
"type": "string",
"title": "Start Time",
"format": "date-time",
"readOnly": true,
"description": "The date and time the Automation was started in ISO 8601 format."
},
"create_time": {
"type": "string",
"title": "Create Time",
"format": "date-time",
"readOnly": true,
"description": "The date and time the Automation was created in ISO 8601 format."
},
"emails_sent": {
"type": "integer",
"title": "Emails Sent",
"readOnly": true,
"description": "The total number of emails sent for the Automation."
},
"report_summary": {
"type": "object",
"title": "Campaign Report Summary",
"properties": {
"opens": {
"type": "integer",
"title": "Automation Opens",
"readOnly": true,
"description": "The total number of opens for a campaign."
},
"clicks": {
"type": "integer",
"title": "Total Clicks",
"readOnly": true,
"description": "The total number of clicks for an campaign."
},
"open_rate": {
"type": "number",
"title": "Open Rate",
"readOnly": true,
"description": "The number of unique opens divided by the total number of successful deliveries."
},
"click_rate": {
"type": "number",
"title": "Click Rate",
"readOnly": true,
"description": "The number of unique clicks, divided by the total number of successful deliveries."
},
"unique_opens": {
"type": "integer",
"title": "Unique Opens",
"readOnly": true,
"description": "The number of unique opens."
},
"subscriber_clicks": {
"type": "integer",
"title": "Unique Subscriber Clicks",
"readOnly": true,
"description": "The number of unique clicks."
}
},
"description": "A summary of opens and clicks for sent campaigns."
},
"trigger_settings": {
"type": "object",
"title": "Automation Trigger",
"required": [
"workflow_type"
],
"properties": {
"runtime": {
"type": "object",
"title": "Automation Workflow Runtime Settings",
"properties": {
"days": {
"type": "array",
"items": {
"enum": [
"sunday",
"monday",
"tuesday",
"wednesday",
"thursday",
"friday",
"saturday"
],
"type": "string"
},
"title": "Days",
"description": "The days an Automation workflow can send."
},
"hours": {
"type": "object",
"title": "Hours",
"required": [
"type"
],
"properties": {
"type": {
"enum": [
"send_asap",
"send_between",
"send_at"
],
"type": "string",
"title": "Email Send Time Settings",
"description": "When to send the Automation email."
}
},
"description": "The hours an Automation workflow can send."
}
},
"description": "A workflow's runtime settings for an Automation."
},
"workflow_type": {
"enum": [
"abandonedBrowse",
"abandonedCart",
"api",
"bestCustomers",
"categoryFollowup",
"dateAdded",
"emailFollowup",
"emailSeries",
"groupAdd",
"groupRemove",
"mandrill",
"productFollowup",
"purchaseFollowup",
"recurringEvent",
"specialEvent",
"visitUrl",
"welcomeSeries"
],
"type": "string",
"title": "Workflow Type",
"description": "The type of Automation workflow."
},
"workflow_title": {
"type": "string",
"title": "Workflow Title",
"readOnly": true,
"description": "The title of the workflow type."
},
"workflow_emails_count": {
"type": "integer",
"title": "Workflow Emails Count",
"readOnly": true,
"description": "The number of emails in the Automation workflow."
}
},
"description": "Available triggers for Automation workflows.",
"discriminator": {
"propertyName": "workflow_type"
}
}
},
"description": "A summary of an individual Automation workflow's settings and content."
}
AutomationsGetClassicWorkflowInfodefaultResponse
{
"type": "object",
"title": "Problem Detail Document",
"required": [
"type",
"title",
"status",
"detail",
"instance"
],
"properties": {
"type": {
"type": "string",
"title": "Problem Type",
"example": "https://mailchimp.com/developer/marketing/docs/errors/",
"description": "An absolute URI that identifies the problem type. When dereferenced, it should provide human-readable documentation for the problem type."
},
"title": {
"type": "string",
"title": "Error Title",
"example": "Resource Not Found",
"description": "A short, human-readable summary of the problem type. It shouldn't change based on the occurrence of the problem, except for purposes of localization."
},
"detail": {
"type": "string",
"title": "Error Message",
"example": "The requested resource could not be found.",
"description": "A human-readable explanation specific to this occurrence of the problem. [Learn more about errors](https://mailchimp.com/developer/)."
},
"status": {
"type": "integer",
"title": "HTTP Status Code",
"example": 404,
"description": "The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem."
},
"instance": {
"type": "string",
"title": "Instance ID",
"example": "995c5cb0-3280-4a6e-808b-3b096d0bb219",
"description": "A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support."
}
},
"description": "An error generated by the Mailchimp API. Conforms to IETF draft 'draft-nottingham-http-problem-06'."
}
AutomationsGetEmailInfo200Response
{
"type": "object",
"title": "Automation Workflow Email",
"properties": {
"id": {
"type": "string",
"title": "Automation Email ID",
"readOnly": true,
"description": "A string that uniquely identifies the Automation email."
},
"delay": {
"type": "object",
"title": "Automation Delay",
"properties": {
"type": {
"enum": [
"now",
"day",
"hour",
"week"
],
"type": "string",
"title": "Delay Type",
"description": "The type of delay for an Automation email."
},
"action": {
"enum": [
"previous_campaign_sent",
"previous_campaign_opened",
"previous_campaign_not_opened",
"previous_campaign_clicked_any",
"previous_campaign_not_clicked_any",
"previous_campaign_specific_clicked",
"ecomm_bought_any",
"ecomm_bought_product",
"ecomm_bought_category",
"ecomm_not_bought_any",
"ecomm_abandoned_cart",
"campaign_sent",
"opened_email",
"not_opened_email",
"clicked_email",
"not_clicked_email",
"campaign_specific_clicked",
"manual",
"signup",
"merge_changed",
"group_add",
"group_remove",
"mandrill_sent",
"mandrill_opened",
"mandrill_clicked",
"mandrill_any",
"api",
"goal",
"annual",
"birthday",
"date",
"date_added",
"tag_add"
],
"type": "string",
"title": "Delay Action",
"description": "The action that triggers the delay of an Automation email."
},
"amount": {
"type": "integer",
"title": "Delay Amount",
"readOnly": true,
"description": "The delay amount for an Automation email."
},
"direction": {
"enum": [
"before",
"after"
],
"type": "string",
"title": "Delay Direction",
"description": "Whether the delay settings describe before or after the delay action of an Automation email."
},
"full_description": {
"type": "string",
"title": "Full Delay Description",
"example": "1 day after subscribers purchase anything from your store",
"readOnly": true,
"description": "The user-friendly description of the delay and trigger action settings for an Automation email."
},
"action_description": {
"type": "string",
"title": "Delay Action Description",
"example": "subscribers purchase anything from your store",
"readOnly": true,
"description": "The user-friendly description of the action that triggers an Automation email."
}
},
"description": "The delay settings for an Automation email."
},
"_links": {
"type": "array",
"items": {
"type": "object",
"title": "Resource Link",
"properties": {
"rel": {
"type": "string",
"title": "Rel",
"readOnly": true,
"description": "As with an HTML 'rel' attribute, this describes the type of link."
},
"href": {
"type": "string",
"title": "Href",
"readOnly": true,
"description": "This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action."
},
"method": {
"enum": [
"GET",
"POST",
"PUT",
"PATCH",
"DELETE",
"OPTIONS",
"HEAD"
],
"type": "string",
"title": "Method",
"readOnly": true,
"description": "The HTTP method that should be used when accessing the URL defined in 'href'."
},
"schema": {
"type": "string",
"title": "Schema",
"readOnly": true,
"description": "For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to."
},
"targetSchema": {
"type": "string",
"title": "Target Schema",
"readOnly": true,
"description": "For GETs, this is a URL representing the schema that the response should conform to."
}
},
"description": "This object represents a link from the resource where it is found to another resource or action that may be performed."
},
"title": "Links",
"readOnly": true,
"description": "A list of link types and descriptions for the API schema documents."
},
"status": {
"enum": [
"save",
"paused",
"sending"
],
"type": "string",
"title": "Campaign Status",
"readOnly": true,
"description": "The current status of the campaign."
},
"web_id": {
"type": "integer",
"title": "Automation Web ID",
"example": 33345484,
"readOnly": true,
"description": "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}`."
},
"position": {
"type": "integer",
"title": "Email Position",
"readOnly": true,
"description": "The position of an Automation email in a workflow."
},
"settings": {
"type": "object",
"title": "Campaign Settings",
"properties": {
"title": {
"type": "string",
"title": "Campaign Title",
"description": "The title of the campaign."
},
"reply_to": {
"type": "string",
"title": "Reply To Address",
"description": "The reply-to email address for the campaign."
},
"from_name": {
"type": "string",
"title": "From Name",
"description": "The 'from' name on the campaign (not an email address)."
},
"auto_tweet": {
"type": "boolean",
"title": "Auto-Tweet",
"description": "Automatically tweet a link to the [campaign archive](https://mailchimp.com/help/about-email-campaign-archives-and-pages/) page when the campaign is sent."
},
"inline_css": {
"type": "boolean",
"title": "Inline CSS",
"description": "Automatically inline the CSS included with the campaign content."
},
"auto_footer": {
"type": "boolean",
"title": "Auto-Footer",
"description": "Automatically append Mailchimp's [default footer](https://mailchimp.com/help/about-campaign-footers/) to the campaign."
},
"fb_comments": {
"type": "boolean",
"title": "Facebook Comments",
"description": "Allows Facebook comments on the campaign (also force-enables the Campaign Archive toolbar). Defaults to `true`."
},
"template_id": {
"type": "integer",
"title": "Template ID",
"description": "The id for the template used in this campaign."
},
"authenticate": {
"type": "boolean",
"title": "Authentication",
"description": "Whether Mailchimp [authenticated](https://mailchimp.com/help/about-email-authentication/) the campaign. Defaults to `true`."
},
"auto_fb_post": {
"type": "array",
"items": {
"type": "string"
},
"title": "Auto Post to Facebook",
"description": "An array of [Facebook](https://mailchimp.com/help/connect-or-disconnect-the-facebook-integration/) page ids to auto-post to."
},
"preview_text": {
"type": "string",
"title": "Campaign Preview Text",
"description": "The preview text for the campaign."
},
"subject_line": {
"type": "string",
"title": "Campaign Subject Line",
"description": "The subject line for the campaign."
},
"drag_and_drop": {
"type": "boolean",
"title": "Drag And Drop Campaign",
"readOnly": true,
"description": "Whether the campaign uses the drag-and-drop editor."
}
},
"description": "Settings for the campaign including the email subject, from name, and from email address."
},
"tracking": {
"type": "object",
"title": "Campaign Tracking Options",
"properties": {
"opens": {
"type": "boolean",
"title": "Opens",
"description": "Whether to [track opens](https://mailchimp.com/help/about-open-tracking/). Defaults to `true`."
},
"capsule": {
"type": "object",
"title": "Capsule CRM Tracking",
"properties": {
"notes": {
"type": "boolean",
"title": "Capsule Note",
"description": "Update contact notes for a campaign based on a subscriber's email address."
}
},
"description": "Deprecated"
},
"ecomm360": {
"type": "boolean",
"title": "E-commerce Tracking",
"description": "Whether to enable e-commerce tracking."
},
"clicktale": {
"type": "string",
"title": "ClickTale Analytics Tracking",
"description": "The custom slug for [Click Tale](https://mailchimp.com/help/additional-tracking-options-for-campaigns/) tracking (max of 50 bytes)."
},
"salesforce": {
"type": "object",
"title": "Salesforce CRM Tracking",
"properties": {
"notes": {
"type": "boolean",
"title": "Salesforce Note",
"description": "Update contact notes for a campaign based on a subscriber's email address."
},
"campaign": {
"type": "boolean",
"title": "Salesforce Campaign",
"description": "Create a campaign in a connected Salesforce account."
}
},
"description": "Deprecated"
},
"html_clicks": {
"type": "boolean",
"title": "HTML Click Tracking",
"description": "Whether to [track clicks](https://mailchimp.com/help/enable-and-view-click-tracking/) in the HTML version of the campaign. Defaults to `true`."
},
"text_clicks": {
"type": "boolean",
"title": "Plain-Text Click Tracking",
"description": "Whether to [track clicks](https://mailchimp.com/help/enable-and-view-click-tracking/) in the plain-text version of the campaign. Defaults to `true`."
},
"goal_tracking": {
"type": "boolean",
"title": "Mailchimp Goal Tracking",
"description": "Deprecated"
},
"google_analytics": {
"type": "string",
"title": "Google Analytics Tracking",
"description": "The custom slug for [Google Analytics](https://mailchimp.com/help/integrate-google-analytics-with-mailchimp/) tracking (max of 50 bytes)."
}
},
"description": "The tracking options for a campaign."
},
"send_time": {
"type": "string",
"title": "Send Time",
"format": "date-time",
"readOnly": true,
"description": " The date and time a campaign was sent in ISO 8601 format"
},
"recipients": {
"type": "object",
"title": "List",
"properties": {
"list_id": {
"type": "string",
"title": "List ID",
"description": "The unique list id."
},
"list_name": {
"type": "string",
"title": "List Name",
"readOnly": true,
"description": "The name of the list."
},
"segment_opts": {
"type": "object",
"title": "Segment Options",
"properties": {
"match": {
"enum": [
"any",
"all"
],
"type": "string",
"title": "Match Type",
"description": "Segment match type."
},
"conditions": {
"type": "array",
"items": {
"oneOf": [
{
"type": "object",
"title": "Aim Segment",
"properties": {
"op": {
"enum": [
"open",
"click",
"sent",
"noopen",
"noclick",
"nosent"
],
"type": "string",
"title": "Segment Operator",
"example": "open",
"description": "The status of the member with regard to their campaign interaction. One of the following: opened, clicked, was sent, didn't open, didn't click, or was not sent."
},
"field": {
"enum": [
"aim"
],
"type": "string",
"title": "Segment Field",
"example": "aim",
"description": "Segment by interaction with a specific campaign."
},
"value": {
"type": "string",
"title": "Segment Data",
"example": "any",
"description": "Either the web id value for a specific campaign or 'any' to account for subscribers who have/have not interacted with any campaigns."
},
"condition_type": {
"enum": [
"Aim"
],
"type": "string",
"x-value": "Aim"
}
},
"description": "Segment by interaction with a specific campaign."
},
{
"type": "object",
"title": "Automation Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"started",
"completed",
"not_started",
"not_completed"
],
"type": "string",
"title": "Segment Operator",
"example": "started",
"description": "The status of the member with regard to the automation workflow. One of the following: has started the workflow, has completed the workflow, has not started the workflow, or has not completed the workflow."
},
"field": {
"enum": [
"automation"
],
"type": "string",
"title": "Segment Field",
"example": "automation",
"description": "Segment by interaction with an Automation workflow."
},
"value": {
"type": "string",
"title": "Segment Data",
"example": "2135217",
"description": "The web id for the automation workflow to segment against."
},
"condition_type": {
"enum": [
"Automation"
],
"type": "string",
"x-value": "Automation"
}
},
"description": "Segment by interaction with an Automation workflow."
},
{
"type": "object",
"title": "Poll Activity Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"member",
"notmember"
],
"type": "string",
"title": "Segment Operator",
"example": "member",
"description": "Members have/have not interacted with a specific poll in a Mailchimp email."
},
"field": {
"enum": [
"poll"
],
"type": "string",
"title": "Segment Field",
"example": "poll",
"description": "Segment by poll activity."
},
"value": {
"type": "number",
"title": "Segment Operator",
"example": 409,
"description": "The id for the poll."
},
"condition_type": {
"enum": [
"CampaignPoll"
],
"type": "string",
"x-value": "CampaignPoll"
}
},
"description": "Segment by poll activity."
},
{
"type": "object",
"title": "Conversation Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"member",
"notmember"
],
"type": "string",
"title": "Segment Operator",
"example": "member",
"description": "The status of a member's interaction with a conversation. One of the following: has replied or has not replied."
},
"field": {
"enum": [
"conversation"
],
"type": "string",
"title": "Segment Field",
"example": "conversation",
"description": "Segment by interaction with a campaign via Conversations."
},
"value": {
"type": "string",
"title": "Segment Data",
"example": "any",
"description": "The web id value for a specific campaign or 'any' to account for subscribers who have/have not interacted with any campaigns."
},
"condition_type": {
"enum": [
"Conversation"
],
"type": "string",
"x-value": "Conversation"
}
},
"description": "Segment by interaction with a campaign via Conversations."
},
{
"type": "object",
"title": "Date Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"greater",
"less",
"is",
"not",
"blank",
"blank_not",
"within",
"notwithin"
],
"type": "string",
"title": "Segment Operator",
"example": "greater",
"description": "When the event took place: Before, after, is a specific date, is not a specific date, is blank, or is not blank."
},
"extra": {
"type": "string",
"title": "Segment Extra Value",
"example": "2015-01-30",
"description": "When segmenting on 'date' or 'campaign', the date for the segment formatted as YYYY-MM-DD or the web id for the campaign."
},
"field": {
"enum": [
"timestamp_opt",
"info_changed",
"ecomm_date"
],
"type": "string",
"title": "Segment Field",
"example": "timestamp_opt",
"description": "The type of date field to segment on: The opt-in time for a signup, the date the subscriber was last updated, or the date of their last ecomm purchase."
},
"value": {
"type": "string",
"title": "Segment Data",
"example": "date",
"description": "What type of data to segment on: a specific date, a specific campaign, or the last campaign sent."
},
"condition_type": {
"enum": [
"Date"
],
"type": "string",
"x-value": "Date"
}
},
"description": "Segment by a specific date field."
},
{
"type": "object",
"title": "Email Client Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"client_is",
"client_not"
],
"type": "string",
"title": "Segment Operator",
"example": "client_is",
"description": "The operation to determine whether we select clients that match the value, or clients that do not match the value."
},
"field": {
"enum": [
"email_client"
],
"type": "string",
"title": "Segment Field",
"example": "email_client",
"description": "Segment by use of a particular email client."
},
"value": {
"type": "string",
"title": "Segment Data",
"example": "Gmail",
"description": "The name of the email client."
},
"condition_type": {
"enum": [
"EmailClient"
],
"type": "string",
"x-value": "EmailClient"
}
},
"description": "Segment by use of a particular email client."
},
{
"type": "object",
"title": "Language Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"is",
"not"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Whether the member's language is or is not set to a specific language."
},
"field": {
"enum": [
"language"
],
"type": "string",
"title": "Segment Field",
"example": "language",
"description": "Segmenting based off of a subscriber's language."
},
"value": {
"type": "string",
"title": "Segment Data",
"example": "en",
"description": "A two-letter language identifier."
},
"condition_type": {
"enum": [
"Language"
],
"type": "string",
"x-value": "Language"
}
},
"description": "Segment by language."
},
{
"type": "object",
"title": "Member Rating Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"is",
"not",
"greater",
"less"
],
"type": "string",
"title": "Segment Operator",
"example": "greater",
"description": "Members who have have a rating that is/not exactly a given number or members who have a rating greater/less than a given number."
},
"field": {
"enum": [
"rating"
],
"type": "string",
"title": "Segment Field",
"example": "rating",
"description": "Segment by member rating."
},
"value": {
"type": "number",
"title": "Segment Operator",
"example": 4,
"description": "The star rating number to segment against."
},
"condition_type": {
"enum": [
"MemberRating"
],
"type": "string",
"x-value": "MemberRating"
}
},
"description": "Segment by member rating."
},
{
"type": "object",
"title": "Signup Source Segment",
"required": [
"field",
"condition_type",
"op"
],
"properties": {
"op": {
"enum": [
"source_is",
"source_not"
],
"type": "string",
"title": "Segment Operator",
"example": "source_is",
"description": "Whether the member's signup source was/was not a particular value."
},
"field": {
"enum": [
"source"
],
"type": "string",
"title": "Segment Field",
"example": "source"
},
"value": {
"type": "string",
"title": "Segment Data",
"example": "List Import",
"description": "The signup source."
},
"condition_type": {
"enum": [
"SignupSource"
],
"type": "string",
"title": "Type",
"x-value": "SignupSource"
}
},
"description": "Segment by signup source."
},
{
"type": "object",
"title": "Survey Monkey Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"started",
"completed",
"not_started",
"not_completed"
],
"type": "string",
"title": "Segment Operator",
"example": "started",
"description": "The status of the member with regard to the survey.One of the following: has started the survey, has completed the survey, has not started the survey, or has not completed the survey."
},
"field": {
"enum": [
"survey_monkey"
],
"type": "string",
"title": "Segment Field",
"example": "survey_monkey",
"description": "Segment by interaction with a SurveyMonkey survey."
},
"value": {
"type": "string",
"title": "Survey ID",
"example": "32179586",
"description": "The unique ID of the survey monkey survey."
},
"condition_type": {
"enum": [
"SurveyMonkey"
],
"type": "string",
"x-value": "SurveyMonkey"
}
},
"description": "Segment by interaction with a SurveyMonkey survey."
},
{
"type": "object",
"title": "VIP Segment",
"required": [
"field",
"op"
],
"properties": {
"op": {
"enum": [
"member",
"notmember"
],
"type": "string",
"title": "Segment Operator",
"example": "member",
"description": "Whether the member is or is not marked as VIP."
},
"field": {
"enum": [
"gmonkey"
],
"type": "string",
"title": "Segment Field",
"example": "gmonkey",
"description": "Segment by VIP status."
},
"condition_type": {
"enum": [
"VIP"
],
"type": "string",
"x-value": "VIP"
}
},
"description": "Segment by VIP status."
},
{
"type": "object",
"title": "Interests Segment",
"properties": {
"op": {
"enum": [
"interestcontains",
"interestcontainsall",
"interestnotcontains"
],
"type": "string",
"title": "Segment Operator",
"example": "interestcontains",
"description": "Whether the member is a part of one, all, or none of the groups."
},
"field": {
"type": "string",
"title": "Segment Field",
"example": "interests-123",
"description": "Segmenting based on interest group information. This should start with 'interests-' followed by the grouping id. Ex. 'interests-123'."
},
"value": {
"type": "array",
"items": {
"type": "string",
"example": [
"44401",
"44405",
"44409"
]
},
"title": "Segment Value",
"description": "An array containing strings, each representing a group id."
},
"condition_type": {
"enum": [
"Interests"
],
"type": "string",
"x-value": "Interests"
}
},
"description": "Segment by an interest group merge field."
},
{
"type": "object",
"title": "Ecommerce Category Segment",
"properties": {
"op": {
"enum": [
"is",
"not",
"contains",
"notcontain",
"starts",
"ends"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "A member who has purchased from a category/specific item that is/is not a specific name, where the category/item name contains/doesn't contain a specific phrase or string, or a category/item name that starts/ends with a string."
},
"field": {
"enum": [
"ecomm_cat",
"ecomm_prod"
],
"type": "string",
"title": "Segment Field",
"example": "ecomm_cat",
"description": "Segment by purchases in specific items or categories."
},
"value": {
"type": "string",
"title": "Segment Data",
"example": "Product",
"description": "The ecommerce category/item information."
},
"condition_type": {
"enum": [
"EcommCategory"
],
"type": "string",
"x-value": "EcommCategory"
}
},
"description": "Segment by purchases in specific items or categories."
},
{
"type": "object",
"title": "Ecommerce Number Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"is",
"not",
"greater",
"less"
],
"type": "string",
"title": "Segment Operator",
"example": "greater",
"description": "Members who have spent exactly, have not spent exactly, spent more, or spent less than the segment value."
},
"field": {
"enum": [
"ecomm_spent_avg",
"ecomm_orders",
"ecomm_prod_all",
"ecomm_avg_ord"
],
"type": "string",
"title": "Segment Field",
"example": "ecomm_orders",
"description": "Segment by average spent total, number of orders, total number of products purchased, or average number of products per order."
},
"value": {
"type": "number",
"title": "Segment Operator",
"example": 42,
"description": "Members who have spent exactly, have not spent exactly, spent more, or spent less than this amount."
},
"condition_type": {
"enum": [
"EcommNumber"
],
"type": "string",
"x-value": "EcommNumber"
}
},
"description": "Segment by average spent total, number of orders, total number of products purchased, or average number of products per order."
},
{
"type": "object",
"title": "Ecommerce Purchased Segment",
"properties": {
"op": {
"enum": [
"member",
"notmember"
],
"type": "string",
"title": "Segment Operator",
"example": "member",
"description": "Members who have have ('member') or have not ('notmember') purchased."
},
"field": {
"enum": [
"ecomm_purchased"
],
"type": "string",
"title": "Segment Field",
"example": "ecomm_purchased",
"description": "Segment by whether someone has purchased anything."
},
"condition_type": {
"enum": [
"EcommPurchased"
],
"type": "string",
"x-value": "EcommPurchased"
}
},
"description": "Segment by whether someone has purchased anything."
},
{
"type": "object",
"title": "Ecommerce Spent Segment",
"properties": {
"op": {
"enum": [
"greater",
"less"
],
"type": "string",
"title": "Segment Operator",
"example": "greater",
"description": "Members who have spent 'more' or 'less' than then specified value."
},
"field": {
"enum": [
"ecomm_spent_one",
"ecomm_spent_all"
],
"type": "string",
"title": "Segment Field",
"example": "ecomm_spent_one",
"description": "Segment by amount spent on a single order or across all orders."
},
"value": {
"type": "integer",
"title": "Segment Data",
"example": 42,
"description": "The total amount a member spent."
},
"condition_type": {
"enum": [
"EcommSpent"
],
"type": "string",
"x-value": "EcommSpent"
}
},
"description": "Segment by amount spent on a single order or across all orders."
},
{
"type": "object",
"title": "Ecommerce Purchased Store Segment",
"properties": {
"op": {
"enum": [
"is",
"not"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Members who have or have not purchased from a specific store."
},
"field": {
"enum": [
"ecomm_store"
],
"type": "string",
"title": "Segment Field",
"example": "ecomm_store",
"description": "Segment by purchases from a specific store."
},
"value": {
"type": "string",
"title": "Segment Operator",
"example": "289",
"description": "The store id to segment against."
},
"condition_type": {
"enum": [
"EcommStore"
],
"type": "string",
"x-value": "EcommStore"
}
},
"description": "Segment by purchases from a specific store."
},
{
"type": "object",
"title": "Goal Activity Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"is",
"goal_not",
"contains",
"goal_notcontain",
"starts",
"ends"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Whether the website URL is/not exactly, contains/doesn't contain, starts with/ends with a string."
},
"field": {
"enum": [
"goal"
],
"type": "string",
"title": "Segment Field",
"example": "goal",
"description": "Segment by Goal activity."
},
"value": {
"type": "string",
"title": "Segment Value",
"description": "The URL to check Goal activity against."
},
"condition_type": {
"enum": [
"GoalActivity"
],
"type": "string",
"x-value": "GoalActivity"
}
},
"description": "Segment by Goal activity."
},
{
"type": "object",
"title": "Goal Timestamp Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"greater",
"less",
"is"
],
"type": "string",
"title": "Segment Operator",
"example": "greater",
"description": "Whether the website activity happened after, before, or at a given timestamp."
},
"field": {
"enum": [
"goal_last_visited"
],
"type": "string",
"title": "Segment Field",
"example": "goal_last_visited",
"description": "Segment by most recent interaction with a website."
},
"value": {
"type": "string",
"title": "Segment Value",
"example": "2015-07-20 19:45:21",
"description": "The date to check Goal activity against."
},
"condition_type": {
"enum": [
"GoalTimestamp"
],
"type": "string",
"x-value": "GoalTimestamp"
}
},
"description": "Segment by most recent interaction with a website."
},
{
"type": "object",
"title": "Similar Subscribers Segment Member Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"fuzzy_is",
"fuzzy_not"
],
"type": "string",
"title": "Segment Operator",
"example": "fuzzy_is",
"description": "Members who are/are not apart of a 'similar subscribers' segment."
},
"field": {
"enum": [
"fuzzy_segment"
],
"type": "string",
"title": "Segment Field",
"example": "fuzzy_segment",
"description": "Segment by similar subscribers."
},
"value": {
"type": "number",
"title": "Segment Operator",
"example": 48433,
"description": "The id for the 'similar subscribers' segment."
},
"condition_type": {
"enum": [
"FuzzySegment"
],
"type": "string",
"x-value": "FuzzySegment"
}
},
"description": "Segment by similar subscribers."
},
{
"type": "object",
"title": "Static Segment Member Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"static_is",
"static_not"
],
"type": "string",
"title": "Segment Operator",
"example": "static_is",
"description": "Members who are/are not apart of a static segment."
},
"field": {
"enum": [
"static_segment"
],
"type": "string",
"title": "Segment Field",
"example": "static_segment",
"description": "Segment by a given static segment."
},
"value": {
"type": "number",
"title": "Segment Operator",
"example": 48433,
"description": "The id for the static segment."
},
"condition_type": {
"enum": [
"StaticSegment"
],
"type": "string",
"x-value": "StaticSegment"
}
},
"description": "Segment by a given static segment."
},
{
"type": "object",
"title": "Location-Based Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"ipgeocountry",
"ipgeonotcountry",
"ipgeostate",
"ipgeonotstate"
],
"type": "string",
"title": "Segment Operator",
"example": "ipgeocountry",
"description": "Segment members who are within a specific country or US state."
},
"field": {
"enum": [
"ipgeo"
],
"type": "string",
"title": "Segment Field",
"example": "ipgeo",
"description": "Segmenting subscribers who are within a specific location."
},
"value": {
"type": "string",
"title": "Segment Data",
"example": "US",
"description": "The two-letter country code or US state abbreviation."
},
"condition_type": {
"enum": [
"IPGeoCountryState"
],
"type": "string",
"x-value": "IPGeoCountryState"
}
},
"description": "Segment by a specific country or US state."
},
{
"type": "object",
"title": "Geolocation Segment",
"required": [
"field",
"op",
"value",
"addr",
"lat",
"lng"
],
"properties": {
"op": {
"enum": [
"ipgeoin",
"ipgeonotin"
],
"type": "string",
"title": "Segment Operator",
"example": "ipgeoin",
"description": "Segment members who are within a specific geographic region."
},
"lat": {
"type": "string",
"title": "Segment Location Latitude",
"example": "33.7489954",
"description": "The latitude of the target location."
},
"lng": {
"type": "string",
"title": "Segment Location Longitude",
"example": "-84.3879824",
"description": "The longitude of the target location."
},
"addr": {
"type": "string",
"title": "Segment Location Address",
"example": "Atlanta, GA, USA",
"description": "The address of the target location."
},
"field": {
"enum": [
"ipgeo"
],
"type": "string",
"title": "Segment Field",
"example": "ipgeo",
"description": "Segmenting subscribers who are within a specific location."
},
"value": {
"type": "integer",
"title": "Segment Data",
"example": 42,
"description": "The radius of the target location."
},
"condition_type": {
"enum": [
"IPGeoIn"
],
"type": "string",
"x-value": "IPGeoIn"
}
},
"description": "Segment by a specific geographic region."
},
{
"type": "object",
"title": "US Zip Code Segment",
"required": [
"field",
"op",
"value",
"extra"
],
"properties": {
"op": {
"enum": [
"ipgeoinzip"
],
"type": "string",
"title": "Segment Operator",
"example": "ipgeoinzip",
"description": "Segment members who are within a specific US zip code."
},
"extra": {
"type": "integer",
"title": "Extra Data",
"example": 30318,
"description": "The zip code to segment against."
},
"field": {
"enum": [
"ipgeo"
],
"type": "string",
"title": "Segment Field",
"example": "ipgeo",
"description": "Segmenting subscribers who are within a specific location."
},
"value": {
"type": "integer",
"title": "Segment Data",
"example": 25,
"description": "The radius of the target location."
},
"condition_type": {
"enum": [
"IPGeoInZip"
],
"type": "string",
"x-value": "IPGeoInZip"
}
},
"description": "Segment by a specific US ZIP code."
},
{
"type": "object",
"title": "Unknown Location-Based Segment",
"required": [
"field",
"op"
],
"properties": {
"op": {
"enum": [
"ipgeounknown"
],
"type": "string",
"title": "Segment Operator",
"example": "ipgeounknown",
"description": "Segment members for which location information is unknown."
},
"field": {
"enum": [
"ipgeo"
],
"type": "string",
"title": "Segment Field",
"example": "ipgeo",
"description": "Segmenting subscribers who are within a specific location."
},
"condition_type": {
"enum": [
"IPGeoUnknown"
],
"type": "string",
"x-value": "IPGeoUnknown"
}
},
"description": "Segment members whose location information is unknown."
},
{
"type": "object",
"title": "Zip Code Location-Based Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"ipgeoiszip",
"ipgeonotzip"
],
"type": "string",
"title": "Segment Operator",
"example": "ipgeonotzip",
"description": "Segment members who are/are not within a specific US zip code."
},
"field": {
"enum": [
"ipgeo"
],
"type": "string",
"title": "Segment Field",
"example": "ipgeo",
"description": "Segmenting subscribers who are within a specific location."
},
"value": {
"type": "integer",
"title": "Segment Data",
"example": 30318,
"description": "The 5-digit zip code."
},
"condition_type": {
"enum": [
"IPGeoZip"
],
"type": "string",
"x-value": "IPGeoZip"
}
},
"description": "Segment by a specific US ZIP code."
},
{
"type": "object",
"title": "Social Profiles Age Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"is",
"not"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Members who are/not the exact criteria listed."
},
"field": {
"enum": [
"social_age"
],
"type": "string",
"title": "Segment Field",
"example": "social_age",
"description": "Segment by age ranges in Social Profiles data."
},
"value": {
"enum": [
"18-24",
"25-34",
"35-54",
"55+"
],
"type": "string",
"title": "Segment Operator",
"example": "35-54",
"description": "The age range to segment."
},
"condition_type": {
"enum": [
"SocialAge"
],
"type": "string",
"x-value": "SocialAge"
}
},
"description": "Segment by age ranges in Social Profiles data."
},
{
"type": "object",
"title": "Social Profiles Gender Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"is",
"not"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Members who are/not the exact criteria listed."
},
"field": {
"enum": [
"social_gender"
],
"type": "string",
"title": "Segment Field",
"example": "social_gender",
"description": "Segment by listed gender in Social Profiles data."
},
"value": {
"enum": [
"male",
"female"
],
"type": "string",
"title": "Segment Operator",
"example": "female",
"description": "The Social Profiles gender to segment."
},
"condition_type": {
"enum": [
"SocialGender"
],
"type": "string",
"x-value": "SocialGender"
}
},
"description": "Segment by listed gender in Social Profiles data."
},
{
"type": "object",
"title": "Social Profiles Influence Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"is",
"not",
"greater",
"less"
],
"type": "string",
"title": "Segment Operator",
"example": "greater",
"description": "Members who have a rating that is/not or greater/less than the rating provided."
},
"field": {
"enum": [
"social_influence"
],
"type": "string",
"title": "Segment Field",
"example": "social_influence",
"description": "Segment by influence rating in Social Profiles data."
},
"value": {
"type": "number",
"title": "Segment Operator",
"example": 2,
"description": "The Social Profiles influence rating to segment."
},
"condition_type": {
"enum": [
"SocialInfluence"
],
"type": "string",
"x-value": "SocialInfluence"
}
},
"description": "Segment by influence rating in Social Profiles data."
},
{
"type": "object",
"title": "Social Profiles Social Network Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"member",
"notmember"
],
"type": "string",
"title": "Segment Operator",
"example": "member",
"description": "Members who are/not on a given social network."
},
"field": {
"enum": [
"social_network"
],
"type": "string",
"title": "Segment Field",
"example": "social_network",
"description": "Segment by social network in Social Profiles data."
},
"value": {
"enum": [
"twitter",
"facebook",
"linkedin",
"flickr",
"foursquare",
"lastfm",
"myspace",
"quora",
"vimeo",
"yelp",
"youtube"
],
"type": "string",
"title": "Segment Operator",
"example": "twitter",
"description": "The social network to segment against."
},
"condition_type": {
"enum": [
"SocialNetworkMember"
],
"type": "string",
"x-value": "SocialNetworkMember"
}
},
"description": "Segment by social network in Social Profiles data."
},
{
"type": "object",
"title": "Social Profiles Social Network Follow Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"follow",
"notfollow"
],
"type": "string",
"title": "Segment Operator",
"example": "follow",
"description": "Members who are/not following a linked account on a given social network."
},
"field": {
"enum": [
"social_network"
],
"type": "string",
"title": "Segment Field",
"example": "social_network",
"description": "Segment by social network in Social Profiles data."
},
"value": {
"enum": [
"twitter_follow"
],
"type": "string",
"title": "Segment Operator",
"example": "twitter_follow",
"description": "The social network to segment against."
},
"condition_type": {
"enum": [
"SocialNetworkFollow"
],
"type": "string",
"x-value": "SocialNetworkFollow"
}
},
"description": "Segment by social network in Social Profiles data."
},
{
"type": "object",
"title": "Address Merge Field Segment",
"required": [
"field",
"op"
],
"properties": {
"op": {
"enum": [
"contains",
"notcontain",
"blank",
"blank_not"
],
"type": "string",
"title": "Segment Operator",
"example": "contains",
"description": "Whether the member's address merge field contains/does not contain a value or is/is not blank."
},
"field": {
"type": "string",
"title": "Segment Field",
"example": "MMERGE3",
"description": "An address-type merge field to segment."
},
"value": {
"type": "string",
"title": "Segment Value",
"example": "Atlanta",
"description": "The value to segment a text merge field with."
},
"condition_type": {
"enum": [
"AddressMerge"
],
"type": "string",
"x-value": "AddressMerge"
}
},
"description": "Segment by an address-type merge field."
},
{
"type": "object",
"title": "Address/Zip Merge Field Segment",
"required": [
"field",
"op",
"value",
"extra"
],
"properties": {
"op": {
"enum": [
"geoin"
],
"type": "string",
"title": "Segment Operator",
"example": "geoin",
"description": "Whether the member's address merge field is within a given distance from a city or zip."
},
"extra": {
"type": "string",
"title": "Segment Extra",
"example": "30318",
"description": "The city or the zip being used to segment against."
},
"field": {
"type": "string",
"title": "Segment Field",
"example": "MMERGE2",
"description": "An address or zip-type merge field to segment."
},
"value": {
"type": "string",
"title": "Segment Value",
"example": "25",
"description": "The distance from the city/zip."
},
"condition_type": {
"enum": [
"ZipMerge"
],
"type": "string",
"x-value": "ZipMerge"
}
},
"description": "Segment by an address-type merge field within a given distance."
},
{
"type": "object",
"title": "Birthday Merge Field Segment",
"required": [
"field",
"op"
],
"properties": {
"op": {
"enum": [
"is",
"not",
"blank",
"blank_not"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Whether the member's birthday merge information is/is not a certain date or is/is not blank."
},
"field": {
"type": "string",
"title": "Segment Field",
"example": "MMERGE4",
"description": "A date merge field to segment."
},
"value": {
"type": "string",
"title": "Segment Value",
"example": "01/30",
"description": "A date to segment against (mm/dd)."
},
"condition_type": {
"enum": [
"BirthdayMerge"
],
"type": "string",
"x-value": "BirthdayMerge"
}
},
"description": "Segment by a contact's birthday."
},
{
"type": "object",
"title": "Date Merge Field Segment",
"required": [
"field",
"op"
],
"properties": {
"op": {
"enum": [
"is",
"not",
"less",
"blank",
"blank_not",
"greater"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Whether the member's merge information is/is not, is greater/less than a value or is/is not blank."
},
"field": {
"type": "string",
"title": "Segment Field",
"example": "MMERGE5",
"description": "A date merge field to segment."
},
"value": {
"type": "string",
"title": "Segment Value",
"example": "01/30/2015",
"description": "A date to segment against."
},
"condition_type": {
"enum": [
"DateMerge"
],
"type": "string",
"x-value": "DateMerge"
}
},
"description": "Segment by a given date merge field."
},
{
"type": "object",
"title": "Dropdown/Radio Merge Field Segment",
"required": [
"field",
"op"
],
"properties": {
"op": {
"enum": [
"is",
"not",
"blank",
"blank_not",
"notcontain",
"contains"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Whether the member's merge information is/is not a value or is/is not blank."
},
"field": {
"type": "string",
"title": "Segment Field",
"example": "MMERGE6",
"description": "A merge field to segment."
},
"value": {
"type": "string",
"title": "Segment Value",
"example": "Second Choice",
"description": "The value to segment a text merge field with."
},
"condition_type": {
"enum": [
"SelectMerge"
],
"type": "string",
"x-value": "SelectMerge"
}
},
"description": "An individual segment condition"
},
{
"type": "object",
"title": "Text or Number Merge Field Segment",
"required": [
"field",
"op"
],
"properties": {
"op": {
"enum": [
"is",
"not",
"contains",
"notcontain",
"starts",
"ends",
"greater",
"less",
"blank",
"blank_not"
],
"type": "string",
"title": "Segment Operator",
"example": "contains",
"description": "Whether the member's merge information is/is not, contains/does not contain, starts/ends with, or is greater/less than a value"
},
"field": {
"type": "string",
"title": "Segment Field",
"example": "MMERGE7",
"description": "A text or number merge field to segment."
},
"value": {
"type": "string",
"title": "Segment Value",
"example": "Freddie's Jokes",
"description": "The value to segment a text or number merge field with."
},
"condition_type": {
"enum": [
"TextMerge"
],
"type": "string",
"x-value": "TextMerge"
}
},
"description": "Segment by a given text or number merge field."
},
{
"type": "object",
"title": "Email Segment",
"required": [
"field",
"op"
],
"properties": {
"op": {
"enum": [
"is",
"not",
"contains",
"notcontain",
"starts",
"ends",
"greater",
"less"
],
"type": "string",
"title": "Segment Operator",
"description": "Whether the email address is/not exactly, contains/doesn't contain, starts/ends with a string."
},
"field": {
"enum": [
"merge0",
"EMAIL"
],
"type": "string",
"title": "Segment Field",
"example": "EMAIL",
"description": "Segmenting based off of a subscriber's email address."
},
"value": {
"type": "string",
"title": "Segment Value",
"example": "urist.mcvankab@freddiesjokes.com",
"description": "The value to compare the email against."
},
"condition_type": {
"enum": [
"EmailAddress"
],
"type": "string",
"x-value": "EmailAddress"
}
},
"description": "Segment by email address."
},
{
"type": "object",
"title": "Predicted Gender Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"is",
"not"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Members who are/not the exact criteria listed."
},
"field": {
"enum": [
"predicted_gender"
],
"type": "string",
"title": "Segment Field",
"description": "Segment by predicted gender."
},
"value": {
"enum": [
"male",
"female"
],
"type": "string",
"title": "Segment Operator",
"example": "female",
"description": "The predicted gender to segment."
},
"condition_type": {
"enum": [
"PredictedGender"
],
"type": "string",
"x-value": "PredictedGender"
}
},
"description": "Segment by predicted gender."
},
{
"type": "object",
"title": "Predicted Age Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"is"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Members who are/not the exact criteria listed."
},
"field": {
"enum": [
"predicted_age_range"
],
"type": "string",
"title": "Segment Field",
"description": "Segment by predicted age."
},
"value": {
"enum": [
"18-24",
"25-34",
"35-44",
"45-54",
"55-64",
"65+"
],
"type": "string",
"title": "Segment Operator",
"example": "female",
"description": "The predicted age to segment."
},
"condition_type": {
"enum": [
"PredictedAge"
],
"type": "string",
"x-value": "PredictedAge"
}
},
"description": "Segment by predicted age."
},
{
"type": "object",
"title": "New Subscribers Prebuilt Segment",
"properties": {
"op": {
"enum": [
"date_within"
],
"type": "string",
"title": "Segment Operator",
"description": "Whe the event took place, namely within a time frame."
},
"field": {
"enum": [
"timestamp_opt"
],
"type": "string",
"title": "Segment Field",
"description": "Segment by when people subscribed."
},
"value": {
"type": "string",
"title": "Segment Data",
"description": "What type of data to segment on: a specific date, a specific campaign, or the last campaign sent."
},
"condition_type": {
"enum": [
"NewSubscribers"
],
"type": "string",
"x-value": "NewSubscribers"
}
},
"description": "Segment by when people subscribed."
}
],
"discriminator": {
"type": "string",
"propertyName": "condition_type"
}
},
"title": "Segment Type",
"description": "Segment match conditions. There are multiple possible types, see the [condition types documentation](https://mailchimp.com/developer/marketing/docs/alternative-schemas/#segment-condition-schemas)."
},
"saved_segment_id": {
"type": "integer",
"title": "Saved Segment ID",
"description": "The id for an existing saved segment."
},
"prebuilt_segment_id": {
"type": "string",
"title": "Prebuilt Segment Id",
"example": "subscribers-female",
"description": "The prebuilt segment id, if a prebuilt segment has been designated for this campaign."
}
},
"description": "An object representing all segmentation options. This object should contain a `saved_segment_id` to use an existing segment, or you can create a new segment by including both `match` and `conditions` options."
},
"segment_text": {
"type": "string",
"title": "Segment Text",
"readOnly": true,
"description": "A description of the [segment](https://mailchimp.com/help/getting-started-with-groups/) used for the campaign. Formatted as a string marked up with HTML."
},
"list_is_active": {
"type": "boolean",
"title": "List Status",
"readOnly": true,
"description": "The status of the list used, namely if it's deleted or disabled."
},
"recipient_count": {
"type": "integer",
"title": "Recipient Count",
"readOnly": true,
"description": "Count of the recipients on the associated list. Formatted as an integer."
}
},
"description": "List settings for the campaign."
},
"start_time": {
"type": "string",
"title": "Start Time",
"format": "date-time",
"readOnly": true,
"description": "The date and time the campaign was started in ISO 8601 format."
},
"archive_url": {
"type": "string",
"title": "Archive URL",
"readOnly": true,
"description": "The link to the campaign's archive version in ISO 8601 format."
},
"create_time": {
"type": "string",
"title": "Create Time",
"format": "date-time",
"readOnly": true,
"description": "The date and time the campaign was created in ISO 8601 format."
},
"emails_sent": {
"type": "integer",
"title": "Emails Sent",
"readOnly": true,
"description": "The total number of emails sent for this campaign."
},
"social_card": {
"type": "object",
"title": "Campaign Social Card",
"properties": {
"title": {
"type": "string",
"title": "Title",
"description": "The title for the card. Typically the subject line of the campaign."
},
"image_url": {
"type": "string",
"title": "Image URL",
"description": "The url for the header image for the card."
},
"description": {
"type": "string",
"title": "Campaign Description",
"description": "A short summary of the campaign to display."
}
},
"description": "The preview for the campaign, rendered by social networks like Facebook and Twitter. [Learn more](https://mailchimp.com/help/enable-and-customize-social-cards/)."
},
"workflow_id": {
"type": "string",
"title": "Workflow ID",
"readOnly": true,
"description": "A string that uniquely identifies an Automation workflow."
},
"content_type": {
"type": "string",
"title": "Content Type",
"readOnly": true,
"description": "How the campaign's content is put together ('template', 'drag_and_drop', 'html', 'url')."
},
"report_summary": {
"type": "object",
"title": "Campaign Report Summary",
"properties": {
"opens": {
"type": "integer",
"title": "Automation Opens",
"readOnly": true,
"description": "The total number of opens for a campaign."
},
"clicks": {
"type": "integer",
"title": "Total Clicks",
"readOnly": true,
"description": "The total number of clicks for an campaign."
},
"open_rate": {
"type": "number",
"title": "Open Rate",
"readOnly": true,
"description": "The number of unique opens divided by the total number of successful deliveries."
},
"click_rate": {
"type": "number",
"title": "Click Rate",
"readOnly": true,
"description": "The number of unique clicks divided by the total number of successful deliveries."
},
"unique_opens": {
"type": "integer",
"title": "Unique Opens",
"readOnly": true,
"description": "The number of unique opens."
},
"subscriber_clicks": {
"type": "integer",
"title": "Unique Subscriber Clicks",
"readOnly": true,
"description": "The number of unique clicks."
}
},
"description": "For sent campaigns, a summary of opens and clicks."
},
"trigger_settings": {
"type": "object",
"title": "Automation Trigger",
"required": [
"workflow_type"
],
"properties": {
"runtime": {
"type": "object",
"title": "Automation Workflow Runtime Settings",
"properties": {
"days": {
"type": "array",
"items": {
"enum": [
"sunday",
"monday",
"tuesday",
"wednesday",
"thursday",
"friday",
"saturday"
],
"type": "string"
},
"title": "Days",
"description": "The days an Automation workflow can send."
},
"hours": {
"type": "object",
"title": "Hours",
"required": [
"type"
],
"properties": {
"type": {
"enum": [
"send_asap",
"send_between",
"send_at"
],
"type": "string",
"title": "Email Send Time Settings",
"description": "When to send the Automation email."
}
},
"description": "The hours an Automation workflow can send."
}
},
"description": "A workflow's runtime settings for an Automation."
},
"workflow_type": {
"enum": [
"abandonedBrowse",
"abandonedCart",
"api",
"bestCustomers",
"categoryFollowup",
"dateAdded",
"emailFollowup",
"emailSeries",
"groupAdd",
"groupRemove",
"mandrill",
"productFollowup",
"purchaseFollowup",
"recurringEvent",
"specialEvent",
"visitUrl",
"welcomeSeries"
],
"type": "string",
"title": "Workflow Type",
"description": "The type of Automation workflow."
},
"workflow_title": {
"type": "string",
"title": "Workflow Title",
"readOnly": true,
"description": "The title of the workflow type."
},
"workflow_emails_count": {
"type": "integer",
"title": "Workflow Emails Count",
"readOnly": true,
"description": "The number of emails in the Automation workflow."
}
},
"description": "Available triggers for Automation workflows.",
"discriminator": {
"propertyName": "workflow_type"
}
},
"has_logo_merge_tag": {
"type": "boolean",
"title": "Has Logo Merge Tag",
"example": true,
"readOnly": true,
"description": "Determines if the campaign contains the *|BRAND:LOGO|* merge tag."
},
"needs_block_refresh": {
"type": "boolean",
"title": "Needs Block Refresh",
"example": true,
"readOnly": true,
"description": "Determines if the automation email needs its blocks refreshed by opening the web-based campaign editor."
}
},
"description": "A summary of an individual Automation workflow email."
}
AutomationsGetEmailInfoResponse
{
"type": "object",
"title": "Automation Workflow Email",
"properties": {
"id": {
"type": "string",
"title": "Automation Email ID",
"readOnly": true,
"description": "A string that uniquely identifies the Automation email."
},
"delay": {
"type": "object",
"title": "Automation Delay",
"properties": {
"type": {
"enum": [
"now",
"day",
"hour",
"week"
],
"type": "string",
"title": "Delay Type",
"description": "The type of delay for an Automation email."
},
"action": {
"enum": [
"previous_campaign_sent",
"previous_campaign_opened",
"previous_campaign_not_opened",
"previous_campaign_clicked_any",
"previous_campaign_not_clicked_any",
"previous_campaign_specific_clicked",
"ecomm_bought_any",
"ecomm_bought_product",
"ecomm_bought_category",
"ecomm_not_bought_any",
"ecomm_abandoned_cart",
"campaign_sent",
"opened_email",
"not_opened_email",
"clicked_email",
"not_clicked_email",
"campaign_specific_clicked",
"manual",
"signup",
"merge_changed",
"group_add",
"group_remove",
"mandrill_sent",
"mandrill_opened",
"mandrill_clicked",
"mandrill_any",
"api",
"goal",
"annual",
"birthday",
"date",
"date_added",
"tag_add"
],
"type": "string",
"title": "Delay Action",
"description": "The action that triggers the delay of an Automation email."
},
"amount": {
"type": "integer",
"title": "Delay Amount",
"readOnly": true,
"description": "The delay amount for an Automation email."
},
"direction": {
"enum": [
"before",
"after"
],
"type": "string",
"title": "Delay Direction",
"description": "Whether the delay settings describe before or after the delay action of an Automation email."
},
"full_description": {
"type": "string",
"title": "Full Delay Description",
"example": "1 day after subscribers purchase anything from your store",
"readOnly": true,
"description": "The user-friendly description of the delay and trigger action settings for an Automation email."
},
"action_description": {
"type": "string",
"title": "Delay Action Description",
"example": "subscribers purchase anything from your store",
"readOnly": true,
"description": "The user-friendly description of the action that triggers an Automation email."
}
},
"description": "The delay settings for an Automation email."
},
"_links": {
"type": "array",
"items": {
"type": "object",
"title": "Resource Link",
"properties": {
"rel": {
"type": "string",
"title": "Rel",
"readOnly": true,
"description": "As with an HTML 'rel' attribute, this describes the type of link."
},
"href": {
"type": "string",
"title": "Href",
"readOnly": true,
"description": "This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action."
},
"method": {
"enum": [
"GET",
"POST",
"PUT",
"PATCH",
"DELETE",
"OPTIONS",
"HEAD"
],
"type": "string",
"title": "Method",
"readOnly": true,
"description": "The HTTP method that should be used when accessing the URL defined in 'href'."
},
"schema": {
"type": "string",
"title": "Schema",
"readOnly": true,
"description": "For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to."
},
"targetSchema": {
"type": "string",
"title": "Target Schema",
"readOnly": true,
"description": "For GETs, this is a URL representing the schema that the response should conform to."
}
},
"description": "This object represents a link from the resource where it is found to another resource or action that may be performed."
},
"title": "Links",
"readOnly": true,
"description": "A list of link types and descriptions for the API schema documents."
},
"status": {
"enum": [
"save",
"paused",
"sending"
],
"type": "string",
"title": "Campaign Status",
"readOnly": true,
"description": "The current status of the campaign."
},
"web_id": {
"type": "integer",
"title": "Automation Web ID",
"example": 33345484,
"readOnly": true,
"description": "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}`."
},
"position": {
"type": "integer",
"title": "Email Position",
"readOnly": true,
"description": "The position of an Automation email in a workflow."
},
"settings": {
"type": "object",
"title": "Campaign Settings",
"properties": {
"title": {
"type": "string",
"title": "Campaign Title",
"description": "The title of the campaign."
},
"reply_to": {
"type": "string",
"title": "Reply To Address",
"description": "The reply-to email address for the campaign."
},
"from_name": {
"type": "string",
"title": "From Name",
"description": "The 'from' name on the campaign (not an email address)."
},
"auto_tweet": {
"type": "boolean",
"title": "Auto-Tweet",
"description": "Automatically tweet a link to the [campaign archive](https://mailchimp.com/help/about-email-campaign-archives-and-pages/) page when the campaign is sent."
},
"inline_css": {
"type": "boolean",
"title": "Inline CSS",
"description": "Automatically inline the CSS included with the campaign content."
},
"auto_footer": {
"type": "boolean",
"title": "Auto-Footer",
"description": "Automatically append Mailchimp's [default footer](https://mailchimp.com/help/about-campaign-footers/) to the campaign."
},
"fb_comments": {
"type": "boolean",
"title": "Facebook Comments",
"description": "Allows Facebook comments on the campaign (also force-enables the Campaign Archive toolbar). Defaults to `true`."
},
"template_id": {
"type": "integer",
"title": "Template ID",
"description": "The id for the template used in this campaign."
},
"authenticate": {
"type": "boolean",
"title": "Authentication",
"description": "Whether Mailchimp [authenticated](https://mailchimp.com/help/about-email-authentication/) the campaign. Defaults to `true`."
},
"auto_fb_post": {
"type": "array",
"items": {
"type": "string"
},
"title": "Auto Post to Facebook",
"description": "An array of [Facebook](https://mailchimp.com/help/connect-or-disconnect-the-facebook-integration/) page ids to auto-post to."
},
"preview_text": {
"type": "string",
"title": "Campaign Preview Text",
"description": "The preview text for the campaign."
},
"subject_line": {
"type": "string",
"title": "Campaign Subject Line",
"description": "The subject line for the campaign."
},
"drag_and_drop": {
"type": "boolean",
"title": "Drag And Drop Campaign",
"readOnly": true,
"description": "Whether the campaign uses the drag-and-drop editor."
}
},
"description": "Settings for the campaign including the email subject, from name, and from email address."
},
"tracking": {
"type": "object",
"title": "Campaign Tracking Options",
"properties": {
"opens": {
"type": "boolean",
"title": "Opens",
"description": "Whether to [track opens](https://mailchimp.com/help/about-open-tracking/). Defaults to `true`."
},
"capsule": {
"type": "object",
"title": "Capsule CRM Tracking",
"properties": {
"notes": {
"type": "boolean",
"title": "Capsule Note",
"description": "Update contact notes for a campaign based on a subscriber's email address."
}
},
"description": "Deprecated"
},
"ecomm360": {
"type": "boolean",
"title": "E-commerce Tracking",
"description": "Whether to enable e-commerce tracking."
},
"clicktale": {
"type": "string",
"title": "ClickTale Analytics Tracking",
"description": "The custom slug for [Click Tale](https://mailchimp.com/help/additional-tracking-options-for-campaigns/) tracking (max of 50 bytes)."
},
"salesforce": {
"type": "object",
"title": "Salesforce CRM Tracking",
"properties": {
"notes": {
"type": "boolean",
"title": "Salesforce Note",
"description": "Update contact notes for a campaign based on a subscriber's email address."
},
"campaign": {
"type": "boolean",
"title": "Salesforce Campaign",
"description": "Create a campaign in a connected Salesforce account."
}
},
"description": "Deprecated"
},
"html_clicks": {
"type": "boolean",
"title": "HTML Click Tracking",
"description": "Whether to [track clicks](https://mailchimp.com/help/enable-and-view-click-tracking/) in the HTML version of the campaign. Defaults to `true`."
},
"text_clicks": {
"type": "boolean",
"title": "Plain-Text Click Tracking",
"description": "Whether to [track clicks](https://mailchimp.com/help/enable-and-view-click-tracking/) in the plain-text version of the campaign. Defaults to `true`."
},
"goal_tracking": {
"type": "boolean",
"title": "Mailchimp Goal Tracking",
"description": "Deprecated"
},
"google_analytics": {
"type": "string",
"title": "Google Analytics Tracking",
"description": "The custom slug for [Google Analytics](https://mailchimp.com/help/integrate-google-analytics-with-mailchimp/) tracking (max of 50 bytes)."
}
},
"description": "The tracking options for a campaign."
},
"send_time": {
"type": "string",
"title": "Send Time",
"format": "date-time",
"readOnly": true,
"description": " The date and time a campaign was sent in ISO 8601 format"
},
"recipients": {
"type": "object",
"title": "List",
"properties": {
"list_id": {
"type": "string",
"title": "List ID",
"description": "The unique list id."
},
"list_name": {
"type": "string",
"title": "List Name",
"readOnly": true,
"description": "The name of the list."
},
"segment_opts": {
"type": "object",
"title": "Segment Options",
"properties": {
"match": {
"enum": [
"any",
"all"
],
"type": "string",
"title": "Match Type",
"description": "Segment match type."
},
"conditions": {
"type": "array",
"items": {
"oneOf": [
{
"type": "object",
"title": "Aim Segment",
"properties": {
"op": {
"enum": [
"open",
"click",
"sent",
"noopen",
"noclick",
"nosent"
],
"type": "string",
"title": "Segment Operator",
"example": "open",
"description": "The status of the member with regard to their campaign interaction. One of the following: opened, clicked, was sent, didn't open, didn't click, or was not sent."
},
"field": {
"enum": [
"aim"
],
"type": "string",
"title": "Segment Field",
"example": "aim",
"description": "Segment by interaction with a specific campaign."
},
"value": {
"type": "string",
"title": "Segment Data",
"example": "any",
"description": "Either the web id value for a specific campaign or 'any' to account for subscribers who have/have not interacted with any campaigns."
},
"condition_type": {
"enum": [
"Aim"
],
"type": "string",
"x-value": "Aim"
}
},
"description": "Segment by interaction with a specific campaign."
},
{
"type": "object",
"title": "Automation Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"started",
"completed",
"not_started",
"not_completed"
],
"type": "string",
"title": "Segment Operator",
"example": "started",
"description": "The status of the member with regard to the automation workflow. One of the following: has started the workflow, has completed the workflow, has not started the workflow, or has not completed the workflow."
},
"field": {
"enum": [
"automation"
],
"type": "string",
"title": "Segment Field",
"example": "automation",
"description": "Segment by interaction with an Automation workflow."
},
"value": {
"type": "string",
"title": "Segment Data",
"example": "2135217",
"description": "The web id for the automation workflow to segment against."
},
"condition_type": {
"enum": [
"Automation"
],
"type": "string",
"x-value": "Automation"
}
},
"description": "Segment by interaction with an Automation workflow."
},
{
"type": "object",
"title": "Poll Activity Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"member",
"notmember"
],
"type": "string",
"title": "Segment Operator",
"example": "member",
"description": "Members have/have not interacted with a specific poll in a Mailchimp email."
},
"field": {
"enum": [
"poll"
],
"type": "string",
"title": "Segment Field",
"example": "poll",
"description": "Segment by poll activity."
},
"value": {
"type": "number",
"title": "Segment Operator",
"example": 409,
"description": "The id for the poll."
},
"condition_type": {
"enum": [
"CampaignPoll"
],
"type": "string",
"x-value": "CampaignPoll"
}
},
"description": "Segment by poll activity."
},
{
"type": "object",
"title": "Conversation Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"member",
"notmember"
],
"type": "string",
"title": "Segment Operator",
"example": "member",
"description": "The status of a member's interaction with a conversation. One of the following: has replied or has not replied."
},
"field": {
"enum": [
"conversation"
],
"type": "string",
"title": "Segment Field",
"example": "conversation",
"description": "Segment by interaction with a campaign via Conversations."
},
"value": {
"type": "string",
"title": "Segment Data",
"example": "any",
"description": "The web id value for a specific campaign or 'any' to account for subscribers who have/have not interacted with any campaigns."
},
"condition_type": {
"enum": [
"Conversation"
],
"type": "string",
"x-value": "Conversation"
}
},
"description": "Segment by interaction with a campaign via Conversations."
},
{
"type": "object",
"title": "Date Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"greater",
"less",
"is",
"not",
"blank",
"blank_not",
"within",
"notwithin"
],
"type": "string",
"title": "Segment Operator",
"example": "greater",
"description": "When the event took place: Before, after, is a specific date, is not a specific date, is blank, or is not blank."
},
"extra": {
"type": "string",
"title": "Segment Extra Value",
"example": "2015-01-30",
"description": "When segmenting on 'date' or 'campaign', the date for the segment formatted as YYYY-MM-DD or the web id for the campaign."
},
"field": {
"enum": [
"timestamp_opt",
"info_changed",
"ecomm_date"
],
"type": "string",
"title": "Segment Field",
"example": "timestamp_opt",
"description": "The type of date field to segment on: The opt-in time for a signup, the date the subscriber was last updated, or the date of their last ecomm purchase."
},
"value": {
"type": "string",
"title": "Segment Data",
"example": "date",
"description": "What type of data to segment on: a specific date, a specific campaign, or the last campaign sent."
},
"condition_type": {
"enum": [
"Date"
],
"type": "string",
"x-value": "Date"
}
},
"description": "Segment by a specific date field."
},
{
"type": "object",
"title": "Email Client Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"client_is",
"client_not"
],
"type": "string",
"title": "Segment Operator",
"example": "client_is",
"description": "The operation to determine whether we select clients that match the value, or clients that do not match the value."
},
"field": {
"enum": [
"email_client"
],
"type": "string",
"title": "Segment Field",
"example": "email_client",
"description": "Segment by use of a particular email client."
},
"value": {
"type": "string",
"title": "Segment Data",
"example": "Gmail",
"description": "The name of the email client."
},
"condition_type": {
"enum": [
"EmailClient"
],
"type": "string",
"x-value": "EmailClient"
}
},
"description": "Segment by use of a particular email client."
},
{
"type": "object",
"title": "Language Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"is",
"not"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Whether the member's language is or is not set to a specific language."
},
"field": {
"enum": [
"language"
],
"type": "string",
"title": "Segment Field",
"example": "language",
"description": "Segmenting based off of a subscriber's language."
},
"value": {
"type": "string",
"title": "Segment Data",
"example": "en",
"description": "A two-letter language identifier."
},
"condition_type": {
"enum": [
"Language"
],
"type": "string",
"x-value": "Language"
}
},
"description": "Segment by language."
},
{
"type": "object",
"title": "Member Rating Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"is",
"not",
"greater",
"less"
],
"type": "string",
"title": "Segment Operator",
"example": "greater",
"description": "Members who have have a rating that is/not exactly a given number or members who have a rating greater/less than a given number."
},
"field": {
"enum": [
"rating"
],
"type": "string",
"title": "Segment Field",
"example": "rating",
"description": "Segment by member rating."
},
"value": {
"type": "number",
"title": "Segment Operator",
"example": 4,
"description": "The star rating number to segment against."
},
"condition_type": {
"enum": [
"MemberRating"
],
"type": "string",
"x-value": "MemberRating"
}
},
"description": "Segment by member rating."
},
{
"type": "object",
"title": "Signup Source Segment",
"required": [
"field",
"condition_type",
"op"
],
"properties": {
"op": {
"enum": [
"source_is",
"source_not"
],
"type": "string",
"title": "Segment Operator",
"example": "source_is",
"description": "Whether the member's signup source was/was not a particular value."
},
"field": {
"enum": [
"source"
],
"type": "string",
"title": "Segment Field",
"example": "source"
},
"value": {
"type": "string",
"title": "Segment Data",
"example": "List Import",
"description": "The signup source."
},
"condition_type": {
"enum": [
"SignupSource"
],
"type": "string",
"title": "Type",
"x-value": "SignupSource"
}
},
"description": "Segment by signup source."
},
{
"type": "object",
"title": "Survey Monkey Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"started",
"completed",
"not_started",
"not_completed"
],
"type": "string",
"title": "Segment Operator",
"example": "started",
"description": "The status of the member with regard to the survey.One of the following: has started the survey, has completed the survey, has not started the survey, or has not completed the survey."
},
"field": {
"enum": [
"survey_monkey"
],
"type": "string",
"title": "Segment Field",
"example": "survey_monkey",
"description": "Segment by interaction with a SurveyMonkey survey."
},
"value": {
"type": "string",
"title": "Survey ID",
"example": "32179586",
"description": "The unique ID of the survey monkey survey."
},
"condition_type": {
"enum": [
"SurveyMonkey"
],
"type": "string",
"x-value": "SurveyMonkey"
}
},
"description": "Segment by interaction with a SurveyMonkey survey."
},
{
"type": "object",
"title": "VIP Segment",
"required": [
"field",
"op"
],
"properties": {
"op": {
"enum": [
"member",
"notmember"
],
"type": "string",
"title": "Segment Operator",
"example": "member",
"description": "Whether the member is or is not marked as VIP."
},
"field": {
"enum": [
"gmonkey"
],
"type": "string",
"title": "Segment Field",
"example": "gmonkey",
"description": "Segment by VIP status."
},
"condition_type": {
"enum": [
"VIP"
],
"type": "string",
"x-value": "VIP"
}
},
"description": "Segment by VIP status."
},
{
"type": "object",
"title": "Interests Segment",
"properties": {
"op": {
"enum": [
"interestcontains",
"interestcontainsall",
"interestnotcontains"
],
"type": "string",
"title": "Segment Operator",
"example": "interestcontains",
"description": "Whether the member is a part of one, all, or none of the groups."
},
"field": {
"type": "string",
"title": "Segment Field",
"example": "interests-123",
"description": "Segmenting based on interest group information. This should start with 'interests-' followed by the grouping id. Ex. 'interests-123'."
},
"value": {
"type": "array",
"items": {
"type": "string",
"example": [
"44401",
"44405",
"44409"
]
},
"title": "Segment Value",
"description": "An array containing strings, each representing a group id."
},
"condition_type": {
"enum": [
"Interests"
],
"type": "string",
"x-value": "Interests"
}
},
"description": "Segment by an interest group merge field."
},
{
"type": "object",
"title": "Ecommerce Category Segment",
"properties": {
"op": {
"enum": [
"is",
"not",
"contains",
"notcontain",
"starts",
"ends"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "A member who has purchased from a category/specific item that is/is not a specific name, where the category/item name contains/doesn't contain a specific phrase or string, or a category/item name that starts/ends with a string."
},
"field": {
"enum": [
"ecomm_cat",
"ecomm_prod"
],
"type": "string",
"title": "Segment Field",
"example": "ecomm_cat",
"description": "Segment by purchases in specific items or categories."
},
"value": {
"type": "string",
"title": "Segment Data",
"example": "Product",
"description": "The ecommerce category/item information."
},
"condition_type": {
"enum": [
"EcommCategory"
],
"type": "string",
"x-value": "EcommCategory"
}
},
"description": "Segment by purchases in specific items or categories."
},
{
"type": "object",
"title": "Ecommerce Number Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"is",
"not",
"greater",
"less"
],
"type": "string",
"title": "Segment Operator",
"example": "greater",
"description": "Members who have spent exactly, have not spent exactly, spent more, or spent less than the segment value."
},
"field": {
"enum": [
"ecomm_spent_avg",
"ecomm_orders",
"ecomm_prod_all",
"ecomm_avg_ord"
],
"type": "string",
"title": "Segment Field",
"example": "ecomm_orders",
"description": "Segment by average spent total, number of orders, total number of products purchased, or average number of products per order."
},
"value": {
"type": "number",
"title": "Segment Operator",
"example": 42,
"description": "Members who have spent exactly, have not spent exactly, spent more, or spent less than this amount."
},
"condition_type": {
"enum": [
"EcommNumber"
],
"type": "string",
"x-value": "EcommNumber"
}
},
"description": "Segment by average spent total, number of orders, total number of products purchased, or average number of products per order."
},
{
"type": "object",
"title": "Ecommerce Purchased Segment",
"properties": {
"op": {
"enum": [
"member",
"notmember"
],
"type": "string",
"title": "Segment Operator",
"example": "member",
"description": "Members who have have ('member') or have not ('notmember') purchased."
},
"field": {
"enum": [
"ecomm_purchased"
],
"type": "string",
"title": "Segment Field",
"example": "ecomm_purchased",
"description": "Segment by whether someone has purchased anything."
},
"condition_type": {
"enum": [
"EcommPurchased"
],
"type": "string",
"x-value": "EcommPurchased"
}
},
"description": "Segment by whether someone has purchased anything."
},
{
"type": "object",
"title": "Ecommerce Spent Segment",
"properties": {
"op": {
"enum": [
"greater",
"less"
],
"type": "string",
"title": "Segment Operator",
"example": "greater",
"description": "Members who have spent 'more' or 'less' than then specified value."
},
"field": {
"enum": [
"ecomm_spent_one",
"ecomm_spent_all"
],
"type": "string",
"title": "Segment Field",
"example": "ecomm_spent_one",
"description": "Segment by amount spent on a single order or across all orders."
},
"value": {
"type": "integer",
"title": "Segment Data",
"example": 42,
"description": "The total amount a member spent."
},
"condition_type": {
"enum": [
"EcommSpent"
],
"type": "string",
"x-value": "EcommSpent"
}
},
"description": "Segment by amount spent on a single order or across all orders."
},
{
"type": "object",
"title": "Ecommerce Purchased Store Segment",
"properties": {
"op": {
"enum": [
"is",
"not"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Members who have or have not purchased from a specific store."
},
"field": {
"enum": [
"ecomm_store"
],
"type": "string",
"title": "Segment Field",
"example": "ecomm_store",
"description": "Segment by purchases from a specific store."
},
"value": {
"type": "string",
"title": "Segment Operator",
"example": "289",
"description": "The store id to segment against."
},
"condition_type": {
"enum": [
"EcommStore"
],
"type": "string",
"x-value": "EcommStore"
}
},
"description": "Segment by purchases from a specific store."
},
{
"type": "object",
"title": "Goal Activity Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"is",
"goal_not",
"contains",
"goal_notcontain",
"starts",
"ends"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Whether the website URL is/not exactly, contains/doesn't contain, starts with/ends with a string."
},
"field": {
"enum": [
"goal"
],
"type": "string",
"title": "Segment Field",
"example": "goal",
"description": "Segment by Goal activity."
},
"value": {
"type": "string",
"title": "Segment Value",
"description": "The URL to check Goal activity against."
},
"condition_type": {
"enum": [
"GoalActivity"
],
"type": "string",
"x-value": "GoalActivity"
}
},
"description": "Segment by Goal activity."
},
{
"type": "object",
"title": "Goal Timestamp Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"greater",
"less",
"is"
],
"type": "string",
"title": "Segment Operator",
"example": "greater",
"description": "Whether the website activity happened after, before, or at a given timestamp."
},
"field": {
"enum": [
"goal_last_visited"
],
"type": "string",
"title": "Segment Field",
"example": "goal_last_visited",
"description": "Segment by most recent interaction with a website."
},
"value": {
"type": "string",
"title": "Segment Value",
"example": "2015-07-20 19:45:21",
"description": "The date to check Goal activity against."
},
"condition_type": {
"enum": [
"GoalTimestamp"
],
"type": "string",
"x-value": "GoalTimestamp"
}
},
"description": "Segment by most recent interaction with a website."
},
{
"type": "object",
"title": "Similar Subscribers Segment Member Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"fuzzy_is",
"fuzzy_not"
],
"type": "string",
"title": "Segment Operator",
"example": "fuzzy_is",
"description": "Members who are/are not apart of a 'similar subscribers' segment."
},
"field": {
"enum": [
"fuzzy_segment"
],
"type": "string",
"title": "Segment Field",
"example": "fuzzy_segment",
"description": "Segment by similar subscribers."
},
"value": {
"type": "number",
"title": "Segment Operator",
"example": 48433,
"description": "The id for the 'similar subscribers' segment."
},
"condition_type": {
"enum": [
"FuzzySegment"
],
"type": "string",
"x-value": "FuzzySegment"
}
},
"description": "Segment by similar subscribers."
},
{
"type": "object",
"title": "Static Segment Member Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"static_is",
"static_not"
],
"type": "string",
"title": "Segment Operator",
"example": "static_is",
"description": "Members who are/are not apart of a static segment."
},
"field": {
"enum": [
"static_segment"
],
"type": "string",
"title": "Segment Field",
"example": "static_segment",
"description": "Segment by a given static segment."
},
"value": {
"type": "number",
"title": "Segment Operator",
"example": 48433,
"description": "The id for the static segment."
},
"condition_type": {
"enum": [
"StaticSegment"
],
"type": "string",
"x-value": "StaticSegment"
}
},
"description": "Segment by a given static segment."
},
{
"type": "object",
"title": "Location-Based Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"ipgeocountry",
"ipgeonotcountry",
"ipgeostate",
"ipgeonotstate"
],
"type": "string",
"title": "Segment Operator",
"example": "ipgeocountry",
"description": "Segment members who are within a specific country or US state."
},
"field": {
"enum": [
"ipgeo"
],
"type": "string",
"title": "Segment Field",
"example": "ipgeo",
"description": "Segmenting subscribers who are within a specific location."
},
"value": {
"type": "string",
"title": "Segment Data",
"example": "US",
"description": "The two-letter country code or US state abbreviation."
},
"condition_type": {
"enum": [
"IPGeoCountryState"
],
"type": "string",
"x-value": "IPGeoCountryState"
}
},
"description": "Segment by a specific country or US state."
},
{
"type": "object",
"title": "Geolocation Segment",
"required": [
"field",
"op",
"value",
"addr",
"lat",
"lng"
],
"properties": {
"op": {
"enum": [
"ipgeoin",
"ipgeonotin"
],
"type": "string",
"title": "Segment Operator",
"example": "ipgeoin",
"description": "Segment members who are within a specific geographic region."
},
"lat": {
"type": "string",
"title": "Segment Location Latitude",
"example": "33.7489954",
"description": "The latitude of the target location."
},
"lng": {
"type": "string",
"title": "Segment Location Longitude",
"example": "-84.3879824",
"description": "The longitude of the target location."
},
"addr": {
"type": "string",
"title": "Segment Location Address",
"example": "Atlanta, GA, USA",
"description": "The address of the target location."
},
"field": {
"enum": [
"ipgeo"
],
"type": "string",
"title": "Segment Field",
"example": "ipgeo",
"description": "Segmenting subscribers who are within a specific location."
},
"value": {
"type": "integer",
"title": "Segment Data",
"example": 42,
"description": "The radius of the target location."
},
"condition_type": {
"enum": [
"IPGeoIn"
],
"type": "string",
"x-value": "IPGeoIn"
}
},
"description": "Segment by a specific geographic region."
},
{
"type": "object",
"title": "US Zip Code Segment",
"required": [
"field",
"op",
"value",
"extra"
],
"properties": {
"op": {
"enum": [
"ipgeoinzip"
],
"type": "string",
"title": "Segment Operator",
"example": "ipgeoinzip",
"description": "Segment members who are within a specific US zip code."
},
"extra": {
"type": "integer",
"title": "Extra Data",
"example": 30318,
"description": "The zip code to segment against."
},
"field": {
"enum": [
"ipgeo"
],
"type": "string",
"title": "Segment Field",
"example": "ipgeo",
"description": "Segmenting subscribers who are within a specific location."
},
"value": {
"type": "integer",
"title": "Segment Data",
"example": 25,
"description": "The radius of the target location."
},
"condition_type": {
"enum": [
"IPGeoInZip"
],
"type": "string",
"x-value": "IPGeoInZip"
}
},
"description": "Segment by a specific US ZIP code."
},
{
"type": "object",
"title": "Unknown Location-Based Segment",
"required": [
"field",
"op"
],
"properties": {
"op": {
"enum": [
"ipgeounknown"
],
"type": "string",
"title": "Segment Operator",
"example": "ipgeounknown",
"description": "Segment members for which location information is unknown."
},
"field": {
"enum": [
"ipgeo"
],
"type": "string",
"title": "Segment Field",
"example": "ipgeo",
"description": "Segmenting subscribers who are within a specific location."
},
"condition_type": {
"enum": [
"IPGeoUnknown"
],
"type": "string",
"x-value": "IPGeoUnknown"
}
},
"description": "Segment members whose location information is unknown."
},
{
"type": "object",
"title": "Zip Code Location-Based Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"ipgeoiszip",
"ipgeonotzip"
],
"type": "string",
"title": "Segment Operator",
"example": "ipgeonotzip",
"description": "Segment members who are/are not within a specific US zip code."
},
"field": {
"enum": [
"ipgeo"
],
"type": "string",
"title": "Segment Field",
"example": "ipgeo",
"description": "Segmenting subscribers who are within a specific location."
},
"value": {
"type": "integer",
"title": "Segment Data",
"example": 30318,
"description": "The 5-digit zip code."
},
"condition_type": {
"enum": [
"IPGeoZip"
],
"type": "string",
"x-value": "IPGeoZip"
}
},
"description": "Segment by a specific US ZIP code."
},
{
"type": "object",
"title": "Social Profiles Age Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"is",
"not"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Members who are/not the exact criteria listed."
},
"field": {
"enum": [
"social_age"
],
"type": "string",
"title": "Segment Field",
"example": "social_age",
"description": "Segment by age ranges in Social Profiles data."
},
"value": {
"enum": [
"18-24",
"25-34",
"35-54",
"55+"
],
"type": "string",
"title": "Segment Operator",
"example": "35-54",
"description": "The age range to segment."
},
"condition_type": {
"enum": [
"SocialAge"
],
"type": "string",
"x-value": "SocialAge"
}
},
"description": "Segment by age ranges in Social Profiles data."
},
{
"type": "object",
"title": "Social Profiles Gender Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"is",
"not"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Members who are/not the exact criteria listed."
},
"field": {
"enum": [
"social_gender"
],
"type": "string",
"title": "Segment Field",
"example": "social_gender",
"description": "Segment by listed gender in Social Profiles data."
},
"value": {
"enum": [
"male",
"female"
],
"type": "string",
"title": "Segment Operator",
"example": "female",
"description": "The Social Profiles gender to segment."
},
"condition_type": {
"enum": [
"SocialGender"
],
"type": "string",
"x-value": "SocialGender"
}
},
"description": "Segment by listed gender in Social Profiles data."
},
{
"type": "object",
"title": "Social Profiles Influence Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"is",
"not",
"greater",
"less"
],
"type": "string",
"title": "Segment Operator",
"example": "greater",
"description": "Members who have a rating that is/not or greater/less than the rating provided."
},
"field": {
"enum": [
"social_influence"
],
"type": "string",
"title": "Segment Field",
"example": "social_influence",
"description": "Segment by influence rating in Social Profiles data."
},
"value": {
"type": "number",
"title": "Segment Operator",
"example": 2,
"description": "The Social Profiles influence rating to segment."
},
"condition_type": {
"enum": [
"SocialInfluence"
],
"type": "string",
"x-value": "SocialInfluence"
}
},
"description": "Segment by influence rating in Social Profiles data."
},
{
"type": "object",
"title": "Social Profiles Social Network Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"member",
"notmember"
],
"type": "string",
"title": "Segment Operator",
"example": "member",
"description": "Members who are/not on a given social network."
},
"field": {
"enum": [
"social_network"
],
"type": "string",
"title": "Segment Field",
"example": "social_network",
"description": "Segment by social network in Social Profiles data."
},
"value": {
"enum": [
"twitter",
"facebook",
"linkedin",
"flickr",
"foursquare",
"lastfm",
"myspace",
"quora",
"vimeo",
"yelp",
"youtube"
],
"type": "string",
"title": "Segment Operator",
"example": "twitter",
"description": "The social network to segment against."
},
"condition_type": {
"enum": [
"SocialNetworkMember"
],
"type": "string",
"x-value": "SocialNetworkMember"
}
},
"description": "Segment by social network in Social Profiles data."
},
{
"type": "object",
"title": "Social Profiles Social Network Follow Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"follow",
"notfollow"
],
"type": "string",
"title": "Segment Operator",
"example": "follow",
"description": "Members who are/not following a linked account on a given social network."
},
"field": {
"enum": [
"social_network"
],
"type": "string",
"title": "Segment Field",
"example": "social_network",
"description": "Segment by social network in Social Profiles data."
},
"value": {
"enum": [
"twitter_follow"
],
"type": "string",
"title": "Segment Operator",
"example": "twitter_follow",
"description": "The social network to segment against."
},
"condition_type": {
"enum": [
"SocialNetworkFollow"
],
"type": "string",
"x-value": "SocialNetworkFollow"
}
},
"description": "Segment by social network in Social Profiles data."
},
{
"type": "object",
"title": "Address Merge Field Segment",
"required": [
"field",
"op"
],
"properties": {
"op": {
"enum": [
"contains",
"notcontain",
"blank",
"blank_not"
],
"type": "string",
"title": "Segment Operator",
"example": "contains",
"description": "Whether the member's address merge field contains/does not contain a value or is/is not blank."
},
"field": {
"type": "string",
"title": "Segment Field",
"example": "MMERGE3",
"description": "An address-type merge field to segment."
},
"value": {
"type": "string",
"title": "Segment Value",
"example": "Atlanta",
"description": "The value to segment a text merge field with."
},
"condition_type": {
"enum": [
"AddressMerge"
],
"type": "string",
"x-value": "AddressMerge"
}
},
"description": "Segment by an address-type merge field."
},
{
"type": "object",
"title": "Address/Zip Merge Field Segment",
"required": [
"field",
"op",
"value",
"extra"
],
"properties": {
"op": {
"enum": [
"geoin"
],
"type": "string",
"title": "Segment Operator",
"example": "geoin",
"description": "Whether the member's address merge field is within a given distance from a city or zip."
},
"extra": {
"type": "string",
"title": "Segment Extra",
"example": "30318",
"description": "The city or the zip being used to segment against."
},
"field": {
"type": "string",
"title": "Segment Field",
"example": "MMERGE2",
"description": "An address or zip-type merge field to segment."
},
"value": {
"type": "string",
"title": "Segment Value",
"example": "25",
"description": "The distance from the city/zip."
},
"condition_type": {
"enum": [
"ZipMerge"
],
"type": "string",
"x-value": "ZipMerge"
}
},
"description": "Segment by an address-type merge field within a given distance."
},
{
"type": "object",
"title": "Birthday Merge Field Segment",
"required": [
"field",
"op"
],
"properties": {
"op": {
"enum": [
"is",
"not",
"blank",
"blank_not"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Whether the member's birthday merge information is/is not a certain date or is/is not blank."
},
"field": {
"type": "string",
"title": "Segment Field",
"example": "MMERGE4",
"description": "A date merge field to segment."
},
"value": {
"type": "string",
"title": "Segment Value",
"example": "01/30",
"description": "A date to segment against (mm/dd)."
},
"condition_type": {
"enum": [
"BirthdayMerge"
],
"type": "string",
"x-value": "BirthdayMerge"
}
},
"description": "Segment by a contact's birthday."
},
{
"type": "object",
"title": "Date Merge Field Segment",
"required": [
"field",
"op"
],
"properties": {
"op": {
"enum": [
"is",
"not",
"less",
"blank",
"blank_not",
"greater"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Whether the member's merge information is/is not, is greater/less than a value or is/is not blank."
},
"field": {
"type": "string",
"title": "Segment Field",
"example": "MMERGE5",
"description": "A date merge field to segment."
},
"value": {
"type": "string",
"title": "Segment Value",
"example": "01/30/2015",
"description": "A date to segment against."
},
"condition_type": {
"enum": [
"DateMerge"
],
"type": "string",
"x-value": "DateMerge"
}
},
"description": "Segment by a given date merge field."
},
{
"type": "object",
"title": "Dropdown/Radio Merge Field Segment",
"required": [
"field",
"op"
],
"properties": {
"op": {
"enum": [
"is",
"not",
"blank",
"blank_not",
"notcontain",
"contains"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Whether the member's merge information is/is not a value or is/is not blank."
},
"field": {
"type": "string",
"title": "Segment Field",
"example": "MMERGE6",
"description": "A merge field to segment."
},
"value": {
"type": "string",
"title": "Segment Value",
"example": "Second Choice",
"description": "The value to segment a text merge field with."
},
"condition_type": {
"enum": [
"SelectMerge"
],
"type": "string",
"x-value": "SelectMerge"
}
},
"description": "An individual segment condition"
},
{
"type": "object",
"title": "Text or Number Merge Field Segment",
"required": [
"field",
"op"
],
"properties": {
"op": {
"enum": [
"is",
"not",
"contains",
"notcontain",
"starts",
"ends",
"greater",
"less",
"blank",
"blank_not"
],
"type": "string",
"title": "Segment Operator",
"example": "contains",
"description": "Whether the member's merge information is/is not, contains/does not contain, starts/ends with, or is greater/less than a value"
},
"field": {
"type": "string",
"title": "Segment Field",
"example": "MMERGE7",
"description": "A text or number merge field to segment."
},
"value": {
"type": "string",
"title": "Segment Value",
"example": "Freddie's Jokes",
"description": "The value to segment a text or number merge field with."
},
"condition_type": {
"enum": [
"TextMerge"
],
"type": "string",
"x-value": "TextMerge"
}
},
"description": "Segment by a given text or number merge field."
},
{
"type": "object",
"title": "Email Segment",
"required": [
"field",
"op"
],
"properties": {
"op": {
"enum": [
"is",
"not",
"contains",
"notcontain",
"starts",
"ends",
"greater",
"less"
],
"type": "string",
"title": "Segment Operator",
"description": "Whether the email address is/not exactly, contains/doesn't contain, starts/ends with a string."
},
"field": {
"enum": [
"merge0",
"EMAIL"
],
"type": "string",
"title": "Segment Field",
"example": "EMAIL",
"description": "Segmenting based off of a subscriber's email address."
},
"value": {
"type": "string",
"title": "Segment Value",
"example": "urist.mcvankab@freddiesjokes.com",
"description": "The value to compare the email against."
},
"condition_type": {
"enum": [
"EmailAddress"
],
"type": "string",
"x-value": "EmailAddress"
}
},
"description": "Segment by email address."
},
{
"type": "object",
"title": "Predicted Gender Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"is",
"not"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Members who are/not the exact criteria listed."
},
"field": {
"enum": [
"predicted_gender"
],
"type": "string",
"title": "Segment Field",
"description": "Segment by predicted gender."
},
"value": {
"enum": [
"male",
"female"
],
"type": "string",
"title": "Segment Operator",
"example": "female",
"description": "The predicted gender to segment."
},
"condition_type": {
"enum": [
"PredictedGender"
],
"type": "string",
"x-value": "PredictedGender"
}
},
"description": "Segment by predicted gender."
},
{
"type": "object",
"title": "Predicted Age Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"is"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Members who are/not the exact criteria listed."
},
"field": {
"enum": [
"predicted_age_range"
],
"type": "string",
"title": "Segment Field",
"description": "Segment by predicted age."
},
"value": {
"enum": [
"18-24",
"25-34",
"35-44",
"45-54",
"55-64",
"65+"
],
"type": "string",
"title": "Segment Operator",
"example": "female",
"description": "The predicted age to segment."
},
"condition_type": {
"enum": [
"PredictedAge"
],
"type": "string",
"x-value": "PredictedAge"
}
},
"description": "Segment by predicted age."
},
{
"type": "object",
"title": "New Subscribers Prebuilt Segment",
"properties": {
"op": {
"enum": [
"date_within"
],
"type": "string",
"title": "Segment Operator",
"description": "Whe the event took place, namely within a time frame."
},
"field": {
"enum": [
"timestamp_opt"
],
"type": "string",
"title": "Segment Field",
"description": "Segment by when people subscribed."
},
"value": {
"type": "string",
"title": "Segment Data",
"description": "What type of data to segment on: a specific date, a specific campaign, or the last campaign sent."
},
"condition_type": {
"enum": [
"NewSubscribers"
],
"type": "string",
"x-value": "NewSubscribers"
}
},
"description": "Segment by when people subscribed."
}
],
"discriminator": {
"type": "string",
"propertyName": "condition_type"
}
},
"title": "Segment Type",
"description": "Segment match conditions. There are multiple possible types, see the [condition types documentation](https://mailchimp.com/developer/marketing/docs/alternative-schemas/#segment-condition-schemas)."
},
"saved_segment_id": {
"type": "integer",
"title": "Saved Segment ID",
"description": "The id for an existing saved segment."
},
"prebuilt_segment_id": {
"type": "string",
"title": "Prebuilt Segment Id",
"example": "subscribers-female",
"description": "The prebuilt segment id, if a prebuilt segment has been designated for this campaign."
}
},
"description": "An object representing all segmentation options. This object should contain a `saved_segment_id` to use an existing segment, or you can create a new segment by including both `match` and `conditions` options."
},
"segment_text": {
"type": "string",
"title": "Segment Text",
"readOnly": true,
"description": "A description of the [segment](https://mailchimp.com/help/getting-started-with-groups/) used for the campaign. Formatted as a string marked up with HTML."
},
"list_is_active": {
"type": "boolean",
"title": "List Status",
"readOnly": true,
"description": "The status of the list used, namely if it's deleted or disabled."
},
"recipient_count": {
"type": "integer",
"title": "Recipient Count",
"readOnly": true,
"description": "Count of the recipients on the associated list. Formatted as an integer."
}
},
"description": "List settings for the campaign."
},
"start_time": {
"type": "string",
"title": "Start Time",
"format": "date-time",
"readOnly": true,
"description": "The date and time the campaign was started in ISO 8601 format."
},
"archive_url": {
"type": "string",
"title": "Archive URL",
"readOnly": true,
"description": "The link to the campaign's archive version in ISO 8601 format."
},
"create_time": {
"type": "string",
"title": "Create Time",
"format": "date-time",
"readOnly": true,
"description": "The date and time the campaign was created in ISO 8601 format."
},
"emails_sent": {
"type": "integer",
"title": "Emails Sent",
"readOnly": true,
"description": "The total number of emails sent for this campaign."
},
"social_card": {
"type": "object",
"title": "Campaign Social Card",
"properties": {
"title": {
"type": "string",
"title": "Title",
"description": "The title for the card. Typically the subject line of the campaign."
},
"image_url": {
"type": "string",
"title": "Image URL",
"description": "The url for the header image for the card."
},
"description": {
"type": "string",
"title": "Campaign Description",
"description": "A short summary of the campaign to display."
}
},
"description": "The preview for the campaign, rendered by social networks like Facebook and Twitter. [Learn more](https://mailchimp.com/help/enable-and-customize-social-cards/)."
},
"workflow_id": {
"type": "string",
"title": "Workflow ID",
"readOnly": true,
"description": "A string that uniquely identifies an Automation workflow."
},
"content_type": {
"type": "string",
"title": "Content Type",
"readOnly": true,
"description": "How the campaign's content is put together ('template', 'drag_and_drop', 'html', 'url')."
},
"report_summary": {
"type": "object",
"title": "Campaign Report Summary",
"properties": {
"opens": {
"type": "integer",
"title": "Automation Opens",
"readOnly": true,
"description": "The total number of opens for a campaign."
},
"clicks": {
"type": "integer",
"title": "Total Clicks",
"readOnly": true,
"description": "The total number of clicks for an campaign."
},
"open_rate": {
"type": "number",
"title": "Open Rate",
"readOnly": true,
"description": "The number of unique opens divided by the total number of successful deliveries."
},
"click_rate": {
"type": "number",
"title": "Click Rate",
"readOnly": true,
"description": "The number of unique clicks divided by the total number of successful deliveries."
},
"unique_opens": {
"type": "integer",
"title": "Unique Opens",
"readOnly": true,
"description": "The number of unique opens."
},
"subscriber_clicks": {
"type": "integer",
"title": "Unique Subscriber Clicks",
"readOnly": true,
"description": "The number of unique clicks."
}
},
"description": "For sent campaigns, a summary of opens and clicks."
},
"trigger_settings": {
"type": "object",
"title": "Automation Trigger",
"required": [
"workflow_type"
],
"properties": {
"runtime": {
"type": "object",
"title": "Automation Workflow Runtime Settings",
"properties": {
"days": {
"type": "array",
"items": {
"enum": [
"sunday",
"monday",
"tuesday",
"wednesday",
"thursday",
"friday",
"saturday"
],
"type": "string"
},
"title": "Days",
"description": "The days an Automation workflow can send."
},
"hours": {
"type": "object",
"title": "Hours",
"required": [
"type"
],
"properties": {
"type": {
"enum": [
"send_asap",
"send_between",
"send_at"
],
"type": "string",
"title": "Email Send Time Settings",
"description": "When to send the Automation email."
}
},
"description": "The hours an Automation workflow can send."
}
},
"description": "A workflow's runtime settings for an Automation."
},
"workflow_type": {
"enum": [
"abandonedBrowse",
"abandonedCart",
"api",
"bestCustomers",
"categoryFollowup",
"dateAdded",
"emailFollowup",
"emailSeries",
"groupAdd",
"groupRemove",
"mandrill",
"productFollowup",
"purchaseFollowup",
"recurringEvent",
"specialEvent",
"visitUrl",
"welcomeSeries"
],
"type": "string",
"title": "Workflow Type",
"description": "The type of Automation workflow."
},
"workflow_title": {
"type": "string",
"title": "Workflow Title",
"readOnly": true,
"description": "The title of the workflow type."
},
"workflow_emails_count": {
"type": "integer",
"title": "Workflow Emails Count",
"readOnly": true,
"description": "The number of emails in the Automation workflow."
}
},
"description": "Available triggers for Automation workflows.",
"discriminator": {
"propertyName": "workflow_type"
}
},
"has_logo_merge_tag": {
"type": "boolean",
"title": "Has Logo Merge Tag",
"example": true,
"readOnly": true,
"description": "Determines if the campaign contains the *|BRAND:LOGO|* merge tag."
},
"needs_block_refresh": {
"type": "boolean",
"title": "Needs Block Refresh",
"example": true,
"readOnly": true,
"description": "Determines if the automation email needs its blocks refreshed by opening the web-based campaign editor."
}
},
"description": "A summary of an individual Automation workflow email."
}
AutomationsGetEmailInfodefaultResponse
{
"type": "object",
"title": "Problem Detail Document",
"required": [
"type",
"title",
"status",
"detail",
"instance"
],
"properties": {
"type": {
"type": "string",
"title": "Problem Type",
"example": "https://mailchimp.com/developer/marketing/docs/errors/",
"description": "An absolute URI that identifies the problem type. When dereferenced, it should provide human-readable documentation for the problem type."
},
"title": {
"type": "string",
"title": "Error Title",
"example": "Resource Not Found",
"description": "A short, human-readable summary of the problem type. It shouldn't change based on the occurrence of the problem, except for purposes of localization."
},
"detail": {
"type": "string",
"title": "Error Message",
"example": "The requested resource could not be found.",
"description": "A human-readable explanation specific to this occurrence of the problem. [Learn more about errors](https://mailchimp.com/developer/)."
},
"status": {
"type": "integer",
"title": "HTTP Status Code",
"example": 404,
"description": "The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem."
},
"instance": {
"type": "string",
"title": "Instance ID",
"example": "995c5cb0-3280-4a6e-808b-3b096d0bb219",
"description": "A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support."
}
},
"description": "An error generated by the Mailchimp API. Conforms to IETF draft 'draft-nottingham-http-problem-06'."
}
AutomationsGetRemovedSubscriberInfo200Response
{
"type": "object",
"title": "Subscriber Removed from Automation Workflow",
"properties": {
"id": {
"type": "string",
"title": "Email Hash",
"readOnly": true,
"description": "The MD5 hash of the lowercase version of the list member's email address."
},
"_links": {
"type": "array",
"items": {
"type": "object",
"title": "Resource Link",
"properties": {
"rel": {
"type": "string",
"title": "Rel",
"readOnly": true,
"description": "As with an HTML 'rel' attribute, this describes the type of link."
},
"href": {
"type": "string",
"title": "Href",
"readOnly": true,
"description": "This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action."
},
"method": {
"enum": [
"GET",
"POST",
"PUT",
"PATCH",
"DELETE",
"OPTIONS",
"HEAD"
],
"type": "string",
"title": "Method",
"readOnly": true,
"description": "The HTTP method that should be used when accessing the URL defined in 'href'."
},
"schema": {
"type": "string",
"title": "Schema",
"readOnly": true,
"description": "For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to."
},
"targetSchema": {
"type": "string",
"title": "Target Schema",
"readOnly": true,
"description": "For GETs, this is a URL representing the schema that the response should conform to."
}
},
"description": "This object represents a link from the resource where it is found to another resource or action that may be performed."
},
"title": "Links",
"readOnly": true,
"description": "A list of link types and descriptions for the API schema documents."
},
"list_id": {
"type": "string",
"title": "List ID",
"readOnly": true,
"description": "A string that uniquely identifies a list."
},
"workflow_id": {
"type": "string",
"title": "Workflow ID",
"readOnly": true,
"description": "A string that uniquely identifies an Automation workflow."
},
"email_address": {
"type": "string",
"title": "Email Address",
"description": "The list member's email address."
}
},
"description": "A summary of a subscriber removed from an Automation workflow."
}
AutomationsGetRemovedSubscriberInfoResponse
{
"type": "object",
"title": "Subscriber Removed from Automation Workflow",
"properties": {
"id": {
"type": "string",
"title": "Email Hash",
"readOnly": true,
"description": "The MD5 hash of the lowercase version of the list member's email address."
},
"_links": {
"type": "array",
"items": {
"type": "object",
"title": "Resource Link",
"properties": {
"rel": {
"type": "string",
"title": "Rel",
"readOnly": true,
"description": "As with an HTML 'rel' attribute, this describes the type of link."
},
"href": {
"type": "string",
"title": "Href",
"readOnly": true,
"description": "This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action."
},
"method": {
"enum": [
"GET",
"POST",
"PUT",
"PATCH",
"DELETE",
"OPTIONS",
"HEAD"
],
"type": "string",
"title": "Method",
"readOnly": true,
"description": "The HTTP method that should be used when accessing the URL defined in 'href'."
},
"schema": {
"type": "string",
"title": "Schema",
"readOnly": true,
"description": "For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to."
},
"targetSchema": {
"type": "string",
"title": "Target Schema",
"readOnly": true,
"description": "For GETs, this is a URL representing the schema that the response should conform to."
}
},
"description": "This object represents a link from the resource where it is found to another resource or action that may be performed."
},
"title": "Links",
"readOnly": true,
"description": "A list of link types and descriptions for the API schema documents."
},
"list_id": {
"type": "string",
"title": "List ID",
"readOnly": true,
"description": "A string that uniquely identifies a list."
},
"workflow_id": {
"type": "string",
"title": "Workflow ID",
"readOnly": true,
"description": "A string that uniquely identifies an Automation workflow."
},
"email_address": {
"type": "string",
"title": "Email Address",
"description": "The list member's email address."
}
},
"description": "A summary of a subscriber removed from an Automation workflow."
}
AutomationsGetRemovedSubscriberInfodefaultResponse
{
"type": "object",
"title": "Problem Detail Document",
"required": [
"type",
"title",
"status",
"detail",
"instance"
],
"properties": {
"type": {
"type": "string",
"title": "Problem Type",
"example": "https://mailchimp.com/developer/marketing/docs/errors/",
"description": "An absolute URI that identifies the problem type. When dereferenced, it should provide human-readable documentation for the problem type."
},
"title": {
"type": "string",
"title": "Error Title",
"example": "Resource Not Found",
"description": "A short, human-readable summary of the problem type. It shouldn't change based on the occurrence of the problem, except for purposes of localization."
},
"detail": {
"type": "string",
"title": "Error Message",
"example": "The requested resource could not be found.",
"description": "A human-readable explanation specific to this occurrence of the problem. [Learn more about errors](https://mailchimp.com/developer/)."
},
"status": {
"type": "integer",
"title": "HTTP Status Code",
"example": 404,
"description": "The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem."
},
"instance": {
"type": "string",
"title": "Instance ID",
"example": "995c5cb0-3280-4a6e-808b-3b096d0bb219",
"description": "A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support."
}
},
"description": "An error generated by the Mailchimp API. Conforms to IETF draft 'draft-nottingham-http-problem-06'."
}
AutomationsGetRemovedSubscribers200Response
{
"type": "object",
"title": "Removed Subscribers",
"properties": {
"_links": {
"type": "array",
"items": {
"type": "object",
"title": "Resource Link",
"properties": {
"rel": {
"type": "string",
"title": "Rel",
"readOnly": true,
"description": "As with an HTML 'rel' attribute, this describes the type of link."
},
"href": {
"type": "string",
"title": "Href",
"readOnly": true,
"description": "This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action."
},
"method": {
"enum": [
"GET",
"POST",
"PUT",
"PATCH",
"DELETE",
"OPTIONS",
"HEAD"
],
"type": "string",
"title": "Method",
"readOnly": true,
"description": "The HTTP method that should be used when accessing the URL defined in 'href'."
},
"schema": {
"type": "string",
"title": "Schema",
"readOnly": true,
"description": "For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to."
},
"targetSchema": {
"type": "string",
"title": "Target Schema",
"readOnly": true,
"description": "For GETs, this is a URL representing the schema that the response should conform to."
}
},
"description": "This object represents a link from the resource where it is found to another resource or action that may be performed."
},
"title": "Links",
"readOnly": true,
"description": "A list of link types and descriptions for the API schema documents."
},
"subscribers": {
"type": "array",
"items": {
"type": "object",
"title": "Subscriber Removed from Automation Workflow",
"properties": {
"id": {
"type": "string",
"title": "Email Hash",
"readOnly": true,
"description": "The MD5 hash of the lowercase version of the list member's email address."
},
"_links": {
"type": "array",
"items": {
"type": "object",
"title": "Resource Link",
"properties": {
"rel": {
"type": "string",
"title": "Rel",
"readOnly": true,
"description": "As with an HTML 'rel' attribute, this describes the type of link."
},
"href": {
"type": "string",
"title": "Href",
"readOnly": true,
"description": "This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action."
},
"method": {
"enum": [
"GET",
"POST",
"PUT",
"PATCH",
"DELETE",
"OPTIONS",
"HEAD"
],
"type": "string",
"title": "Method",
"readOnly": true,
"description": "The HTTP method that should be used when accessing the URL defined in 'href'."
},
"schema": {
"type": "string",
"title": "Schema",
"readOnly": true,
"description": "For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to."
},
"targetSchema": {
"type": "string",
"title": "Target Schema",
"readOnly": true,
"description": "For GETs, this is a URL representing the schema that the response should conform to."
}
},
"description": "This object represents a link from the resource where it is found to another resource or action that may be performed."
},
"title": "Links",
"readOnly": true,
"description": "A list of link types and descriptions for the API schema documents."
},
"list_id": {
"type": "string",
"title": "List ID",
"readOnly": true,
"description": "A string that uniquely identifies a list."
},
"workflow_id": {
"type": "string",
"title": "Workflow ID",
"readOnly": true,
"description": "A string that uniquely identifies an Automation workflow."
},
"email_address": {
"type": "string",
"title": "Email Address",
"description": "The list member's email address."
}
},
"description": "A summary of a subscriber removed from an Automation workflow."
},
"title": "Trigger",
"readOnly": true,
"description": "An array of objects, each representing a subscriber who was removed from an Automation workflow."
},
"total_items": {
"type": "integer",
"title": "Item Count",
"readOnly": true,
"description": "The total number of items matching the query regardless of pagination."
},
"workflow_id": {
"type": "string",
"title": "Workflow ID",
"readOnly": true,
"description": "A string that uniquely identifies an Automation workflow."
}
},
"description": "A summary of the subscribers who were removed from an Automation workflow."
}
AutomationsGetRemovedSubscribersResponse
{
"type": "object",
"title": "Removed Subscribers",
"properties": {
"_links": {
"type": "array",
"items": {
"type": "object",
"title": "Resource Link",
"properties": {
"rel": {
"type": "string",
"title": "Rel",
"readOnly": true,
"description": "As with an HTML 'rel' attribute, this describes the type of link."
},
"href": {
"type": "string",
"title": "Href",
"readOnly": true,
"description": "This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action."
},
"method": {
"enum": [
"GET",
"POST",
"PUT",
"PATCH",
"DELETE",
"OPTIONS",
"HEAD"
],
"type": "string",
"title": "Method",
"readOnly": true,
"description": "The HTTP method that should be used when accessing the URL defined in 'href'."
},
"schema": {
"type": "string",
"title": "Schema",
"readOnly": true,
"description": "For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to."
},
"targetSchema": {
"type": "string",
"title": "Target Schema",
"readOnly": true,
"description": "For GETs, this is a URL representing the schema that the response should conform to."
}
},
"description": "This object represents a link from the resource where it is found to another resource or action that may be performed."
},
"title": "Links",
"readOnly": true,
"description": "A list of link types and descriptions for the API schema documents."
},
"subscribers": {
"type": "array",
"items": {
"type": "object",
"title": "Subscriber Removed from Automation Workflow",
"properties": {
"id": {
"type": "string",
"title": "Email Hash",
"readOnly": true,
"description": "The MD5 hash of the lowercase version of the list member's email address."
},
"_links": {
"type": "array",
"items": {
"type": "object",
"title": "Resource Link",
"properties": {
"rel": {
"type": "string",
"title": "Rel",
"readOnly": true,
"description": "As with an HTML 'rel' attribute, this describes the type of link."
},
"href": {
"type": "string",
"title": "Href",
"readOnly": true,
"description": "This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action."
},
"method": {
"enum": [
"GET",
"POST",
"PUT",
"PATCH",
"DELETE",
"OPTIONS",
"HEAD"
],
"type": "string",
"title": "Method",
"readOnly": true,
"description": "The HTTP method that should be used when accessing the URL defined in 'href'."
},
"schema": {
"type": "string",
"title": "Schema",
"readOnly": true,
"description": "For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to."
},
"targetSchema": {
"type": "string",
"title": "Target Schema",
"readOnly": true,
"description": "For GETs, this is a URL representing the schema that the response should conform to."
}
},
"description": "This object represents a link from the resource where it is found to another resource or action that may be performed."
},
"title": "Links",
"readOnly": true,
"description": "A list of link types and descriptions for the API schema documents."
},
"list_id": {
"type": "string",
"title": "List ID",
"readOnly": true,
"description": "A string that uniquely identifies a list."
},
"workflow_id": {
"type": "string",
"title": "Workflow ID",
"readOnly": true,
"description": "A string that uniquely identifies an Automation workflow."
},
"email_address": {
"type": "string",
"title": "Email Address",
"description": "The list member's email address."
}
},
"description": "A summary of a subscriber removed from an Automation workflow."
},
"title": "Trigger",
"readOnly": true,
"description": "An array of objects, each representing a subscriber who was removed from an Automation workflow."
},
"total_items": {
"type": "integer",
"title": "Item Count",
"readOnly": true,
"description": "The total number of items matching the query regardless of pagination."
},
"workflow_id": {
"type": "string",
"title": "Workflow ID",
"readOnly": true,
"description": "A string that uniquely identifies an Automation workflow."
}
},
"description": "A summary of the subscribers who were removed from an Automation workflow."
}
AutomationsGetRemovedSubscribersdefaultResponse
{
"type": "object",
"title": "Problem Detail Document",
"required": [
"type",
"title",
"status",
"detail",
"instance"
],
"properties": {
"type": {
"type": "string",
"title": "Problem Type",
"example": "https://mailchimp.com/developer/marketing/docs/errors/",
"description": "An absolute URI that identifies the problem type. When dereferenced, it should provide human-readable documentation for the problem type."
},
"title": {
"type": "string",
"title": "Error Title",
"example": "Resource Not Found",
"description": "A short, human-readable summary of the problem type. It shouldn't change based on the occurrence of the problem, except for purposes of localization."
},
"detail": {
"type": "string",
"title": "Error Message",
"example": "The requested resource could not be found.",
"description": "A human-readable explanation specific to this occurrence of the problem. [Learn more about errors](https://mailchimp.com/developer/)."
},
"status": {
"type": "integer",
"title": "HTTP Status Code",
"example": 404,
"description": "The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem."
},
"instance": {
"type": "string",
"title": "Instance ID",
"example": "995c5cb0-3280-4a6e-808b-3b096d0bb219",
"description": "A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support."
}
},
"description": "An error generated by the Mailchimp API. Conforms to IETF draft 'draft-nottingham-http-problem-06'."
}
AutomationsListQueueEmails200Response
{
"type": "object",
"properties": {
"queue": {
"type": "array",
"items": {
"type": "object",
"title": "Subscriber in Automation Queue",
"required": [
"email_address"
],
"properties": {
"id": {
"type": "string",
"title": "Email Hash",
"readOnly": true,
"description": "The MD5 hash of the lowercase version of the list member's email address."
},
"_links": {
"type": "array",
"items": {
"type": "object",
"title": "Resource Link",
"properties": {
"rel": {
"type": "string",
"title": "Rel",
"readOnly": true,
"description": "As with an HTML 'rel' attribute, this describes the type of link."
},
"href": {
"type": "string",
"title": "Href",
"readOnly": true,
"description": "This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action."
},
"method": {
"enum": [
"GET",
"POST",
"PUT",
"PATCH",
"DELETE",
"OPTIONS",
"HEAD"
],
"type": "string",
"title": "Method",
"readOnly": true,
"description": "The HTTP method that should be used when accessing the URL defined in 'href'."
},
"schema": {
"type": "string",
"title": "Schema",
"readOnly": true,
"description": "For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to."
},
"targetSchema": {
"type": "string",
"title": "Target Schema",
"readOnly": true,
"description": "For GETs, this is a URL representing the schema that the response should conform to."
}
},
"description": "This object represents a link from the resource where it is found to another resource or action that may be performed."
},
"title": "Links",
"readOnly": true,
"description": "A list of link types and descriptions for the API schema documents."
},
"list_id": {
"type": "string",
"title": "List ID",
"readOnly": true,
"description": "A string that uniquely identifies a list."
},
"email_id": {
"type": "string",
"title": "Automation Email ID",
"readOnly": true,
"description": "A string that uniquely identifies an email in an Automation workflow."
},
"next_send": {
"type": "string",
"title": "Next Send",
"format": "date-time",
"readOnly": true,
"description": "The date and time of the next send for the workflow email in ISO 8601 format."
},
"workflow_id": {
"type": "string",
"title": "Workflow ID",
"readOnly": true,
"description": "A string that uniquely identifies an Automation workflow."
},
"email_address": {
"type": "string",
"title": "Email Address",
"description": "The list member's email address."
}
},
"description": "Information about subscribers in an Automation email queue."
},
"title": "Trigger",
"readOnly": true,
"description": "An array of objects, each representing a subscriber queue for an email in an Automation workflow."
},
"_links": {
"type": "array",
"items": {
"type": "object",
"title": "Resource Link",
"properties": {
"rel": {
"type": "string",
"title": "Rel",
"readOnly": true,
"description": "As with an HTML 'rel' attribute, this describes the type of link."
},
"href": {
"type": "string",
"title": "Href",
"readOnly": true,
"description": "This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action."
},
"method": {
"enum": [
"GET",
"POST",
"PUT",
"PATCH",
"DELETE",
"OPTIONS",
"HEAD"
],
"type": "string",
"title": "Method",
"readOnly": true,
"description": "The HTTP method that should be used when accessing the URL defined in 'href'."
},
"schema": {
"type": "string",
"title": "Schema",
"readOnly": true,
"description": "For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to."
},
"targetSchema": {
"type": "string",
"title": "Target Schema",
"readOnly": true,
"description": "For GETs, this is a URL representing the schema that the response should conform to."
}
},
"description": "This object represents a link from the resource where it is found to another resource or action that may be performed."
},
"title": "Links",
"readOnly": true,
"description": "A list of link types and descriptions for the API schema documents."
},
"email_id": {
"type": "string",
"title": "Automation Email ID",
"readOnly": true,
"description": "A string that uniquely identifies an email in an Automation workflow."
},
"total_items": {
"type": "integer",
"title": "Item Count",
"readOnly": true,
"description": "The total number of items matching the query regardless of pagination."
},
"workflow_id": {
"type": "string",
"title": "Workflow ID",
"readOnly": true,
"description": "A string that uniquely identifies an Automation workflow."
}
},
"description": "An automation workflow"
}
| Version | Endpoints | Schemas | Ingested | Status |
|---|---|---|---|---|
| 3.0.55 | 272 | 828 | 2026-05-11 | current |
| 3.0.55 | 272 | 828 | 2026-04-16 |