Options Entry
type: RecordType
has field: key
has field: value

Generated Mailchimp Type System Projection
comment: This generated ontology is derived by SPARQL from Relay API artifacts. It should be refreshed by the build, not edited by hand.
imports: type-system
source: mailchimp
description: Generated type-system projection materialized from the Mailchimp Relay RDFS ontology and SHACL shapes.
type: Ontology

key
field key kind: identifierFieldKey
key text: key
type: FieldKey

key
is optional: false
max count: 1
min count: 1
field type: string
field key: key
type: Field

key
field key kind: identifierFieldKey
key text: value
type: FieldKey

value
is optional: false
max count: 1
min count: 1
field type: JSON
field key: key
type: Field

Options Record
type: RecordType
has field: entry

entry array
is anonymous: true
array value type: Options Entry
type: ArrayExpression

key
field key kind: identifierFieldKey
key text: entry
type: FieldKey

entry
is optional: true
field type: entry array
field key: key
type: Field

Members Removed Entry
type: RecordType
has field: key
has field: value

key
field key kind: identifierFieldKey
key text: key
type: FieldKey

key
is optional: false
max count: 1
min count: 1
field type: string
field key: key
type: Field

key
field key kind: identifierFieldKey
key text: value
type: FieldKey

value
is optional: false
max count: 1
min count: 1
field type: JSON
field key: key
type: Field

Members Removed Record
type: RecordType
has field: entry

entry array
is anonymous: true
array value type: Members Removed Entry
type: ArrayExpression

key
field key kind: identifierFieldKey
key text: entry
type: FieldKey

entry
is optional: true
field type: entry array
field key: key
type: Field

Members Added Entry
type: RecordType
has field: key
has field: value

key
field key kind: identifierFieldKey
key text: key
type: FieldKey

key
is optional: false
max count: 1
min count: 1
field type: string
field key: key
type: Field

key
field key kind: identifierFieldKey
key text: value
type: FieldKey

value
is optional: false
max count: 1
min count: 1
field type: JSON
field key: key
type: Field

Members Added Record
type: RecordType
has field: entry

entry array
is anonymous: true
array value type: Members Added Entry
type: ArrayExpression

key
field key kind: identifierFieldKey
key text: entry
type: FieldKey

entry
is optional: true
field type: entry array
field key: key
type: Field

Options Entry
type: RecordType
has field: key
has field: value

key
field key kind: identifierFieldKey
key text: key
type: FieldKey

key
is optional: false
max count: 1
min count: 1
field type: string
field key: key
type: Field

key
field key kind: identifierFieldKey
key text: value
type: FieldKey

value
is optional: false
max count: 1
min count: 1
field type: JSON
field key: key
type: Field

Options Record
type: RecordType
has field: entry

entry array
is anonymous: true
array value type: Options Entry
type: ArrayExpression

key
field key kind: identifierFieldKey
key text: entry
type: FieldKey

entry
is optional: true
field type: entry array
field key: key
type: Field

Options Entry
type: RecordType
has field: key
has field: value

key
field key kind: identifierFieldKey
key text: key
type: FieldKey

key
is optional: false
max count: 1
min count: 1
field type: string
field key: key
type: Field

key
field key kind: identifierFieldKey
key text: value
type: FieldKey

value
is optional: false
max count: 1
min count: 1
field type: JSON
field key: key
type: Field

Options Record
type: RecordType
has field: entry

entry array
is anonymous: true
array value type: Options Entry
type: ArrayExpression

key
field key kind: identifierFieldKey
key text: entry
type: FieldKey

entry
is optional: true
field type: entry array
field key: key
type: Field

Merge Fields Entry
type: RecordType
has field: key
has field: value

key
field key kind: identifierFieldKey
key text: key
type: FieldKey

key
is optional: false
max count: 1
min count: 1
field type: string
field key: key
type: Field

key
field key kind: identifierFieldKey
key text: value
type: FieldKey

value
is optional: false
max count: 1
min count: 1
field type: JSON
field key: key
type: Field

Merge Fields Record
type: RecordType
has field: entry

entry array
is anonymous: true
array value type: Merge Fields Entry
type: ArrayExpression

key
field key kind: identifierFieldKey
key text: entry
type: FieldKey

entry
is optional: true
field type: entry array
field key: key
type: Field

Marketing Permissions Entry
type: RecordType
has field: key
has field: value

key
field key kind: identifierFieldKey
key text: key
type: FieldKey

key
is optional: false
max count: 1
min count: 1
field type: string
field key: key
type: Field

key
field key kind: identifierFieldKey
key text: value
type: FieldKey

value
is optional: false
max count: 1
min count: 1
field type: JSON
field key: key
type: Field

Marketing Permissions Record
type: RecordType
has field: entry

entry array
is anonymous: true
array value type: Marketing Permissions Entry
type: ArrayExpression

key
field key kind: identifierFieldKey
key text: entry
type: FieldKey

entry
is optional: true
field type: entry array
field key: key
type: Field

Location Entry
type: RecordType
has field: key
has field: value

key
field key kind: identifierFieldKey
key text: key
type: FieldKey

key
is optional: false
max count: 1
min count: 1
field type: string
field key: key
type: Field

key
field key kind: identifierFieldKey
key text: value
type: FieldKey

value
is optional: false
max count: 1
min count: 1
field type: JSON
field key: key
type: Field

Location Record
type: RecordType
has field: entry

entry array
is anonymous: true
array value type: Location Entry
type: ArrayExpression

key
field key kind: identifierFieldKey
key text: entry
type: FieldKey

entry
is optional: true
field type: entry array
field key: key
type: Field

Interests Entry
type: RecordType
has field: key
has field: value

key
field key kind: identifierFieldKey
key text: key
type: FieldKey

key
is optional: false
max count: 1
min count: 1
field type: string
field key: key
type: Field

key
field key kind: identifierFieldKey
key text: value
type: FieldKey

value
is optional: false
max count: 1
min count: 1
field type: boolean
field key: key
type: Field

Interests Record
type: RecordType
has field: entry

entry array
is anonymous: true
array value type: Interests Entry
type: ArrayExpression

key
field key kind: identifierFieldKey
key text: entry
type: FieldKey

entry
is optional: true
field type: entry array
field key: key
type: Field

Merge Fields Entry
type: RecordType
has field: key
has field: value

key
field key kind: identifierFieldKey
key text: key
type: FieldKey

key
is optional: false
max count: 1
min count: 1
field type: string
field key: key
type: Field

key
field key kind: identifierFieldKey
key text: value
type: FieldKey

value
is optional: false
max count: 1
min count: 1
field type: JSON
field key: key
type: Field

Merge Fields Record
type: RecordType
has field: entry

entry array
is anonymous: true
array value type: Merge Fields Entry
type: ArrayExpression

key
field key kind: identifierFieldKey
key text: entry
type: FieldKey

entry
is optional: true
field type: entry array
field key: key
type: Field

Marketing Permissions Entry
type: RecordType
has field: key
has field: value

key
field key kind: identifierFieldKey
key text: key
type: FieldKey

key
is optional: false
max count: 1
min count: 1
field type: string
field key: key
type: Field

key
field key kind: identifierFieldKey
key text: value
type: FieldKey

value
is optional: false
max count: 1
min count: 1
field type: JSON
field key: key
type: Field

Marketing Permissions Record
type: RecordType
has field: entry

entry array
is anonymous: true
array value type: Marketing Permissions Entry
type: ArrayExpression

key
field key kind: identifierFieldKey
key text: entry
type: FieldKey

entry
is optional: true
field type: entry array
field key: key
type: Field

Location Entry
type: RecordType
has field: key
has field: value

key
field key kind: identifierFieldKey
key text: key
type: FieldKey

key
is optional: false
max count: 1
min count: 1
field type: string
field key: key
type: Field

key
field key kind: identifierFieldKey
key text: value
type: FieldKey

value
is optional: false
max count: 1
min count: 1
field type: JSON
field key: key
type: Field

Location Record
type: RecordType
has field: entry

entry array
is anonymous: true
array value type: Location Entry
type: ArrayExpression

key
field key kind: identifierFieldKey
key text: entry
type: FieldKey

entry
is optional: true
field type: entry array
field key: key
type: Field

Interests Entry
type: RecordType
has field: key
has field: value

key
field key kind: identifierFieldKey
key text: key
type: FieldKey

key
is optional: false
max count: 1
min count: 1
field type: string
field key: key
type: Field

key
field key kind: identifierFieldKey
key text: value
type: FieldKey

value
is optional: false
max count: 1
min count: 1
field type: boolean
field key: key
type: Field

Interests Record
type: RecordType
has field: entry

entry array
is anonymous: true
array value type: Interests Entry
type: ArrayExpression

key
field key kind: identifierFieldKey
key text: entry
type: FieldKey

entry
is optional: true
field type: entry array
field key: key
type: Field

Merge Fields Entry
type: RecordType
has field: key
has field: value

key
field key kind: identifierFieldKey
key text: key
type: FieldKey

key
is optional: false
max count: 1
min count: 1
field type: string
field key: key
type: Field

key
field key kind: identifierFieldKey
key text: value
type: FieldKey

value
is optional: false
max count: 1
min count: 1
field type: JSON
field key: key
type: Field

Merge Fields Record
type: RecordType
has field: entry

entry array
is anonymous: true
array value type: Merge Fields Entry
type: ArrayExpression

key
field key kind: identifierFieldKey
key text: entry
type: FieldKey

entry
is optional: true
field type: entry array
field key: key
type: Field

Marketing Permissions Entry
type: RecordType
has field: key
has field: value

key
field key kind: identifierFieldKey
key text: key
type: FieldKey

key
is optional: false
max count: 1
min count: 1
field type: string
field key: key
type: Field

key
field key kind: identifierFieldKey
key text: value
type: FieldKey

value
is optional: false
max count: 1
min count: 1
field type: JSON
field key: key
type: Field

Marketing Permissions Record
type: RecordType
has field: entry

entry array
is anonymous: true
array value type: Marketing Permissions Entry
type: ArrayExpression

key
field key kind: identifierFieldKey
key text: entry
type: FieldKey

entry
is optional: true
field type: entry array
field key: key
type: Field

Location Entry
type: RecordType
has field: key
has field: value

key
field key kind: identifierFieldKey
key text: key
type: FieldKey

key
is optional: false
max count: 1
min count: 1
field type: string
field key: key
type: Field

key
field key kind: identifierFieldKey
key text: value
type: FieldKey

value
is optional: false
max count: 1
min count: 1
field type: JSON
field key: key
type: Field

Location Record
type: RecordType
has field: entry

entry array
is anonymous: true
array value type: Location Entry
type: ArrayExpression

key
field key kind: identifierFieldKey
key text: entry
type: FieldKey

entry
is optional: true
field type: entry array
field key: key
type: Field

Interests Entry
type: RecordType
has field: key
has field: value

key
field key kind: identifierFieldKey
key text: key
type: FieldKey

key
is optional: false
max count: 1
min count: 1
field type: string
field key: key
type: Field

key
field key kind: identifierFieldKey
key text: value
type: FieldKey

value
is optional: false
max count: 1
min count: 1
field type: boolean
field key: key
type: Field

Interests Record
type: RecordType
has field: entry

entry array
is anonymous: true
array value type: Interests Entry
type: ArrayExpression

key
field key kind: identifierFieldKey
key text: entry
type: FieldKey

entry
is optional: true
field type: entry array
field key: key
type: Field

Merge Fields Entry
type: RecordType
has field: key
has field: value

key
field key kind: identifierFieldKey
key text: key
type: FieldKey

key
is optional: false
max count: 1
min count: 1
field type: string
field key: key
type: Field

key
field key kind: identifierFieldKey
key text: value
type: FieldKey

value
is optional: false
max count: 1
min count: 1
field type: JSON
field key: key
type: Field

Merge Fields Record
type: RecordType
has field: entry

entry array
is anonymous: true
array value type: Merge Fields Entry
type: ArrayExpression

key
field key kind: identifierFieldKey
key text: entry
type: FieldKey

entry
is optional: true
field type: entry array
field key: key
type: Field

Interests Entry
type: RecordType
has field: key
has field: value

key
field key kind: identifierFieldKey
key text: key
type: FieldKey

key
is optional: false
max count: 1
min count: 1
field type: string
field key: key
type: Field

key
field key kind: identifierFieldKey
key text: value
type: FieldKey

value
is optional: false
max count: 1
min count: 1
field type: boolean
field key: key
type: Field

Interests Record
type: RecordType
has field: entry

entry array
is anonymous: true
array value type: Interests Entry
type: ArrayExpression

key
field key kind: identifierFieldKey
key text: entry
type: FieldKey

entry
is optional: true
field type: entry array
field key: key
type: Field

Constraints Entry
type: RecordType
has field: key
has field: value

key
field key kind: identifierFieldKey
key text: key
type: FieldKey

key
is optional: false
max count: 1
min count: 1
field type: string
field key: key
type: Field

key
field key kind: identifierFieldKey
key text: value
type: FieldKey

value
is optional: false
max count: 1
min count: 1
field type: JSON
field key: key
type: Field

Constraints Record
type: RecordType
has field: entry

entry array
is anonymous: true
array value type: Constraints Entry
type: ArrayExpression

key
field key kind: identifierFieldKey
key text: entry
type: FieldKey

entry
is optional: true
field type: entry array
field key: key
type: Field

Updated Members Entry
type: RecordType
has field: key
has field: value

key
field key kind: identifierFieldKey
key text: key
type: FieldKey

key
is optional: false
max count: 1
min count: 1
field type: string
field key: key
type: Field

key
field key kind: identifierFieldKey
key text: value
type: FieldKey

value
is optional: false
max count: 1
min count: 1
field type: JSON
field key: key
type: Field

Updated Members Record
type: RecordType
has field: entry

entry array
is anonymous: true
array value type: Updated Members Entry
type: ArrayExpression

key
field key kind: identifierFieldKey
key text: entry
type: FieldKey

entry
is optional: true
field type: entry array
field key: key
type: Field

New Members Entry
type: RecordType
has field: key
has field: value

key
field key kind: identifierFieldKey
key text: key
type: FieldKey

key
is optional: false
max count: 1
min count: 1
field type: string
field key: key
type: Field

key
field key kind: identifierFieldKey
key text: value
type: FieldKey

value
is optional: false
max count: 1
min count: 1
field type: JSON
field key: key
type: Field

New Members Record
type: RecordType
has field: entry

entry array
is anonymous: true
array value type: New Members Entry
type: ArrayExpression

key
field key kind: identifierFieldKey
key text: entry
type: FieldKey

entry
is optional: true
field type: entry array
field key: key
type: Field

Members Entry
type: RecordType
has field: key
has field: value

key
field key kind: identifierFieldKey
key text: key
type: FieldKey

key
is optional: false
max count: 1
min count: 1
field type: string
field key: key
type: Field

key
field key kind: identifierFieldKey
key text: value
type: FieldKey

value
is optional: false
max count: 1
min count: 1
field type: JSON
field key: key
type: Field

Members Record
type: RecordType
has field: entry

entry array
is anonymous: true
array value type: Members Entry
type: ArrayExpression

key
field key kind: identifierFieldKey
key text: entry
type: FieldKey

entry
is optional: true
field type: entry array
field key: key
type: Field

Batch Delivery Entry
type: RecordType
has field: key
has field: value

key
field key kind: identifierFieldKey
key text: key
type: FieldKey

key
is optional: false
max count: 1
min count: 1
field type: string
field key: key
type: Field

key
field key kind: identifierFieldKey
key text: value
type: FieldKey

value
is optional: false
max count: 1
min count: 1
field type: JSON
field key: key
type: Field

Batch Delivery Record
type: RecordType
has field: entry

entry array
is anonymous: true
array value type: Batch Delivery Entry
type: ArrayExpression

key
field key kind: identifierFieldKey
key text: entry
type: FieldKey

entry
is optional: true
field type: entry array
field key: key
type: Field

email addresses array
is anonymous: true
array value type: string
type: ArrayExpression

key
field key kind: identifierFieldKey
key text: email addresses
type: FieldKey

email addresses
is optional: true
field type: email addresses array
field key: key
type: Field

Errors
has field: email addresses
type: RecordType
has field: error

key
field key kind: identifierFieldKey
key text: error
type: FieldKey

error
is optional: false
max count: 1
min count: 1
field type: string
field key: key
type: Field

key
field key kind: identifierFieldKey
key text: name
type: FieldKey

name
is optional: false
max count: 1
min count: 1
field type: string
field key: key
comment: Tag name. Mailchimp creates the tag if it does not exist.
type: Field

Tags
has field: name
type: RecordType
has field: status

key
field key kind: identifierFieldKey
key text: status
type: FieldKey

status
is optional: false
max count: 1
min count: 1
field type: string
field key: key
comment: `active` to attach, `inactive` to detach.
type: Field

key
field key kind: identifierFieldKey
key text: email address
type: FieldKey

email address
is optional: false
max count: 1
min count: 1
field type: string
field key: key
type: Field

Errors
has field: email address
type: RecordType
has field: error
has field: error code

key
field key kind: identifierFieldKey
key text: error
type: FieldKey

error
is optional: false
max count: 1
min count: 1
field type: string
field key: key
type: Field

key
field key kind: identifierFieldKey
key text: error code
type: FieldKey

error code
is optional: true
max count: 1
field type: string
field key: key
type: Field

key
field key kind: identifierFieldKey
key text: url
type: FieldKey

url
is optional: true
max count: 1
field type: string
field key: key
comment: HTTPS URL Mailchimp will POST events to. Embed any secret token in the URL itself.
type: Field

List Webhook Input
has field: url
comment: Body of `POST /lists/{list_id}/webhooks` and `PATCH /lists/{list_id}/webhooks/{webhook_id}`. Mailchimp documents the same shape on both verbs.
type: RecordType
has field: events
has field: sources

key
field key kind: identifierFieldKey
key text: events
type: FieldKey

events
is optional: true
max count: 1
field type: Webhook Events
field key: key
comment: Per-event-type subscription toggles.
type: Field

key
field key kind: identifierFieldKey
key text: sources
type: FieldKey

sources
is optional: true
max count: 1
field type: Webhook Sources
field key: key
comment: Per-source subscription toggles (user/admin/api).
type: Field

webhooks array
is anonymous: true
array value type: List Webhook
type: ArrayExpression

key
field key kind: identifierFieldKey
key text: webhooks
type: FieldKey

webhooks
is optional: true
field type: webhooks array
field key: key
comment: Webhooks registered on the audience.
type: Field

List Webhook List Response
has field: webhooks
comment: Collection envelope returned by `GET /lists/{list_id}/webhooks`. Mailchimp omits pagination on this endpoint — webhook counts are always small — so there is no `total_items` field documented.
type: RecordType
has field: list id
has field: links

key
field key kind: identifierFieldKey
key text: list id
type: FieldKey

list id
is optional: false
max count: 1
min count: 1
field type: List
field key: key
comment: Parent audience identifier.
type: Field

links array
is anonymous: true
array value type: HALLink
type: ArrayExpression

key
field key kind: identifierFieldKey
key text: links
type: FieldKey

links
is optional: true
field type: links array
field key: key
comment: HATEOAS link descriptors for the collection.
type: Field

key
field key kind: identifierFieldKey
key text: recipients
type: FieldKey

recipients
is optional: false
max count: 1
min count: 1
field type: Automation Recipients
field key: key
comment: Recipient settings: `list_id` and optional segment options.
type: Field

Automation Create Input
has field: recipients
comment: Body of `POST /automations`. Mailchimp documents `recipients` and `trigger_settings` as required; `settings` is optional at create time.
type: RecordType
has field: settings
has field: trigger settings

key
field key kind: identifierFieldKey
key text: settings
type: FieldKey

settings
is optional: true
max count: 1
field type: Automation Settings
field key: key
comment: Workflow-level settings (`from_name`, `reply_to`, etc.).
type: Field

key
field key kind: identifierFieldKey
key text: trigger settings
type: FieldKey

trigger settings
is optional: false
max count: 1
min count: 1
field type: Trigger Settings
field key: key
comment: Trigger configuration that fires this workflow.
type: Field

automations array
is anonymous: true
array value type: Automation
type: ArrayExpression

key
field key kind: identifierFieldKey
key text: automations
type: FieldKey

automations
is optional: true
field type: automations array
field key: key
comment: Workflows in the current page.
type: Field

Automation List Response
has field: automations
comment: Collection envelope returned by `GET /automations`.
type: RecordType
has field: total items
has field: links

key
field key kind: identifierFieldKey
key text: total items
type: FieldKey

total items
is optional: false
max count: 1
min count: 1
field type: unknown
field key: key
comment: Total number of classic automation workflows on the account.
type: Field

links array
is anonymous: true
array value type: HALLink
type: ArrayExpression

key
field key kind: identifierFieldKey
key text: links
type: FieldKey

links
is optional: true
field type: links array
field key: key
comment: HATEOAS link descriptors for the collection.
type: Field

key
field key kind: identifierFieldKey
key text: shortcut type
type: FieldKey

shortcut type
is optional: true
max count: 1
field type: string
field key: key
comment: Which resend shortcut to use. Defaults to `to_non_openers` server-side.
type: Field

Campaign Create Resend Input
has field: shortcut type
comment: Body of `POST /campaigns/{campaign_id}/actions/create-resend`. Optional — defaults to `to_non_openers` when omitted.
type: RecordType

key
field key kind: identifierFieldKey
key text: schedule time
type: FieldKey

schedule time
is optional: false
max count: 1
min count: 1
field type: offsetDateTime
field key: key
comment: UTC ISO 8601 timestamp to schedule the campaign for delivery.
type: Field

Campaign Schedule Input
has field: schedule time
comment: Body of `POST /campaigns/{campaign_id}/actions/schedule`.
type: RecordType
has field: timewarp
has field: batch delivery

key
field key kind: identifierFieldKey
key text: timewarp
type: FieldKey

timewarp
is optional: true
max count: 1
field type: boolean
field key: key
comment: Send across multiple timezones to align with each recipient's local time of day.
type: Field

key
field key kind: identifierFieldKey
key text: batch delivery
type: FieldKey

batch delivery
is optional: true
max count: 1
field type: Batch Delivery Record
field key: key
comment: Trickle-send settings (`batch_count`, `batch_delay`).
type: Field

test emails array
is anonymous: true
array value type: string
type: ArrayExpression

key
field key kind: identifierFieldKey
key text: test emails
type: FieldKey

test emails
is optional: true
field type: test emails array
field key: key
comment: Recipients of the test send. Must be a non-empty array of email addresses.
type: Field

Campaign Test Input
has field: test emails
comment: Body of `POST /campaigns/{campaign_id}/actions/test`. Both fields are required: Mailchimp will not infer a default recipient or rendering type.
type: RecordType
has field: send type

key
field key kind: identifierFieldKey
key text: send type
type: FieldKey

send type
is optional: false
max count: 1
min count: 1
field type: string
field key: key
comment: Whether to send the HTML or plain-text variant.
type: Field

key
field key kind: identifierFieldKey
key text: recipients
type: FieldKey

recipients
is optional: true
max count: 1
field type: Campaign Recipients
field key: key
comment: Recipient settings: `list_id` and optional segment options.
type: Field

Campaign Update Input
has field: recipients
comment: Body of `PATCH /campaigns/{campaign_id}`. Mailchimp requires `settings`; all other top-level groups are optional.
type: RecordType
has field: settings
has field: variate settings
has field: tracking
has field: rss opts
has field: social card

key
field key kind: identifierFieldKey
key text: settings
type: FieldKey

settings
is optional: false
max count: 1
min count: 1
field type: Campaign Settings
field key: key
comment: Campaign settings: subject line, from name, from email, reply-to, etc.
type: Field

key
field key kind: identifierFieldKey
key text: variate settings
type: FieldKey

variate settings
is optional: true
max count: 1
field type: Variate Settings
field key: key
type: Field

key
field key kind: identifierFieldKey
key text: tracking
type: FieldKey

tracking
is optional: true
max count: 1
field type: Campaign Tracking
field key: key
comment: Engagement-tracking toggles.
type: Field

key
field key kind: identifierFieldKey
key text: rss opts
type: FieldKey

rss opts
is optional: true
max count: 1
field type: Rss Opts
field key: key
type: Field

key
field key kind: identifierFieldKey
key text: social card
type: FieldKey

social card
is optional: true
max count: 1
field type: Social Card
field key: key
type: Field

key
field key kind: identifierFieldKey
key text: type
type: FieldKey

type
is optional: false
max count: 1
min count: 1
field type: string
field key: key
comment: Campaign type. One of `regular`, `plaintext`, `absplit`, `rss`, `variate`.
type: Field

Campaign Create Input
has field: type
comment: Body of `POST /campaigns`. Mailchimp requires `type`; recipients, settings, and tracking are all optional at create time but become mandatory before send.
type: RecordType
has field: recipients
has field: settings
has field: variate settings
has field: tracking
has field: rss opts
has field: social card
has field: content type

key
field key kind: identifierFieldKey
key text: recipients
type: FieldKey

recipients
is optional: true
max count: 1
field type: Campaign Recipients
field key: key
comment: Recipient settings: `list_id` and optional segment options.
type: Field

key
field key kind: identifierFieldKey
key text: settings
type: FieldKey

settings
is optional: true
max count: 1
field type: Campaign Settings
field key: key
comment: Campaign settings: subject line, from name, from email, reply-to, etc.
type: Field

key
field key kind: identifierFieldKey
key text: variate settings
type: FieldKey

variate settings
is optional: true
max count: 1
field type: Variate Settings
field key: key
comment: A/B variate settings. Only used when `type = variate`.
type: Field

key
field key kind: identifierFieldKey
key text: tracking
type: FieldKey

tracking
is optional: true
max count: 1
field type: Campaign Tracking
field key: key
comment: Engagement-tracking toggles (opens, clicks, GA, etc.).
type: Field

key
field key kind: identifierFieldKey
key text: rss opts
type: FieldKey

rss opts
is optional: true
max count: 1
field type: Rss Opts
field key: key
comment: RSS feed settings. Only used when `type = rss`.
type: Field

key
field key kind: identifierFieldKey
key text: social card
type: FieldKey

social card
is optional: true
max count: 1
field type: Social Card
field key: key
comment: Social card metadata for archive previews.
type: Field

key
field key kind: identifierFieldKey
key text: content type
type: FieldKey

content type
is optional: true
max count: 1
field type: string
field key: key
comment: Editor used to compose the campaign (`template`, `html`, `url`, `multichannel`).
type: Field

campaigns array
is anonymous: true
array value type: Campaign
type: ArrayExpression

key
field key kind: identifierFieldKey
key text: campaigns
type: FieldKey

campaigns
is optional: true
field type: campaigns array
field key: key
comment: Campaigns in the current page.
type: Field

Campaign List Response
has field: campaigns
comment: Collection envelope returned by `GET /campaigns`.
type: RecordType
has field: total items
has field: links

key
field key kind: identifierFieldKey
key text: total items
type: FieldKey

total items
is optional: false
max count: 1
min count: 1
field type: unknown
field key: key
comment: Total number of campaigns on the account.
type: Field

links array
is anonymous: true
array value type: HALLink
type: ArrayExpression

key
field key kind: identifierFieldKey
key text: links
type: FieldKey

links
is optional: true
field type: links array
field key: key
comment: HATEOAS link descriptors for the collection.
type: Field

key
field key kind: identifierFieldKey
key text: tag
type: FieldKey

tag
is optional: true
max count: 1
field type: string
field key: key
comment: Merge tag short code (e.g. `FNAME`).
type: Field

Merge Field Update Input
has field: tag
comment: Body of `PATCH /lists/{list_id}/merge-fields/{merge_id}`. Mailchimp disallows updating `type` after creation; the field is omitted here.
type: RecordType
has field: name
has field: required
has field: default value
has field: public
has field: display order
has field: options
has field: help text

key
field key kind: identifierFieldKey
key text: name
type: FieldKey

name
is optional: false
max count: 1
min count: 1
field type: string
field key: key
comment: Human-readable merge field name.
type: Field

key
field key kind: identifierFieldKey
key text: required
type: FieldKey

required
is optional: true
max count: 1
field type: boolean
field key: key
comment: Whether subscribers must supply a value for this field.
type: Field

key
field key kind: identifierFieldKey
key text: default value
type: FieldKey

default value
is optional: true
max count: 1
field type: string
field key: key
comment: Default value substituted when the field is empty.
type: Field

key
field key kind: identifierFieldKey
key text: public
type: FieldKey

public
is optional: true
max count: 1
field type: boolean
field key: key
comment: Surface the field on hosted signup forms.
type: Field

key
field key kind: identifierFieldKey
key text: display order
type: FieldKey

display order
is optional: true
max count: 1
field type: unknown
field key: key
comment: Position of the field on hosted signup forms.
type: Field

key
field key kind: identifierFieldKey
key text: options
type: FieldKey

options
is optional: true
max count: 1
field type: Options Record
field key: key
comment: Type-specific options.
type: Field

key
field key kind: identifierFieldKey
key text: help text
type: FieldKey

help text
is optional: true
max count: 1
field type: string
field key: key
comment: Helper text shown beside the field on signup forms.
type: Field

key
field key kind: identifierFieldKey
key text: tag
type: FieldKey

tag
is optional: true
max count: 1
field type: string
field key: key
comment: Merge tag short code used inside campaigns (e.g. `FNAME`). Auto-generated when omitted.
type: Field

Merge Field Create Input
has field: tag
comment: Body of `POST /lists/{list_id}/merge-fields`. Mailchimp generates the uppercase `tag` from the name when omitted.
type: RecordType
has field: name
has field: type
has field: required
has field: default value
has field: public
has field: display order
has field: options
has field: help text

key
field key kind: identifierFieldKey
key text: name
type: FieldKey

name
is optional: false
max count: 1
min count: 1
field type: string
field key: key
comment: Human-readable merge field name.
type: Field

key
field key kind: identifierFieldKey
key text: type
type: FieldKey

type
is optional: false
max count: 1
min count: 1
field type: string
field key: key
comment: Merge field data type.
type: Field

key
field key kind: identifierFieldKey
key text: required
type: FieldKey

required
is optional: true
max count: 1
field type: boolean
field key: key
comment: Whether subscribers must supply a value for this field.
type: Field

key
field key kind: identifierFieldKey
key text: default value
type: FieldKey

default value
is optional: true
max count: 1
field type: string
field key: key
comment: Default value substituted when the field is empty.
type: Field

key
field key kind: identifierFieldKey
key text: public
type: FieldKey

public
is optional: true
max count: 1
field type: boolean
field key: key
comment: Surface the field on hosted signup forms.
type: Field

key
field key kind: identifierFieldKey
key text: display order
type: FieldKey

display order
is optional: true
max count: 1
field type: unknown
field key: key
comment: Position of the field on hosted signup forms.
type: Field

key
field key kind: identifierFieldKey
key text: options
type: FieldKey

options
is optional: true
max count: 1
field type: Options Record
field key: key
comment: Type-specific options (e.g. `choices` for `dropdown`, `format` for `date`).
type: Field

key
field key kind: identifierFieldKey
key text: help text
type: FieldKey

help text
is optional: true
max count: 1
field type: string
field key: key
comment: Helper text shown beside the field on signup forms.
type: Field

merge fields array
is anonymous: true
array value type: Merge Field
type: ArrayExpression

key
field key kind: identifierFieldKey
key text: merge fields
type: FieldKey

merge fields
is optional: true
field type: merge fields array
field key: key
comment: Merge fields in the current page.
type: Field

Merge Field List Response
has field: merge fields
comment: Collection envelope returned by `GET /lists/{list_id}/merge-fields`.
type: RecordType
has field: list id
has field: total items
has field: links

key
field key kind: identifierFieldKey
key text: list id
type: FieldKey

list id
is optional: false
max count: 1
min count: 1
field type: List
field key: key
comment: Parent audience identifier.
type: Field

key
field key kind: identifierFieldKey
key text: total items
type: FieldKey

total items
is optional: false
max count: 1
min count: 1
field type: unknown
field key: key
comment: Total number of merge fields defined on the audience.
type: Field

links array
is anonymous: true
array value type: HALLink
type: ArrayExpression

key
field key kind: identifierFieldKey
key text: links
type: FieldKey

links
is optional: true
field type: links array
field key: key
comment: HATEOAS link descriptors for the collection.
type: Field

tags array
is anonymous: true
array value type: Tag
type: ArrayExpression

key
field key kind: identifierFieldKey
key text: tags
type: FieldKey

tags
is optional: true
field type: tags array
field key: key
comment: Tags matching the search query, ordered by relevance.
type: Field

Tag Search Response
has field: tags
comment: Envelope returned by `GET /lists/{list_id}/tag-search`. Mailchimp uses the bare `tags` collection key here (not the standard `ListResponse` envelope) and omits `_links` on this endpoint.
type: RecordType
has field: total items

key
field key kind: identifierFieldKey
key text: total items
type: FieldKey

total items
is optional: false
max count: 1
min count: 1
field type: unknown
field key: key
comment: Total number of matching tags across all pages.
type: Field

members added array
is anonymous: true
array value type: Members Added Record
type: ArrayExpression

key
field key kind: identifierFieldKey
key text: members added
type: FieldKey

members added
is optional: true
field type: members added array
field key: key
comment: Members successfully added by this batch.
type: Field

Segment Batch Members Response
has field: members added
comment: Response shape returned by `POST /lists/{list_id}/segments/{segment_id}`. Mirrors the audience-level batch endpoint: parallel buckets of added and removed members plus a per-row error report.
type: RecordType
has field: members removed
has field: errors
has field: total added
has field: total removed
has field: error count

members removed array
is anonymous: true
array value type: Members Removed Record
type: ArrayExpression

key
field key kind: identifierFieldKey
key text: members removed
type: FieldKey

members removed
is optional: true
field type: members removed array
field key: key
comment: Members successfully removed by this batch.
type: Field

errors array
is anonymous: true
array value type: Errors
type: ArrayExpression

key
field key kind: identifierFieldKey
key text: errors
type: FieldKey

errors
is optional: true
field type: errors array
field key: key
comment: Per-row error reports for rejected emails.
type: Field

key
field key kind: identifierFieldKey
key text: total added
type: FieldKey

total added
is optional: false
max count: 1
min count: 1
field type: unknown
field key: key
type: Field

key
field key kind: identifierFieldKey
key text: total removed
type: FieldKey

total removed
is optional: false
max count: 1
min count: 1
field type: unknown
field key: key
type: Field

key
field key kind: identifierFieldKey
key text: error count
type: FieldKey

error count
is optional: false
max count: 1
min count: 1
field type: unknown
field key: key
type: Field

members to add array
is anonymous: true
array value type: string
type: ArrayExpression

key
field key kind: identifierFieldKey
key text: members to add
type: FieldKey

members to add
is optional: true
field type: members to add array
field key: key
comment: Emails to add to the static segment. Required unless `members_to_remove` is supplied; at least one of the two arrays must be present and non-empty per Mailchimp's API contract.
type: Field

Segment Batch Members Input
has field: members to add
comment: Body of `POST /lists/{list_id}/segments/{segment_id}`. Mailchimp uses POST on the resource (not the collection) for batch add/remove on static segments. At least one of `members_to_add` or `members_to_remove` must be supplied; Mailchimp returns HTTP 400 with title `"Invalid Resource"` when both arrays are absent or empty. Both fields are modelled as optional because either may be omitted in a valid request, but the cross-field constraint is checkable only at the API boundary; TypeSpec cannot express "exactly-one-of" on optional siblings without forking the model into a discriminated union that would distort the wire shape, so the constraint lives in the docstring and in this model's per-property docs and is enforced by Mailchimp on receipt.
type: RecordType
has field: members to remove

members to remove array
is anonymous: true
array value type: string
type: ArrayExpression

key
field key kind: identifierFieldKey
key text: members to remove
type: FieldKey

members to remove
is optional: true
field type: members to remove array
field key: key
comment: Emails to remove from the static segment. Required unless `members_to_add` is supplied; at least one of the two arrays must be present and non-empty per Mailchimp's API contract.
type: Field

key
field key kind: identifierFieldKey
key text: name
type: FieldKey

name
is optional: false
max count: 1
min count: 1
field type: string
field key: key
comment: Display name of the segment.
type: Field

Segment Input
has field: name
comment: Body of `POST /lists/{list_id}/segments` (create) and `PATCH /lists/{list_id}/segments/{segment_id}` (update). Mailchimp documents the same shape on both verbs.
type: RecordType
has field: static segment
has field: options

static segment array
is anonymous: true
array value type: string
type: ArrayExpression

key
field key kind: identifierFieldKey
key text: static segment
type: FieldKey

static segment
is optional: true
field type: static segment array
field key: key
comment: Seed emails for a static segment. Unknown emails are created on the audience as transactional.
type: Field

key
field key kind: identifierFieldKey
key text: options
type: FieldKey

options
is optional: true
max count: 1
field type: Options Record
field key: key
comment: Saved-segment condition tree (`match` plus an array of `conditions`).
type: Field

segments array
is anonymous: true
array value type: Segment
type: ArrayExpression

key
field key kind: identifierFieldKey
key text: segments
type: FieldKey

segments
is optional: true
field type: segments array
field key: key
comment: Segments in the current page.
type: Field

Segment List Response
has field: segments
comment: Collection envelope returned by `GET /lists/{list_id}/segments`.
type: RecordType
has field: list id
has field: total items
has field: links

key
field key kind: identifierFieldKey
key text: list id
type: FieldKey

list id
is optional: false
max count: 1
min count: 1
field type: List
field key: key
comment: Parent audience identifier.
type: Field

key
field key kind: identifierFieldKey
key text: total items
type: FieldKey

total items
is optional: false
max count: 1
min count: 1
field type: unknown
field key: key
comment: Total number of segments defined on the audience.
type: Field

links array
is anonymous: true
array value type: HALLink
type: ArrayExpression

key
field key kind: identifierFieldKey
key text: links
type: FieldKey

links
is optional: true
field type: links array
field key: key
comment: HATEOAS link descriptors for the collection.
type: Field

tags array
is anonymous: true
array value type: Tags
type: ArrayExpression

key
field key kind: identifierFieldKey
key text: tags
type: FieldKey

tags
is optional: true
field type: tags array
field key: key
comment: Tag mutations to apply. Each row names a tag and an action.
type: Field

Member Tags Mutate Input
has field: tags
comment: Body of `POST /lists/{list_id}/members/{subscriber_hash}/tags`. Each tag row carries an action verb (`active` to add, `inactive` to remove).
type: RecordType
has field: is syncing

key
field key kind: identifierFieldKey
key text: is syncing
type: FieldKey

is syncing
is optional: true
max count: 1
field type: boolean
field key: key
comment: Treat the call as part of a background sync to suppress some side effects.
type: Field

tags array
is anonymous: true
array value type: Member Tag Assignment
type: ArrayExpression

key
field key kind: identifierFieldKey
key text: tags
type: FieldKey

tags
is optional: true
field type: tags array
field key: key
comment: Tags currently applied to the member.
type: Field

Member Tags Response
has field: tags
comment: Envelope returned by `GET /lists/{list_id}/members/{subscriber_hash}/tags`.
type: RecordType
has field: total items

key
field key kind: identifierFieldKey
key text: total items
type: FieldKey

total items
is optional: false
max count: 1
min count: 1
field type: unknown
field key: key
comment: Total number of tags applied to the member.
type: Field

key
field key kind: identifierFieldKey
key text: id
type: FieldKey

id
is optional: false
max count: 1
min count: 1
field type: unknown
field key: key
comment: Numeric tag identifier scoped to the parent list.
type: Field

Member Tag Assignment
has field: id
comment: Single tag entry returned by `GET /lists/{list_id}/members/{subscriber_hash}/tags`.
type: RecordType
has field: name
has field: date added

key
field key kind: identifierFieldKey
key text: name
type: FieldKey

name
is optional: false
max count: 1
min count: 1
field type: string
field key: key
comment: Tag display name.
type: Field

key
field key kind: identifierFieldKey
key text: date added
type: FieldKey

date added
is optional: true
max count: 1
field type: offsetDateTime
field key: key
comment: When this tag was applied to the member.
type: Field

key
field key kind: identifierFieldKey
key text: email address
type: FieldKey

email address
is optional: true
max count: 1
field type: string
field key: key
comment: New email address. Updates the subscriber identity.
type: Field

Member Patch Input
has field: email address
comment: Body of `PATCH /lists/{list_id}/members/{subscriber_hash}`. All fields optional; Mailchimp applies the supplied fields and leaves the rest.
type: RecordType
has field: email type
has field: status
has field: merge fields
has field: interests
has field: language
has field: vip
has field: location
has field: marketing permissions
has field: ip signup
has field: timestamp signup
has field: ip opt
has field: timestamp opt

key
field key kind: identifierFieldKey
key text: email type
type: FieldKey

email type
is optional: true
max count: 1
field type: string
field key: key
type: Field

key
field key kind: identifierFieldKey
key text: status
type: FieldKey

status
is optional: true
max count: 1
field type: string
field key: key
comment: Current subscription status.
type: Field

key
field key kind: identifierFieldKey
key text: merge fields
type: FieldKey

merge fields
is optional: true
max count: 1
field type: Merge Fields Record
field key: key
type: Field

key
field key kind: identifierFieldKey
key text: interests
type: FieldKey

interests
is optional: true
max count: 1
field type: Interests Record
field key: key
type: Field

key
field key kind: identifierFieldKey
key text: language
type: FieldKey

language
is optional: true
max count: 1
field type: string
field key: key
type: Field

key
field key kind: identifierFieldKey
key text: vip
type: FieldKey

vip
is optional: true
max count: 1
field type: boolean
field key: key
type: Field

key
field key kind: identifierFieldKey
key text: location
type: FieldKey

location
is optional: true
max count: 1
field type: Location Record
field key: key
type: Field

marketing permissions array
is anonymous: true
array value type: Marketing Permissions Record
type: ArrayExpression

key
field key kind: identifierFieldKey
key text: marketing permissions
type: FieldKey

marketing permissions
is optional: true
field type: marketing permissions array
field key: key
type: Field

key
field key kind: identifierFieldKey
key text: ip signup
type: FieldKey

ip signup
is optional: true
max count: 1
field type: string
field key: key
type: Field

key
field key kind: identifierFieldKey
key text: timestamp signup
type: FieldKey

timestamp signup
is optional: true
max count: 1
field type: offsetDateTime
field key: key
type: Field

key
field key kind: identifierFieldKey
key text: ip opt
type: FieldKey

ip opt
is optional: true
max count: 1
field type: string
field key: key
type: Field

key
field key kind: identifierFieldKey
key text: timestamp opt
type: FieldKey

timestamp opt
is optional: true
max count: 1
field type: offsetDateTime
field key: key
type: Field

key
field key kind: identifierFieldKey
key text: email address
type: FieldKey

email address
is optional: false
max count: 1
min count: 1
field type: string
field key: key
comment: Member email address. Required only when upserting a new member.
type: Field

Member Upsert Input
has field: email address
comment: Body of `PUT /lists/{list_id}/members/{subscriber_hash}`. Upserts a member: `email_address` and `status_if_new` become required when the member does not already exist (Mailchimp ignores both on update).
type: RecordType
has field: status if new
has field: email type
has field: status
has field: merge fields
has field: interests
has field: language
has field: vip
has field: location
has field: marketing permissions
has field: ip signup
has field: timestamp signup
has field: ip opt
has field: timestamp opt

key
field key kind: identifierFieldKey
key text: status if new
type: FieldKey

status if new
is optional: false
max count: 1
min count: 1
field type: string
field key: key
comment: Status to assign when the member does not yet exist on the audience.
type: Field

key
field key kind: identifierFieldKey
key text: email type
type: FieldKey

email type
is optional: true
max count: 1
field type: string
field key: key
comment: Preferred email format.
type: Field

key
field key kind: identifierFieldKey
key text: status
type: FieldKey

status
is optional: true
max count: 1
field type: string
field key: key
comment: Current subscription status. Ignored when creating a new member (use `status_if_new`).
type: Field

key
field key kind: identifierFieldKey
key text: merge fields
type: FieldKey

merge fields
is optional: true
max count: 1
field type: Merge Fields Record
field key: key
comment: Map of merge-tag names to scalar values.
type: Field

key
field key kind: identifierFieldKey
key text: interests
type: FieldKey

interests
is optional: true
max count: 1
field type: Interests Record
field key: key
comment: Map of interest IDs to boolean subscription flags.
type: Field

key
field key kind: identifierFieldKey
key text: language
type: FieldKey

language
is optional: true
max count: 1
field type: string
field key: key
comment: Subscriber language code (ISO 639-1).
type: Field

key
field key kind: identifierFieldKey
key text: vip
type: FieldKey

vip
is optional: true
max count: 1
field type: boolean
field key: key
comment: Designate the subscriber as VIP.
type: Field

key
field key kind: identifierFieldKey
key text: location
type: FieldKey

location
is optional: true
max count: 1
field type: Location Record
field key: key
comment: Subscriber geo location (`latitude`, `longitude`).
type: Field

marketing permissions array
is anonymous: true
array value type: Marketing Permissions Record
type: ArrayExpression

key
field key kind: identifierFieldKey
key text: marketing permissions
type: FieldKey

marketing permissions
is optional: true
field type: marketing permissions array
field key: key
comment: Per-permission consent records (GDPR-style).
type: Field

key
field key kind: identifierFieldKey
key text: ip signup
type: FieldKey

ip signup
is optional: true
max count: 1
field type: string
field key: key
comment: Source IP recorded at signup.
type: Field

key
field key kind: identifierFieldKey
key text: timestamp signup
type: FieldKey

timestamp signup
is optional: true
max count: 1
field type: offsetDateTime
field key: key
comment: Signup timestamp.
type: Field

key
field key kind: identifierFieldKey
key text: ip opt
type: FieldKey

ip opt
is optional: true
max count: 1
field type: string
field key: key
comment: Source IP recorded at confirmed opt-in.
type: Field

key
field key kind: identifierFieldKey
key text: timestamp opt
type: FieldKey

timestamp opt
is optional: true
max count: 1
field type: offsetDateTime
field key: key
comment: Confirmed opt-in timestamp.
type: Field

key
field key kind: identifierFieldKey
key text: email address
type: FieldKey

email address
is optional: false
max count: 1
min count: 1
field type: string
field key: key
comment: Member email address. The MD5 of the lowercased email becomes the `subscriber_hash` used as `Member.id` and as the path parameter for per-member endpoints.
type: Field

Member Create Input
has field: email address
comment: Body of `POST /lists/{list_id}/members`. Required to subscribe a new member; `email_address` and `status` are the only mandatory fields.
type: RecordType
has field: email type
has field: status
has field: merge fields
has field: interests
has field: language
has field: vip
has field: location
has field: marketing permissions
has field: ip signup
has field: timestamp signup
has field: ip opt
has field: timestamp opt
has field: tags

key
field key kind: identifierFieldKey
key text: email type
type: FieldKey

email type
is optional: true
max count: 1
field type: string
field key: key
comment: Preferred email format.
type: Field

key
field key kind: identifierFieldKey
key text: status
type: FieldKey

status
is optional: false
max count: 1
min count: 1
field type: string
field key: key
comment: Initial subscription status (`subscribed`, `pending`, `unsubscribed`, `cleaned`, `transactional`).
type: Field

key
field key kind: identifierFieldKey
key text: merge fields
type: FieldKey

merge fields
is optional: true
max count: 1
field type: Merge Fields Record
field key: key
comment: Map of merge-tag names to scalar values (e.g. `FNAME`, `LNAME`).
type: Field

key
field key kind: identifierFieldKey
key text: interests
type: FieldKey

interests
is optional: true
max count: 1
field type: Interests Record
field key: key
comment: Map of interest IDs to boolean subscription flags.
type: Field

key
field key kind: identifierFieldKey
key text: language
type: FieldKey

language
is optional: true
max count: 1
field type: string
field key: key
comment: Subscriber language code (ISO 639-1).
type: Field

key
field key kind: identifierFieldKey
key text: vip
type: FieldKey

vip
is optional: true
max count: 1
field type: boolean
field key: key
comment: Designate the subscriber as VIP.
type: Field

key
field key kind: identifierFieldKey
key text: location
type: FieldKey

location
is optional: true
max count: 1
field type: Location Record
field key: key
comment: Subscriber geo location (`latitude`, `longitude`).
type: Field

marketing permissions array
is anonymous: true
array value type: Marketing Permissions Record
type: ArrayExpression

key
field key kind: identifierFieldKey
key text: marketing permissions
type: FieldKey

marketing permissions
is optional: true
field type: marketing permissions array
field key: key
comment: Per-permission consent records (GDPR-style).
type: Field

key
field key kind: identifierFieldKey
key text: ip signup
type: FieldKey

ip signup
is optional: true
max count: 1
field type: string
field key: key
comment: Source IP recorded at signup.
type: Field

key
field key kind: identifierFieldKey
key text: timestamp signup
type: FieldKey

timestamp signup
is optional: true
max count: 1
field type: offsetDateTime
field key: key
comment: Signup timestamp.
type: Field

key
field key kind: identifierFieldKey
key text: ip opt
type: FieldKey

ip opt
is optional: true
max count: 1
field type: string
field key: key
comment: Source IP recorded at confirmed opt-in.
type: Field

key
field key kind: identifierFieldKey
key text: timestamp opt
type: FieldKey

timestamp opt
is optional: true
max count: 1
field type: offsetDateTime
field key: key
comment: Confirmed opt-in timestamp.
type: Field

tags array
is anonymous: true
array value type: string
type: ArrayExpression

key
field key kind: identifierFieldKey
key text: tags
type: FieldKey

tags
is optional: true
field type: tags array
field key: key
comment: Tag names to apply at create time. Mailchimp creates missing tags.
type: Field

members array
is anonymous: true
array value type: Member
type: ArrayExpression

key
field key kind: identifierFieldKey
key text: members
type: FieldKey

members
is optional: true
field type: members array
field key: key
comment: Members in the current page.
type: Field

Member List Response
has field: members
comment: Collection envelope returned by `GET /lists/{list_id}/members`.
type: RecordType
has field: list id
has field: total items
has field: links

key
field key kind: identifierFieldKey
key text: list id
type: FieldKey

list id
is optional: false
max count: 1
min count: 1
field type: List
field key: key
comment: Parent audience identifier.
type: Field

key
field key kind: identifierFieldKey
key text: total items
type: FieldKey

total items
is optional: false
max count: 1
min count: 1
field type: unknown
field key: key
comment: Total number of members on the audience (unfiltered by pagination).
type: Field

links array
is anonymous: true
array value type: HALLink
type: ArrayExpression

key
field key kind: identifierFieldKey
key text: links
type: FieldKey

links
is optional: true
field type: links array
field key: key
comment: HATEOAS link descriptors for the collection.
type: Field

key
field key kind: identifierFieldKey
key text: name
type: FieldKey

name
is optional: false
max count: 1
min count: 1
field type: string
field key: key
comment: Human-readable audience name.
type: Field

List Input
has field: name
comment: Body of `POST /lists`. Mailchimp documents the same shape for both create and PATCH update; this model is reused on `PATCH /lists/{list_id}`.
type: RecordType
has field: contact
has field: permission reminder
has field: use archive bar
has field: campaign defaults
has field: notify on subscribe
has field: notify on unsubscribe
has field: email type option
has field: double optin
has field: marketing permissions

key
field key kind: identifierFieldKey
key text: contact
type: FieldKey

contact
is optional: false
max count: 1
min count: 1
field type: List Contact
field key: key
comment: Audience postal contact information shown in campaign footers (CAN-SPAM).
type: Field

key
field key kind: identifierFieldKey
key text: permission reminder
type: FieldKey

permission reminder
is optional: false
max count: 1
min count: 1
field type: string
field key: key
comment: Permission reminder displayed at the bottom of campaigns sent to this audience.
type: Field

key
field key kind: identifierFieldKey
key text: use archive bar
type: FieldKey

use archive bar
is optional: true
max count: 1
field type: boolean
field key: key
comment: Show the Mailchimp archive bar in campaigns sent to this audience.
type: Field

key
field key kind: identifierFieldKey
key text: campaign defaults
type: FieldKey

campaign defaults
is optional: false
max count: 1
min count: 1
field type: List Campaign Defaults
field key: key
comment: Default `from_name`, `from_email`, `subject`, and `language` for new campaigns.
type: Field

key
field key kind: identifierFieldKey
key text: notify on subscribe
type: FieldKey

notify on subscribe
is optional: true
max count: 1
field type: string
field key: key
comment: Email address that receives notifications when someone subscribes.
type: Field

key
field key kind: identifierFieldKey
key text: notify on unsubscribe
type: FieldKey

notify on unsubscribe
is optional: true
max count: 1
field type: string
field key: key
comment: Email address that receives notifications when someone unsubscribes.
type: Field

key
field key kind: identifierFieldKey
key text: email type option
type: FieldKey

email type option
is optional: false
max count: 1
min count: 1
field type: boolean
field key: key
comment: Allow subscribers to choose between HTML and plain-text emails.
type: Field

key
field key kind: identifierFieldKey
key text: double optin
type: FieldKey

double optin
is optional: true
max count: 1
field type: boolean
field key: key
comment: Require subscribers to confirm via opt-in email.
type: Field

key
field key kind: identifierFieldKey
key text: marketing permissions
type: FieldKey

marketing permissions
is optional: true
max count: 1
field type: boolean
field key: key
comment: Surface GDPR-style marketing permissions on the signup form.
type: Field

new members array
is anonymous: true
array value type: New Members Record
type: ArrayExpression

key
field key kind: identifierFieldKey
key text: new members
type: FieldKey

new members
is optional: true
field type: new members array
field key: key
comment: Members created by this batch.
type: Field

List Batch Members Response
has field: new members
comment: Response shape returned by `POST /lists/{list_id}`. Mailchimp returns three parallel arrays plus per-bucket counts and per-error detail.
type: RecordType
has field: updated members
has field: errors
has field: total created
has field: total updated
has field: error count
has field: list id

updated members array
is anonymous: true
array value type: Updated Members Record
type: ArrayExpression

key
field key kind: identifierFieldKey
key text: updated members
type: FieldKey

updated members
is optional: true
field type: updated members array
field key: key
comment: Members updated by this batch.
type: Field

errors array
is anonymous: true
array value type: Errors
type: ArrayExpression

key
field key kind: identifierFieldKey
key text: errors
type: FieldKey

errors
is optional: true
field type: errors array
field key: key
comment: Per-row error reports for rejected members.
type: Field

key
field key kind: identifierFieldKey
key text: total created
type: FieldKey

total created
is optional: false
max count: 1
min count: 1
field type: unknown
field key: key
comment: Number of members created in this batch.
type: Field

key
field key kind: identifierFieldKey
key text: total updated
type: FieldKey

total updated
is optional: false
max count: 1
min count: 1
field type: unknown
field key: key
comment: Number of members updated in this batch.
type: Field

key
field key kind: identifierFieldKey
key text: error count
type: FieldKey

error count
is optional: false
max count: 1
min count: 1
field type: unknown
field key: key
comment: Number of members rejected by this batch.
type: Field

key
field key kind: identifierFieldKey
key text: list id
type: FieldKey

list id
is optional: false
max count: 1
min count: 1
field type: List
field key: key
comment: Parent audience identifier.
type: Field

members array
is anonymous: true
array value type: Members Record
type: ArrayExpression

key
field key kind: identifierFieldKey
key text: members
type: FieldKey

members
is optional: true
field type: members array
field key: key
comment: Member descriptors to subscribe, update, or unsubscribe in bulk.
type: Field

List Batch Members Input
has field: members
comment: Body of `POST /lists/{list_id}`. Mailchimp uses POST on the resource (not the collection) for batch subscribe/unsubscribe; `members` is an array of fragmentary member payloads sharing the same wire shape as `POST /lists/{list_id}/members` bodies.
type: RecordType
has field: sync tags
has field: update existing

key
field key kind: identifierFieldKey
key text: sync tags
type: FieldKey

sync tags
is optional: true
max count: 1
field type: boolean
field key: key
comment: Replace each member's tag set with the tags supplied in the payload.
type: Field

key
field key kind: identifierFieldKey
key text: update existing
type: FieldKey

update existing
is optional: true
max count: 1
field type: boolean
field key: key
comment: Update members already on the list instead of skipping duplicates.
type: Field

lists array
is anonymous: true
array value type: List
type: ArrayExpression

key
field key kind: identifierFieldKey
key text: lists
type: FieldKey

lists
is optional: true
field type: lists array
field key: key
comment: Audiences in the current page.
type: Field

List List Response
has field: lists
comment: Collection envelope returned by `GET /lists`. Mailchimp uses the resource-plural collection key `lists` and adds `total_items`, optional `constraints`, and a `_links` array.
type: RecordType
has field: total items
has field: constraints
has field: links

key
field key kind: identifierFieldKey
key text: total items
type: FieldKey

total items
is optional: false
max count: 1
min count: 1
field type: unknown
field key: key
comment: Total number of audiences on the account (across all pages).
type: Field

key
field key kind: identifierFieldKey
key text: constraints
type: FieldKey

constraints
is optional: true
max count: 1
field type: Constraints Record
field key: key
comment: Per-account audience-count limits applied to this response.
type: Field

links array
is anonymous: true
array value type: HALLink
type: ArrayExpression

key
field key kind: identifierFieldKey
key text: links
type: FieldKey

links
is optional: true
field type: links array
field key: key
comment: HATEOAS link descriptors for the collection.
type: Field

key
field key kind: identifierFieldKey
key text: id
type: FieldKey

id
is optional: false
max count: 1
min count: 1
field type: string
field key: key
comment: Opaque interest-category ID.
type: Field

Interest Category
has field: id
comment: Stub — only used to resolve Ref<InterestCategory>; full schema deferred to v2.
type: RecordType
has field: list id
has field: title
has field: type

key
field key kind: identifierFieldKey
key text: list id
type: FieldKey

list id
is optional: false
max count: 1
min count: 1
field type: List
field key: key
comment: Parent list that owns the interest category.
type: Field

key
field key kind: identifierFieldKey
key text: title
type: FieldKey

title
is optional: false
max count: 1
min count: 1
field type: string
field key: key
comment: Display title shown above the interest checkboxes.
type: Field

key
field key kind: identifierFieldKey
key text: type
type: FieldKey

type
is optional: false
max count: 1
min count: 1
field type: string
field key: key
comment: Presentation style for the category on subscribe forms.
type: Field

key
field key kind: identifierFieldKey
key text: id
type: FieldKey

id
is optional: false
max count: 1
min count: 1
field type: string
field key: key
comment: Opaque Interest ID. Appears as the key in `Member.interests`.
type: Field

Interest
has field: id
comment: Stub — only used to resolve Ref<Interest>; full schema deferred to v2.
type: RecordType
has field: name
has field: category id

key
field key kind: identifierFieldKey
key text: name
type: FieldKey

name
is optional: false
max count: 1
min count: 1
field type: string
field key: key
comment: Display name shown in subscribe forms and the admin UI.
type: Field

key
field key kind: identifierFieldKey
key text: category id
type: FieldKey

category id
is optional: false
max count: 1
min count: 1
field type: Interest Category
field key: key
comment: Parent interest category that groups this interest.
type: Field

key
field key kind: identifierFieldKey
key text: user
type: FieldKey

user
is optional: true
max count: 1
field type: boolean
field key: key
comment: Deliver events triggered by the subscriber themselves.
type: Field

Webhook Sources
has field: user
comment: Source-filter mask attached to `ListWebhook.sources`. Each boolean controls whether events from the corresponding origin are delivered. Modelled as object fields (not an enum array) to match Mailchimp's on-wire shape and allow independent toggling per source.
type: RecordType
has field: admin
has field: api

key
field key kind: identifierFieldKey
key text: admin
type: FieldKey

admin
is optional: true
max count: 1
field type: boolean
field key: key
comment: Deliver events triggered by operators inside the Mailchimp UI.
type: Field

key
field key kind: identifierFieldKey
key text: api
type: FieldKey

api
is optional: true
max count: 1
field type: boolean
field key: key
comment: Deliver events triggered programmatically through the API.
type: Field

key
field key kind: identifierFieldKey
key text: subscribe
type: FieldKey

subscribe
is optional: true
max count: 1
field type: boolean
field key: key
comment: Deliver a callback when a subscriber opts in.
type: Field

Webhook Events
has field: subscribe
comment: Event-type subscription mask attached to `ListWebhook.events`. Each boolean toggles whether Mailchimp delivers callbacks for the corresponding subscriber-lifecycle event. Mailchimp models these as object fields (not an enum array) so callers can toggle each flag independently and the API can extend the surface additively. The six fields cover the entire documented event set.
type: RecordType
has field: unsubscribe
has field: profile
has field: upemail
has field: cleaned
has field: campaign

key
field key kind: identifierFieldKey
key text: unsubscribe
type: FieldKey

unsubscribe
is optional: true
max count: 1
field type: boolean
field key: key
comment: Deliver a callback when a subscriber opts out.
type: Field

key
field key kind: identifierFieldKey
key text: profile
type: FieldKey

profile
is optional: true
max count: 1
field type: boolean
field key: key
comment: Deliver a callback when a subscriber's profile (merge fields) changes.
type: Field

key
field key kind: identifierFieldKey
key text: upemail
type: FieldKey

upemail
is optional: true
max count: 1
field type: boolean
field key: key
comment: Deliver a callback when a subscriber changes their email address.
type: Field

key
field key kind: identifierFieldKey
key text: cleaned
type: FieldKey

cleaned
is optional: true
max count: 1
field type: boolean
field key: key
comment: Deliver a callback when an address is cleaned (bounced/removed).
type: Field

key
field key kind: identifierFieldKey
key text: campaign
type: FieldKey

campaign
is optional: true
max count: 1
field type: boolean
field key: key
comment: Deliver a callback when a campaign send completes.
type: Field

key
field key kind: identifierFieldKey
key text: id
type: FieldKey

id
is optional: false
max count: 1
min count: 1
field type: string
field key: key
comment: Opaque webhook subscription ID assigned by Mailchimp on create.
type: Field

List Webhook
has field: id
comment: Webhook subscription configured under a single audience (list). A list can have multiple webhook subscriptions, each routing a different combination of event types and origin sources to its own callback URL. Returned by `GET /lists/{list_id}/webhooks/{webhook_id}`.
type: RecordType
has field: url
has field: events
has field: sources
has field: list id
has field: links

key
field key kind: identifierFieldKey
key text: url
type: FieldKey

url
is optional: true
max count: 1
field type: url
field key: key
comment: Callback URL Mailchimp POSTs form-encoded events to.
type: Field

key
field key kind: identifierFieldKey
key text: events
type: FieldKey

events
is optional: true
max count: 1
field type: Webhook Events
field key: key
comment: Event-type subscription mask (subscribe, unsubscribe, profile, upemail, cleaned, campaign).
type: Field

key
field key kind: identifierFieldKey
key text: sources
type: FieldKey

sources
is optional: true
max count: 1
field type: Webhook Sources
field key: key
comment: Origin-source filter mask (user, admin, api).
type: Field

key
field key kind: identifierFieldKey
key text: list id
type: FieldKey

list id
is optional: false
max count: 1
min count: 1
field type: List
field key: key
comment: Parent audience the webhook is attached to.
type: Field

links array
is anonymous: true
array value type: HALLink
type: ArrayExpression

key
field key kind: identifierFieldKey
key text: links
type: FieldKey

links
is optional: true
field type: links array
field key: key
comment: HATEOAS link descriptors for this resource.
type: Field

key
field key kind: identifierFieldKey
key text: action
type: FieldKey

action
is optional: false
max count: 1
min count: 1
field type: string
field key: key
comment: Which action this row records.
type: Field

Email Activity Entry
has field: action
comment: One open/click/bounce event recorded against a single recipient for the parent campaign. The action discriminator selects which sibling fields carry meaningful values: `url` on clicks, `type` on bounces, neither on opens. `ip` is best-effort and may be absent for opens recorded behind privacy proxies.
type: RecordType
has field: type
has field: timestamp
has field: url
has field: ip

key
field key kind: identifierFieldKey
key text: type
type: FieldKey

type
is optional: true
max count: 1
field type: string
field key: key
comment: Bounce sub-classification. Set only when `action == bounce`.
type: Field

key
field key kind: identifierFieldKey
key text: timestamp
type: FieldKey

timestamp
is optional: false
max count: 1
min count: 1
field type: offsetDateTime
field key: key
comment: Timestamp at which the action was recorded.
type: Field

key
field key kind: identifierFieldKey
key text: url
type: FieldKey

url
is optional: true
max count: 1
field type: url
field key: key
comment: Destination URL of the click. Set only when `action == click`.
type: Field

key
field key kind: identifierFieldKey
key text: ip
type: FieldKey

ip
is optional: true
max count: 1
field type: string
field key: key
comment: Originating IP address. Best-effort; may be empty for proxy opens.
type: Field

key
field key kind: identifierFieldKey
key text: campaign id
type: FieldKey

campaign id
is optional: false
max count: 1
min count: 1
field type: Campaign
field key: key
comment: Parent campaign this activity row belongs to.
type: Field

Email Activity Recipient
has field: campaign id
comment: Per-recipient activity envelope returned inside `EmailActivity.emails[]`. Each entry pins the recipient by `emailId` (the Member subscriber-hash) and carries the chronological list of events Mailchimp recorded against the send for that recipient (capped at 1000 opens + 1000 clicks).
type: RecordType
has field: list id
has field: list is active
has field: email id
has field: email address
has field: activity

key
field key kind: identifierFieldKey
key text: list id
type: FieldKey

list id
is optional: false
max count: 1
min count: 1
field type: List
field key: key
comment: Parent audience the recipient is subscribed to.
type: Field

key
field key kind: identifierFieldKey
key text: list is active
type: FieldKey

list is active
is optional: true
max count: 1
field type: boolean
field key: key
comment: Whether the parent list is currently active.
type: Field

key
field key kind: identifierFieldKey
key text: email id
type: FieldKey

email id
is optional: false
max count: 1
min count: 1
field type: Member
field key: key
comment: Member subscriber-hash (MD5 of the lowercased email address) — same value as `Member.id`. Used to join activity back to the Member resource.
type: Field

key
field key kind: identifierFieldKey
key text: email address
type: FieldKey

email address
is optional: true
max count: 1
field type: string
field key: key
comment: Recipient email address.
type: Field

activity array
is anonymous: true
array value type: Email Activity Entry
type: ArrayExpression

key
field key kind: identifierFieldKey
key text: activity
type: FieldKey

activity
is optional: true
field type: activity array
field key: key
comment: Chronological list of per-action events for this recipient. Capped at 1000 opens + 1000 clicks per recipient per campaign.
type: Field

emails array
is anonymous: true
array value type: Email Activity Recipient
type: ArrayExpression

key
field key kind: identifierFieldKey
key text: emails
type: FieldKey

emails
is optional: true
field type: emails array
field key: key
comment: Per-recipient activity envelopes for this campaign.
type: Field

Email Activity
has field: emails
comment: Per-campaign email activity report — a flat envelope listing each recipient and the open/click/bounce events Mailchimp recorded against the send. Returned by `GET /reports/{campaign_id}/email-activity`. Not a top-level identified entity (no `@key` field); the parent campaign is the addressable resource. Cross-references to `Campaign` and `List` are carried both at envelope level and on every recipient row.
type: RecordType
has field: campaign id
has field: list id
has field: total items
has field: links

key
field key kind: identifierFieldKey
key text: campaign id
type: FieldKey

campaign id
is optional: false
max count: 1
min count: 1
field type: Campaign
field key: key
comment: Parent campaign the report belongs to.
type: Field

key
field key kind: identifierFieldKey
key text: list id
type: FieldKey

list id
is optional: true
max count: 1
field type: List
field key: key
comment: Parent audience the campaign sent to.
type: Field

key
field key kind: identifierFieldKey
key text: total items
type: FieldKey

total items
is optional: true
max count: 1
field type: unknown
field key: key
comment: Total recipient rows available across all pages.
type: Field

links array
is anonymous: true
array value type: HALLink
type: ArrayExpression

key
field key kind: identifierFieldKey
key text: links
type: FieldKey

links
is optional: true
field type: links array
field key: key
comment: HATEOAS link descriptors for this report.
type: Field

key
field key kind: identifierFieldKey
key text: type
type: FieldKey

type
is optional: false
max count: 1
min count: 1
field type: string
field key: key
comment: How the daily run-window is interpreted. Required by the Mailchimp spec on every runtime block; flagged as `required: true` alongside the parent `workflowType`.
type: Field

Automation Runtime Hours
has field: type
comment: Run-window descriptor nested under `TriggerSettings.runtime`. Restricts which weekdays and which hours the workflow may dispatch on.
type: RecordType

days array
is anonymous: true
array value type: string
type: ArrayExpression

key
field key kind: identifierFieldKey
key text: days
type: FieldKey

days
is optional: true
field type: days array
field key: key
comment: Weekdays on which the workflow may fire. Empty array means the trigger fires on any day.
type: Field

Automation Runtime
has field: days
comment: Schedule constraints attached to `TriggerSettings.runtime`.
type: RecordType
has field: hours

key
field key kind: identifierFieldKey
key text: hours
type: FieldKey

hours
is optional: true
max count: 1
field type: Automation Runtime Hours
field key: key
comment: Daily run-window configuration.
type: Field

key
field key kind: identifierFieldKey
key text: workflow type
type: FieldKey

workflow type
is optional: false
max count: 1
min count: 1
field type: string
field key: key
comment: Built-in workflow recipe selected for this automation. Required by the Mailchimp spec.
type: Field

Trigger Settings
has field: workflow type
comment: Trigger-and-runtime descriptor nested under `Automation.triggerSettings`. The `workflowType` field is the only `required: true` field in the Mailchimp automation GET-response schema.
type: RecordType
has field: workflow title
has field: runtime
has field: workflow emails count

key
field key kind: identifierFieldKey
key text: workflow title
type: FieldKey

workflow title
is optional: true
max count: 1
field type: string
field key: key
comment: Display title of the workflow recipe.
type: Field

key
field key kind: identifierFieldKey
key text: runtime
type: FieldKey

runtime
is optional: true
max count: 1
field type: Automation Runtime
field key: key
comment: Schedule constraints restricting when the workflow fires.
type: Field

key
field key kind: identifierFieldKey
key text: workflow emails count
type: FieldKey

workflow emails count
is optional: true
max count: 1
field type: unknown
field key: key
comment: Count of email steps configured under this workflow.
type: Field

key
field key kind: identifierFieldKey
key text: title
type: FieldKey

title
is optional: true
max count: 1
field type: string
field key: key
comment: Internal title shown in the Mailchimp UI.
type: Field

Automation Settings
has field: title
comment: Sender and content settings nested under `Automation.settings`. Strict subset of `CampaignSettings` — no folder, template, social, or Google-Analytics fields.
type: RecordType
has field: from name
has field: reply to
has field: to name
has field: use conversation
has field: authenticate
has field: auto footer
has field: inline css

key
field key kind: identifierFieldKey
key text: from name
type: FieldKey

from name
is optional: true
max count: 1
field type: string
field key: key
comment: Display "from" name presented to recipients.
type: Field

key
field key kind: identifierFieldKey
key text: reply to
type: FieldKey

reply to
is optional: true
max count: 1
field type: string
field key: key
comment: Reply-to address attached to every send in the workflow.
type: Field

key
field key kind: identifierFieldKey
key text: to name
type: FieldKey

to name
is optional: true
max count: 1
field type: string
field key: key
comment: Personalised "to" name template (e.g. `*|FNAME|*`).
type: Field

key
field key kind: identifierFieldKey
key text: use conversation
type: FieldKey

use conversation
is optional: true
max count: 1
field type: boolean
field key: key
comment: Convert replies to recipients into a Mailchimp Conversation thread.
type: Field

key
field key kind: identifierFieldKey
key text: authenticate
type: FieldKey

authenticate
is optional: true
max count: 1
field type: boolean
field key: key
comment: Apply Mailchimp's authentication (SPF/DKIM) on outbound mail.
type: Field

key
field key kind: identifierFieldKey
key text: auto footer
type: FieldKey

auto footer
is optional: true
max count: 1
field type: boolean
field key: key
comment: Append the standard Mailchimp footer to the body.
type: Field

key
field key kind: identifierFieldKey
key text: inline css
type: FieldKey

inline css
is optional: true
max count: 1
field type: boolean
field key: key
comment: Inline CSS on send to maximise email-client compatibility.
type: Field

key
field key kind: identifierFieldKey
key text: saved segment id
type: FieldKey

saved segment id
is optional: true
max count: 1
field type: Segment
field key: key
comment: Saved-segment integer ID referenced by this automation.
type: Field

Automation Segment Opts
has field: saved segment id
comment: Segment options nested under `Automation.recipients`. Mirrors the Campaign equivalent but only carries the saved-segment integer key plus a polymorphic condition list (no prebuilt-segment string variant).
type: RecordType
has field: match
has field: conditions

key
field key kind: identifierFieldKey
key text: match
type: FieldKey

match
is optional: true
max count: 1
field type: string
field key: key
comment: Combinator across `conditions`.
type: Field

conditions array
is anonymous: true
array value type: Segment Condition
type: ArrayExpression

key
field key kind: identifierFieldKey
key text: conditions
type: FieldKey

conditions
is optional: true
field type: conditions array
field key: key
comment: Ordered list of segment conditions evaluated against the parent list. Concrete shape is variant-defined; see the `SegmentCondition` stub in `common.tsp` for the discriminator contract.
type: Field

key
field key kind: identifierFieldKey
key text: list id
type: FieldKey

list id
is optional: false
max count: 1
min count: 1
field type: List
field key: key
comment: Parent audience the workflow runs against.
type: Field

Automation Recipients
has field: list id
comment: Recipient configuration block nested under `Automation.recipients`. The list reference is required at the API level for any active automation; the segment options are present only when the workflow targets a subset of the list.
type: RecordType
has field: list is active
has field: list name
has field: segment opts
has field: store id

key
field key kind: identifierFieldKey
key text: list is active
type: FieldKey

list is active
is optional: true
max count: 1
field type: boolean
field key: key
comment: Whether the parent list is currently active.
type: Field

key
field key kind: identifierFieldKey
key text: list name
type: FieldKey

list name
is optional: true
max count: 1
field type: string
field key: key
comment: Display name of the parent list.
type: Field

key
field key kind: identifierFieldKey
key text: segment opts
type: FieldKey

segment opts
is optional: true
max count: 1
field type: Automation Segment Opts
field key: key
comment: Segment definition narrowing the recipient set.
type: Field

key
field key kind: identifierFieldKey
key text: store id
type: FieldKey

store id
is optional: true
max count: 1
field type: string
field key: key
comment: Connected store ID. Dangling Ref<Store>; not in v1.
type: Field

key
field key kind: identifierFieldKey
key text: id
type: FieldKey

id
is optional: false
max count: 1
min count: 1
field type: string
field key: key
comment: Opaque automation workflow ID.
type: Field

Automation
has field: id
comment: A Mailchimp automation workflow — a sequence of one or more emails fired by a trigger (subscriber signup, purchase, date, integration event, etc.) against a single parent list. Returned by `GET /automations/{workflow_id}`.
type: RecordType
has field: create time
has field: start time
has field: status
has field: emails sent
has field: recipients
has field: settings
has field: tracking
has field: trigger settings
has field: report summary
has field: links

key
field key kind: identifierFieldKey
key text: create time
type: FieldKey

create time
is optional: true
max count: 1
field type: offsetDateTime
field key: key
comment: Timestamp when the workflow was created.
type: Field

key
field key kind: identifierFieldKey
key text: start time
type: FieldKey

start time
is optional: true
max count: 1
field type: offsetDateTime
field key: key
comment: Timestamp when the workflow was last started (set to sending).
type: Field

key
field key kind: identifierFieldKey
key text: status
type: FieldKey

status
is optional: true
max count: 1
field type: string
field key: key
comment: Lifecycle state of the workflow.
type: Field

key
field key kind: identifierFieldKey
key text: emails sent
type: FieldKey

emails sent
is optional: true
max count: 1
field type: unknown
field key: key
comment: Total emails dispatched across all steps of the workflow.
type: Field

key
field key kind: identifierFieldKey
key text: recipients
type: FieldKey

recipients
is optional: true
max count: 1
field type: Automation Recipients
field key: key
comment: Recipient targeting (parent list and optional segment).
type: Field

key
field key kind: identifierFieldKey
key text: settings
type: FieldKey

settings
is optional: true
max count: 1
field type: Automation Settings
field key: key
comment: Sender, footer, and content toggles applied to every step.
type: Field

key
field key kind: identifierFieldKey
key text: tracking
type: FieldKey

tracking
is optional: true
max count: 1
field type: Campaign Tracking
field key: key
comment: Engagement-tracking toggles shared with regular campaigns.
type: Field

key
field key kind: identifierFieldKey
key text: trigger settings
type: FieldKey

trigger settings
is optional: false
max count: 1
min count: 1
field type: Trigger Settings
field key: key
comment: Trigger recipe and runtime constraints. The nested `workflowType` is the single required field across the entire Automation response shape per Mailchimp's OpenAPI; the wrapper is therefore non-optional so that requirement is reachable on the wire.
type: Field

key
field key kind: identifierFieldKey
key text: report summary
type: FieldKey

report summary
is optional: true
max count: 1
field type: Report Summary
field key: key
comment: Aggregate engagement summary (without the e-commerce sub-block).
type: Field

links array
is anonymous: true
array value type: HALLink
type: ArrayExpression

key
field key kind: identifierFieldKey
key text: links
type: FieldKey

links
is optional: true
field type: links array
field key: key
comment: HATEOAS link descriptors for this resource.
type: Field

key
field key kind: identifierFieldKey
key text: total orders
type: FieldKey

total orders
is optional: true
max count: 1
field type: unknown
field key: key
comment: Total ecommerce orders attributed to the campaign
type: Field

Ecommerce
has field: total orders
comment: Nested record for CampaignReport.ecommerce.
type: RecordType
has field: total spent
has field: total revenue
has field: currency code

key
field key kind: identifierFieldKey
key text: total spent
type: FieldKey

total spent
is optional: true
max count: 1
field type: float
field key: key
comment: Total spent by attributed orders
type: Field

key
field key kind: identifierFieldKey
key text: total revenue
type: FieldKey

total revenue
is optional: true
max count: 1
field type: float
field key: key
comment: Total revenue attributed to the campaign
type: Field

key
field key kind: identifierFieldKey
key text: currency code
type: FieldKey

currency code
is optional: true
max count: 1
field type: string
field key: key
comment: ISO 4217 currency code for the ecommerce totals
type: Field

key
field key kind: identifierFieldKey
key text: share url
type: FieldKey

share url
is optional: true
max count: 1
field type: url
field key: key
comment: Shareable URL for the campaign report
type: Field

Share Report
has field: share url
comment: Nested record for CampaignReport.shareReport.
type: RecordType
has field: share password

key
field key kind: identifierFieldKey
key text: share password
type: FieldKey

share password
is optional: true
max count: 1
field type: string
field key: key
comment: Password protecting the share URL
type: Field

key
field key kind: identifierFieldKey
key text: timestamp
type: FieldKey

timestamp
is optional: true
max count: 1
field type: offsetDateTime
field key: key
comment: Timestamp marking the start of this time-series bucket
type: Field

Timeseries Entry
has field: timestamp
comment: Nested record for a single time-series bucket in CampaignReport.timeseries[].
type: RecordType
has field: emails sent
has field: unique opens
has field: proxy excluded unique opens
has field: recipients clicks

key
field key kind: identifierFieldKey
key text: emails sent
type: FieldKey

emails sent
is optional: true
max count: 1
field type: unknown
field key: key
comment: Number of emails sent during this bucket
type: Field

key
field key kind: identifierFieldKey
key text: unique opens
type: FieldKey

unique opens
is optional: true
max count: 1
field type: unknown
field key: key
comment: Number of unique opens recorded during this bucket
type: Field

key
field key kind: identifierFieldKey
key text: proxy excluded unique opens
type: FieldKey

proxy excluded unique opens
is optional: true
max count: 1
field type: unknown
field key: key
comment: Unique opens during this bucket excluding privacy-proxy-generated opens
type: Field

key
field key kind: identifierFieldKey
key text: recipients clicks
type: FieldKey

recipients clicks
is optional: true
max count: 1
field type: unknown
field key: key
comment: Number of recipient clicks during this bucket
type: Field

key
field key kind: identifierFieldKey
key text: gmt offset
type: FieldKey

gmt offset
is optional: true
max count: 1
field type: unknown
field key: key
comment: GMT offset (in hours) for this delivery slice
type: Field

Timewarp Entry
has field: gmt offset
comment: Nested record for a single Timewarp delivery slice in CampaignReport.timewarp[].
type: RecordType
has field: opens
has field: unique opens
has field: clicks
has field: unique clicks
has field: bounces
has field: last open
has field: last click

key
field key kind: identifierFieldKey
key text: opens
type: FieldKey

opens
is optional: true
max count: 1
field type: unknown
field key: key
comment: Number of opens in this slice
type: Field

key
field key kind: identifierFieldKey
key text: unique opens
type: FieldKey

unique opens
is optional: true
max count: 1
field type: unknown
field key: key
comment: Number of unique opens in this slice
type: Field

key
field key kind: identifierFieldKey
key text: clicks
type: FieldKey

clicks
is optional: true
max count: 1
field type: unknown
field key: key
comment: Number of clicks in this slice
type: Field

key
field key kind: identifierFieldKey
key text: unique clicks
type: FieldKey

unique clicks
is optional: true
max count: 1
field type: unknown
field key: key
comment: Number of unique clicks in this slice
type: Field

key
field key kind: identifierFieldKey
key text: bounces
type: FieldKey

bounces
is optional: true
max count: 1
field type: unknown
field key: key
comment: Number of bounces in this slice
type: Field

key
field key kind: identifierFieldKey
key text: last open
type: FieldKey

last open
is optional: true
max count: 1
field type: offsetDateTime
field key: key
comment: Timestamp of the last open in this slice
type: Field

key
field key kind: identifierFieldKey
key text: last click
type: FieldKey

last click
is optional: true
max count: 1
field type: offsetDateTime
field key: key
comment: Timestamp of the last click in this slice
type: Field

key
field key kind: identifierFieldKey
key text: bounces
type: FieldKey

bounces
is optional: true
max count: 1
field type: unknown
field key: key
comment: Number of bounces for this arm
type: Field

ABSplit Arm
has field: bounces
comment: Nested record for a single A/B split arm in CampaignReport.abSplit.
type: RecordType
has field: abuse reports
has field: unsubs
has field: recipient clicks
has field: forwards
has field: forwards opens
has field: opens
has field: unique opens
has field: last open

key
field key kind: identifierFieldKey
key text: abuse reports
type: FieldKey

abuse reports
is optional: true
max count: 1
field type: unknown
field key: key
comment: Number of abuse reports for this arm
type: Field

key
field key kind: identifierFieldKey
key text: unsubs
type: FieldKey

unsubs
is optional: true
max count: 1
field type: unknown
field key: key
comment: Number of unsubscribes for this arm
type: Field

key
field key kind: identifierFieldKey
key text: recipient clicks
type: FieldKey

recipient clicks
is optional: true
max count: 1
field type: unknown
field key: key
comment: Total recipient clicks for this arm
type: Field

key
field key kind: identifierFieldKey
key text: forwards
type: FieldKey

forwards
is optional: true
max count: 1
field type: unknown
field key: key
comment: Number of forwards for this arm
type: Field

key
field key kind: identifierFieldKey
key text: forwards opens
type: FieldKey

forwards opens
is optional: true
max count: 1
field type: unknown
field key: key
comment: Number of opens from forwarded copies for this arm
type: Field

key
field key kind: identifierFieldKey
key text: opens
type: FieldKey

opens
is optional: true
max count: 1
field type: unknown
field key: key
comment: Number of opens for this arm
type: Field

key
field key kind: identifierFieldKey
key text: unique opens
type: FieldKey

unique opens
is optional: true
max count: 1
field type: unknown
field key: key
comment: Number of unique opens for this arm
type: Field

key
field key kind: identifierFieldKey
key text: last open
type: FieldKey

last open
is optional: true
max count: 1
field type: string
field key: key
comment: Timestamp of the last open in this arm. The spec does not declare a datetime format on this field; deliberately string.
type: Field

key
field key kind: identifierFieldKey
key text: a
type: FieldKey

a
is optional: true
max count: 1
field type: ABSplit Arm
field key: key
comment: Metrics for variant A
type: Field

ABSplit Result
has field: a
comment: Nested record for CampaignReport.abSplit (legacy A/B test results).
type: RecordType
has field: b

key
field key kind: identifierFieldKey
key text: b
type: FieldKey

b
is optional: true
max count: 1
field type: ABSplit Arm
field key: key
comment: Metrics for variant B
type: Field

key
field key kind: identifierFieldKey
key text: sub rate
type: FieldKey

sub rate
is optional: true
max count: 1
field type: float
field key: key
comment: Audience subscribe rate
type: Field

Report List Stats
has field: sub rate
comment: Nested record for CampaignReport.listStats.
type: RecordType
has field: unsub rate
has field: open rate
has field: proxy excluded open rate
has field: click rate

key
field key kind: identifierFieldKey
key text: unsub rate
type: FieldKey

unsub rate
is optional: true
max count: 1
field type: float
field key: key
comment: Audience unsubscribe rate
type: Field

key
field key kind: identifierFieldKey
key text: open rate
type: FieldKey

open rate
is optional: true
max count: 1
field type: float
field key: key
comment: Audience open rate
type: Field

key
field key kind: identifierFieldKey
key text: proxy excluded open rate
type: FieldKey

proxy excluded open rate
is optional: true
max count: 1
field type: float
field key: key
comment: Audience open rate excluding privacy-proxy-generated opens
type: Field

key
field key kind: identifierFieldKey
key text: click rate
type: FieldKey

click rate
is optional: true
max count: 1
field type: float
field key: key
comment: Audience click rate
type: Field

key
field key kind: identifierFieldKey
key text: type
type: FieldKey

type
is optional: true
max count: 1
field type: string
field key: key
comment: Industry segment label
type: Field

Industry Stats
has field: type
comment: Nested record for CampaignReport.industryStats. Industry benchmark rates Mailchimp publishes for the campaign's declared industry segment.
type: RecordType
has field: open rate
has field: click rate
has field: bounce rate
has field: unopen rate
has field: unsub rate
has field: abuse rate

key
field key kind: identifierFieldKey
key text: open rate
type: FieldKey

open rate
is optional: true
max count: 1
field type: float
field key: key
comment: Industry-average open rate
type: Field

key
field key kind: identifierFieldKey
key text: click rate
type: FieldKey

click rate
is optional: true
max count: 1
field type: float
field key: key
comment: Industry-average click rate
type: Field

key
field key kind: identifierFieldKey
key text: bounce rate
type: FieldKey

bounce rate
is optional: true
max count: 1
field type: float
field key: key
comment: Industry-average bounce rate
type: Field

key
field key kind: identifierFieldKey
key text: unopen rate
type: FieldKey

unopen rate
is optional: true
max count: 1
field type: float
field key: key
comment: Industry-average unopen rate
type: Field

key
field key kind: identifierFieldKey
key text: unsub rate
type: FieldKey

unsub rate
is optional: true
max count: 1
field type: float
field key: key
comment: Industry-average unsubscribe rate
type: Field

key
field key kind: identifierFieldKey
key text: abuse rate
type: FieldKey

abuse rate
is optional: true
max count: 1
field type: float
field key: key
comment: Industry-average abuse-report rate
type: Field

key
field key kind: identifierFieldKey
key text: recipient likes
type: FieldKey

recipient likes
is optional: true
max count: 1
field type: unknown
field key: key
comment: Number of likes from recipients of this campaign
type: Field

Facebook Likes
has field: recipient likes
comment: Nested record for CampaignReport.facebookLikes.
type: RecordType
has field: unique likes
has field: facebook likes

key
field key kind: identifierFieldKey
key text: unique likes
type: FieldKey

unique likes
is optional: true
max count: 1
field type: unknown
field key: key
comment: Number of unique users who liked the campaign on Facebook
type: Field

key
field key kind: identifierFieldKey
key text: facebook likes
type: FieldKey

facebook likes
is optional: true
max count: 1
field type: unknown
field key: key
comment: Total Facebook likes attributed to the campaign
type: Field

key
field key kind: identifierFieldKey
key text: clicks total
type: FieldKey

clicks total
is optional: true
max count: 1
field type: unknown
field key: key
comment: Total number of clicks
type: Field

Clicks
has field: clicks total
comment: Nested record for CampaignReport.clicks.
type: RecordType
has field: unique clicks
has field: unique subscriber clicks
has field: click rate
has field: last click

key
field key kind: identifierFieldKey
key text: unique clicks
type: FieldKey

unique clicks
is optional: true
max count: 1
field type: unknown
field key: key
comment: Number of unique clicks
type: Field

key
field key kind: identifierFieldKey
key text: unique subscriber clicks
type: FieldKey

unique subscriber clicks
is optional: true
max count: 1
field type: unknown
field key: key
comment: Number of unique subscribers who clicked
type: Field

key
field key kind: identifierFieldKey
key text: click rate
type: FieldKey

click rate
is optional: true
max count: 1
field type: float
field key: key
comment: Click rate (clicks / emails sent)
type: Field

key
field key kind: identifierFieldKey
key text: last click
type: FieldKey

last click
is optional: true
max count: 1
field type: offsetDateTime
field key: key
comment: Timestamp of the most recent click
type: Field

key
field key kind: identifierFieldKey
key text: opens total
type: FieldKey

opens total
is optional: true
max count: 1
field type: unknown
field key: key
comment: Total number of opens (including proxy opens)
type: Field

Opens
has field: opens total
comment: Nested record for CampaignReport.opens.
type: RecordType
has field: proxy excluded opens
has field: unique opens
has field: proxy excluded unique opens
has field: open rate
has field: proxy excluded open rate
has field: last open

key
field key kind: identifierFieldKey
key text: proxy excluded opens
type: FieldKey

proxy excluded opens
is optional: true
max count: 1
field type: unknown
field key: key
comment: Total opens excluding privacy-proxy-generated opens
type: Field

key
field key kind: identifierFieldKey
key text: unique opens
type: FieldKey

unique opens
is optional: true
max count: 1
field type: unknown
field key: key
comment: Number of unique recipients who opened the campaign
type: Field

key
field key kind: identifierFieldKey
key text: proxy excluded unique opens
type: FieldKey

proxy excluded unique opens
is optional: true
max count: 1
field type: unknown
field key: key
comment: Unique opens excluding privacy-proxy-generated opens
type: Field

key
field key kind: identifierFieldKey
key text: open rate
type: FieldKey

open rate
is optional: true
max count: 1
field type: float
field key: key
comment: Open rate (opens / emails sent)
type: Field

key
field key kind: identifierFieldKey
key text: proxy excluded open rate
type: FieldKey

proxy excluded open rate
is optional: true
max count: 1
field type: float
field key: key
comment: Open rate excluding privacy-proxy-generated opens
type: Field

key
field key kind: identifierFieldKey
key text: last open
type: FieldKey

last open
is optional: true
max count: 1
field type: offsetDateTime
field key: key
comment: Timestamp of the most recent open
type: Field

key
field key kind: identifierFieldKey
key text: forwards count
type: FieldKey

forwards count
is optional: true
max count: 1
field type: unknown
field key: key
comment: Number of times the campaign was forwarded
type: Field

Forwards
has field: forwards count
comment: Nested record for CampaignReport.forwards.
type: RecordType
has field: forwards opens

key
field key kind: identifierFieldKey
key text: forwards opens
type: FieldKey

forwards opens
is optional: true
max count: 1
field type: unknown
field key: key
comment: Number of opens generated by forwarded copies
type: Field

key
field key kind: identifierFieldKey
key text: hard bounces
type: FieldKey

hard bounces
is optional: true
max count: 1
field type: unknown
field key: key
comment: Number of hard bounces
type: Field

Bounces
has field: hard bounces
comment: Nested record for CampaignReport.bounces.
type: RecordType
has field: soft bounces
has field: syntax errors

key
field key kind: identifierFieldKey
key text: soft bounces
type: FieldKey

soft bounces
is optional: true
max count: 1
field type: unknown
field key: key
comment: Number of soft bounces
type: Field

key
field key kind: identifierFieldKey
key text: syntax errors
type: FieldKey

syntax errors
is optional: true
max count: 1
field type: unknown
field key: key
comment: Number of syntax errors in recipient addresses
type: Field

key
field key kind: identifierFieldKey
key text: id
type: FieldKey

id
is optional: false
max count: 1
min count: 1
field type: Campaign
field key: key
comment: Campaign report ID. Equal to the corresponding Campaign.id verbatim (1:1 keying). Acts as @key for this entity AND as Ref<Campaign>.
type: Field

Campaign Report
has field: id
comment: Aggregate report for a Mailchimp campaign. Note: `id` is **both** the key for this entity AND a Ref<Campaign>. The campaign report keys on the campaign's own ID (1:1 keying — there is exactly one report per campaign and the report's ID is the campaign's ID verbatim). This is the only entity in this service where the
type: RecordType
has field: campaign title
has field: type
has field: list id
has field: list is active
has field: list name
has field: subject line
has field: preview text
has field: emails sent
has field: abuse reports
has field: unsubscribed
has field: send time
has field: rss last send
has field: bounces
has field: forwards
has field: opens
has field: clicks
has field: facebook likes
has field: industry stats
has field: list stats
has field: ab split
has field: timewarp
has field: timeseries
has field: share report
has field: ecommerce
has field: delivery status
has field: links

key
field key kind: identifierFieldKey
key text: campaign title
type: FieldKey

campaign title
is optional: true
max count: 1
field type: string
field key: key
comment: Title of the source campaign
type: Field

key
field key kind: identifierFieldKey
key text: type
type: FieldKey

type
is optional: true
max count: 1
field type: string
field key: key
comment: Campaign report type. Wire formats differ from Campaign.type (hyphen/underscore drift; extra `automation` and `auto` values).
type: Field

key
field key kind: identifierFieldKey
key text: list id
type: FieldKey

list id
is optional: true
max count: 1
field type: List
field key: key
comment: Audience (list) the source campaign sent to
type: Field

key
field key kind: identifierFieldKey
key text: list is active
type: FieldKey

list is active
is optional: true
max count: 1
field type: boolean
field key: key
comment: Whether the target audience is currently active
type: Field

key
field key kind: identifierFieldKey
key text: list name
type: FieldKey

list name
is optional: true
max count: 1
field type: string
field key: key
comment: Display name of the target audience
type: Field

key
field key kind: identifierFieldKey
key text: subject line
type: FieldKey

subject line
is optional: true
max count: 1
field type: string
field key: key
comment: Subject line of the source campaign
type: Field

key
field key kind: identifierFieldKey
key text: preview text
type: FieldKey

preview text
is optional: true
max count: 1
field type: string
field key: key
comment: Preview text of the source campaign
type: Field

key
field key kind: identifierFieldKey
key text: emails sent
type: FieldKey

emails sent
is optional: true
max count: 1
field type: unknown
field key: key
comment: Total number of emails sent
type: Field

key
field key kind: identifierFieldKey
key text: abuse reports
type: FieldKey

abuse reports
is optional: true
max count: 1
field type: unknown
field key: key
comment: Total number of abuse reports
type: Field

key
field key kind: identifierFieldKey
key text: unsubscribed
type: FieldKey

unsubscribed
is optional: true
max count: 1
field type: unknown
field key: key
comment: Total number of unsubscribes
type: Field

key
field key kind: identifierFieldKey
key text: send time
type: FieldKey

send time
is optional: true
max count: 1
field type: offsetDateTime
field key: key
comment: Timestamp when the campaign was sent
type: Field

key
field key kind: identifierFieldKey
key text: rss last send
type: FieldKey

rss last send
is optional: true
max count: 1
field type: offsetDateTime
field key: key
comment: Timestamp of the most recent RSS send for RSS campaigns
type: Field

key
field key kind: identifierFieldKey
key text: bounces
type: FieldKey

bounces
is optional: true
max count: 1
field type: Bounces
field key: key
comment: Bounce breakdown
type: Field

key
field key kind: identifierFieldKey
key text: forwards
type: FieldKey

forwards
is optional: true
max count: 1
field type: Forwards
field key: key
comment: Forward counts
type: Field

key
field key kind: identifierFieldKey
key text: opens
type: FieldKey

opens
is optional: true
max count: 1
field type: Opens
field key: key
comment: Open counts, rates, and last-open timestamp
type: Field

key
field key kind: identifierFieldKey
key text: clicks
type: FieldKey

clicks
is optional: true
max count: 1
field type: Clicks
field key: key
comment: Click counts, rates, and last-click timestamp
type: Field

key
field key kind: identifierFieldKey
key text: facebook likes
type: FieldKey

facebook likes
is optional: true
max count: 1
field type: Facebook Likes
field key: key
comment: Facebook likes attributable to the campaign
type: Field

key
field key kind: identifierFieldKey
key text: industry stats
type: FieldKey

industry stats
is optional: true
max count: 1
field type: Industry Stats
field key: key
comment: Industry benchmark rates
type: Field

key
field key kind: identifierFieldKey
key text: list stats
type: FieldKey

list stats
is optional: true
max count: 1
field type: Report List Stats
field key: key
comment: Audience-level rate snapshot
type: Field

key
field key kind: identifierFieldKey
key text: ab split
type: FieldKey

ab split
is optional: true
max count: 1
field type: ABSplit Result
field key: key
comment: Legacy A/B split test arm metrics
type: Field

timewarp array
is anonymous: true
array value type: Timewarp Entry
type: ArrayExpression

key
field key kind: identifierFieldKey
key text: timewarp
type: FieldKey

timewarp
is optional: true
field type: timewarp array
field key: key
comment: Per-timezone Timewarp delivery slices
type: Field

timeseries array
is anonymous: true
array value type: Timeseries Entry
type: ArrayExpression

key
field key kind: identifierFieldKey
key text: timeseries
type: FieldKey

timeseries
is optional: true
field type: timeseries array
field key: key
comment: Send/open/click counts bucketed over time
type: Field

key
field key kind: identifierFieldKey
key text: share report
type: FieldKey

share report
is optional: true
max count: 1
field type: Share Report
field key: key
comment: Shareable URL and password for the campaign report
type: Field

key
field key kind: identifierFieldKey
key text: ecommerce
type: FieldKey

ecommerce
is optional: true
max count: 1
field type: Ecommerce
field key: key
comment: Ecommerce totals attributed to the campaign
type: Field

key
field key kind: identifierFieldKey
key text: delivery status
type: FieldKey

delivery status
is optional: true
max count: 1
field type: Delivery Status
field key: key
comment: Delivery status; see common DeliveryStatus
type: Field

links array
is anonymous: true
array value type: HALLink
type: ArrayExpression

key
field key kind: identifierFieldKey
key text: links
type: FieldKey

links
is optional: true
field type: links array
field key: key
comment: HATEOAS links for the campaign report resource
type: Field

key
field key kind: identifierFieldKey
key text: id
type: FieldKey

id
is optional: true
max count: 1
field type: Campaign
field key: key
comment: Original campaign ID
type: Field

Original Shortcut Campaign
has field: id
comment: Nested record for Campaign.resendShortcutUsage.originalCampaign. Every field on this sub-shape is read-only.
type: RecordType
has field: web id
has field: title
has field: shortcut type

key
field key kind: identifierFieldKey
key text: web id
type: FieldKey

web id
is optional: true
max count: 1
field type: unknown
field key: key
comment: Display ID used in the Mailchimp web UI; not an entity reference
type: Field

key
field key kind: identifierFieldKey
key text: title
type: FieldKey

title
is optional: true
max count: 1
field type: string
field key: key
comment: Internal title of the original campaign
type: Field

key
field key kind: identifierFieldKey
key text: shortcut type
type: FieldKey

shortcut type
is optional: true
max count: 1
field type: string
field key: key
comment: Resend shortcut variant used
type: Field

key
field key kind: identifierFieldKey
key text: id
type: FieldKey

id
is optional: true
max count: 1
field type: Campaign
field key: key
comment: Resend campaign ID
type: Field

Shortcut Campaign
has field: id
comment: Nested record for a resend-shortcut child campaign. Every field on this sub-shape is read-only.
type: RecordType
has field: web id
has field: shortcut type
has field: send time
has field: status

key
field key kind: identifierFieldKey
key text: web id
type: FieldKey

web id
is optional: true
max count: 1
field type: unknown
field key: key
comment: Display ID used in the Mailchimp web UI; not an entity reference
type: Field

key
field key kind: identifierFieldKey
key text: shortcut type
type: FieldKey

shortcut type
is optional: true
max count: 1
field type: string
field key: key
comment: Resend shortcut variant used to generate this campaign
type: Field

key
field key kind: identifierFieldKey
key text: send time
type: FieldKey

send time
is optional: true
max count: 1
field type: offsetDateTime
field key: key
comment: Send time of the resend campaign
type: Field

key
field key kind: identifierFieldKey
key text: status
type: FieldKey

status
is optional: true
max count: 1
field type: string
field key: key
comment: Lifecycle status of the resend campaign
type: Field

shortcut campaigns array
is anonymous: true
array value type: Shortcut Campaign
type: ArrayExpression

key
field key kind: identifierFieldKey
key text: shortcut campaigns
type: FieldKey

shortcut campaigns
is optional: true
field type: shortcut campaigns array
field key: key
comment: Campaigns generated from resend shortcuts on this original campaign
type: Field

Resend Shortcut Usage
has field: shortcut campaigns
comment: Nested record for Campaign.resendShortcutUsage.
type: RecordType
has field: original campaign

key
field key kind: identifierFieldKey
key text: original campaign
type: FieldKey

original campaign
is optional: true
max count: 1
field type: Original Shortcut Campaign
field key: key
comment: Original campaign that produced these resend shortcuts
type: Field

key
field key kind: identifierFieldKey
key text: is eligible
type: FieldKey

is eligible
is optional: true
max count: 1
field type: boolean
field key: key
comment: Whether this shortcut is eligible to be triggered
type: Field

Resend Eligibility Entry
has field: is eligible
comment: Nested record for a single resend-shortcut eligibility entry.
type: RecordType
has field: reason

key
field key kind: identifierFieldKey
key text: reason
type: FieldKey

reason
is optional: true
max count: 1
field type: string
field key: key
comment: Reason explaining why this shortcut is or is not eligible
type: Field

key
field key kind: identifierFieldKey
key text: to non openers
type: FieldKey

to non openers
is optional: true
max count: 1
field type: Resend Eligibility Entry
field key: key
comment: Eligibility for resending to non-openers
type: Field

Resend Shortcut Eligibility
has field: to non openers
comment: Nested record for Campaign.resendShortcutEligibility. Only populated when the request includes `include_resend_shortcuts=true`.
type: RecordType
has field: to new subscribers
has field: to non clickers
has field: to non purchasers

key
field key kind: identifierFieldKey
key text: to new subscribers
type: FieldKey

to new subscribers
is optional: true
max count: 1
field type: Resend Eligibility Entry
field key: key
comment: Eligibility for resending to new subscribers
type: Field

key
field key kind: identifierFieldKey
key text: to non clickers
type: FieldKey

to non clickers
is optional: true
max count: 1
field type: Resend Eligibility Entry
field key: key
comment: Eligibility for resending to non-clickers
type: Field

key
field key kind: identifierFieldKey
key text: to non purchasers
type: FieldKey

to non purchasers
is optional: true
max count: 1
field type: Resend Eligibility Entry
field key: key
comment: Eligibility for resending to non-purchasers
type: Field

key
field key kind: identifierFieldKey
key text: image url
type: FieldKey

image url
is optional: true
max count: 1
field type: url
field key: key
comment: Image URL used for the social-card preview
type: Field

Social Card
has field: image url
comment: Nested record for Campaign.socialCard.
type: RecordType
has field: description
has field: title

key
field key kind: identifierFieldKey
key text: description
type: FieldKey

description
is optional: true
max count: 1
field type: string
field key: key
comment: Social-card description text
type: Field

key
field key kind: identifierFieldKey
key text: title
type: FieldKey

title
is optional: true
max count: 1
field type: string
field key: key
comment: Social-card title
type: Field

key
field key kind: identifierFieldKey
key text: split test
type: FieldKey

split test
is optional: true
max count: 1
field type: string
field key: key
comment: Which campaign attribute is being split-tested
type: Field

ABSplit Opts
has field: split test
comment: Nested record for Campaign.abSplitOpts (legacy A/B split tests; use VariateSettings instead). Every field on this sub-shape is read-only; the entire abSplitOpts block is returned by the API but cannot be mutated client-side.
type: RecordType
has field: pick winner
has field: wait units
has field: wait time
has field: split size
has field: from name a
has field: from name b
has field: reply email a
has field: reply email b
has field: subject a
has field: subject b
has field: send time a
has field: send time b
has field: send time winner

key
field key kind: identifierFieldKey
key text: pick winner
type: FieldKey

pick winner
is optional: true
max count: 1
field type: string
field key: key
comment: How the winning variant is selected
type: Field

key
field key kind: identifierFieldKey
key text: wait units
type: FieldKey

wait units
is optional: true
max count: 1
field type: string
field key: key
comment: Unit used for waitTime before evaluating the winner
type: Field

key
field key kind: identifierFieldKey
key text: wait time
type: FieldKey

wait time
is optional: true
max count: 1
field type: unknown
field key: key
comment: Time to wait before evaluating the winner
type: Field

key
field key kind: identifierFieldKey
key text: split size
type: FieldKey

split size
is optional: true
max count: 1
field type: unknown
field key: key
comment: Percentage of the audience used for the test split
type: Field

key
field key kind: identifierFieldKey
key text: from name a
type: FieldKey

from name a
is optional: true
max count: 1
field type: string
field key: key
comment: From name used for variant A
type: Field

key
field key kind: identifierFieldKey
key text: from name b
type: FieldKey

from name b
is optional: true
max count: 1
field type: string
field key: key
comment: From name used for variant B
type: Field

key
field key kind: identifierFieldKey
key text: reply email a
type: FieldKey

reply email a
is optional: true
max count: 1
field type: string
field key: key
comment: Reply-to email used for variant A
type: Field

key
field key kind: identifierFieldKey
key text: reply email b
type: FieldKey

reply email b
is optional: true
max count: 1
field type: string
field key: key
comment: Reply-to email used for variant B
type: Field

key
field key kind: identifierFieldKey
key text: subject a
type: FieldKey

subject a
is optional: true
max count: 1
field type: string
field key: key
comment: Subject line used for variant A
type: Field

key
field key kind: identifierFieldKey
key text: subject b
type: FieldKey

subject b
is optional: true
max count: 1
field type: string
field key: key
comment: Subject line used for variant B
type: Field

key
field key kind: identifierFieldKey
key text: send time a
type: FieldKey

send time a
is optional: true
max count: 1
field type: offsetDateTime
field key: key
comment: Send time for variant A
type: Field

key
field key kind: identifierFieldKey
key text: send time b
type: FieldKey

send time b
is optional: true
max count: 1
field type: offsetDateTime
field key: key
comment: Send time for variant B
type: Field

key
field key kind: identifierFieldKey
key text: send time winner
type: FieldKey

send time winner
is optional: true
max count: 1
field type: string
field key: key
comment: Send time for the winning variant. Local-clock string, not ISO 8601; deliberately string rather than utcDateTime.
type: Field

key
field key kind: identifierFieldKey
key text: sunday
type: FieldKey

sunday
is optional: true
max count: 1
field type: boolean
field key: key
comment: Send on Sundays
type: Field

Rss Daily Send
has field: sunday
comment: Nested record for Campaign.rssOpts.schedule.dailySend.
type: RecordType
has field: monday
has field: tuesday
has field: wednesday
has field: thursday
has field: friday
has field: saturday

key
field key kind: identifierFieldKey
key text: monday
type: FieldKey

monday
is optional: true
max count: 1
field type: boolean
field key: key
comment: Send on Mondays
type: Field

key
field key kind: identifierFieldKey
key text: tuesday
type: FieldKey

tuesday
is optional: true
max count: 1
field type: boolean
field key: key
comment: Send on Tuesdays
type: Field

key
field key kind: identifierFieldKey
key text: wednesday
type: FieldKey

wednesday
is optional: true
max count: 1
field type: boolean
field key: key
comment: Send on Wednesdays
type: Field

key
field key kind: identifierFieldKey
key text: thursday
type: FieldKey

thursday
is optional: true
max count: 1
field type: boolean
field key: key
comment: Send on Thursdays
type: Field

key
field key kind: identifierFieldKey
key text: friday
type: FieldKey

friday
is optional: true
max count: 1
field type: boolean
field key: key
comment: Send on Fridays
type: Field

key
field key kind: identifierFieldKey
key text: saturday
type: FieldKey

saturday
is optional: true
max count: 1
field type: boolean
field key: key
comment: Send on Saturdays
type: Field

key
field key kind: identifierFieldKey
key text: hour
type: FieldKey

hour
is optional: true
max count: 1
field type: unknown
field key: key
comment: Hour of the day to send (0-23)
type: Field

Rss Schedule
has field: hour
comment: Nested record for Campaign.rssOpts.schedule.
type: RecordType
has field: daily send
has field: weekly send day
has field: monthly send date

key
field key kind: identifierFieldKey
key text: daily send
type: FieldKey

daily send
is optional: true
max count: 1
field type: Rss Daily Send
field key: key
comment: Per-day enable flags for daily RSS sends
type: Field

key
field key kind: identifierFieldKey
key text: weekly send day
type: FieldKey

weekly send day
is optional: true
max count: 1
field type: string
field key: key
comment: Day of the week to send for weekly RSS campaigns
type: Field

key
field key kind: identifierFieldKey
key text: monthly send date
type: FieldKey

monthly send date
is optional: true
max count: 1
field type: float
field key: key
comment: Day of the month to send for monthly RSS campaigns (0-31; 0 means the last day of the month)
type: Field

key
field key kind: identifierFieldKey
key text: feed url
type: FieldKey

feed url
is optional: true
max count: 1
field type: url
field key: key
comment: RSS feed URL polled to drive the campaign
type: Field

Rss Opts
has field: feed url
comment: Nested record for Campaign.rssOpts.
type: RecordType
has field: frequency
has field: schedule
has field: last sent
has field: constrain rss img

key
field key kind: identifierFieldKey
key text: frequency
type: FieldKey

frequency
is optional: true
max count: 1
field type: string
field key: key
comment: Polling cadence for the RSS feed
type: Field

key
field key kind: identifierFieldKey
key text: schedule
type: FieldKey

schedule
is optional: true
max count: 1
field type: Rss Schedule
field key: key
comment: Detailed schedule controlling when the feed is polled
type: Field

key
field key kind: identifierFieldKey
key text: last sent
type: FieldKey

last sent
is optional: true
max count: 1
field type: offsetDateTime
field key: key
comment: Timestamp of the most recent RSS send
type: Field

key
field key kind: identifierFieldKey
key text: constrain rss img
type: FieldKey

constrain rss img
is optional: true
max count: 1
field type: boolean
field key: key
comment: Whether to constrain RSS images to the template width
type: Field

key
field key kind: identifierFieldKey
key text: id
type: FieldKey

id
is optional: true
max count: 1
field type: string
field key: key
comment: Unique ID for this variate combination
type: Field

Variate Combination
has field: id
comment: Nested record for Campaign.variateSettings.combinations[]. The integer fields (`subjectLine`, `sendTime`, `fromName`, `replyTo`, `contentDescription`, `recipients`) are **array indices into sibling string arrays on VariateSettings**, NOT entity references. They must never be modeled as Ref<T>.
type: RecordType
has field: subject line
has field: send time
has field: from name
has field: reply to
has field: content description
has field: recipients

key
field key kind: identifierFieldKey
key text: subject line
type: FieldKey

subject line
is optional: true
max count: 1
field type: unknown
field key: key
comment: Array index into Campaign.variateSettings.subject_lines; NOT a Ref.
type: Field

key
field key kind: identifierFieldKey
key text: send time
type: FieldKey

send time
is optional: true
max count: 1
field type: unknown
field key: key
comment: Array index into Campaign.variateSettings.send_times; NOT a Ref.
type: Field

key
field key kind: identifierFieldKey
key text: from name
type: FieldKey

from name
is optional: true
max count: 1
field type: unknown
field key: key
comment: Array index into Campaign.variateSettings.from_names; NOT a Ref.
type: Field

key
field key kind: identifierFieldKey
key text: reply to
type: FieldKey

reply to
is optional: true
max count: 1
field type: unknown
field key: key
comment: Array index into Campaign.variateSettings.reply_to_addresses; NOT a Ref.
type: Field

key
field key kind: identifierFieldKey
key text: content description
type: FieldKey

content description
is optional: true
max count: 1
field type: unknown
field key: key
comment: Array index into Campaign.variateSettings.contents; NOT a Ref.
type: Field

key
field key kind: identifierFieldKey
key text: recipients
type: FieldKey

recipients
is optional: true
max count: 1
field type: unknown
field key: key
comment: Array index recording which recipient slice received this combination; NOT a Ref.
type: Field

key
field key kind: identifierFieldKey
key text: winning combination id
type: FieldKey

winning combination id
is optional: true
max count: 1
field type: string
field key: key
comment: ID of the combination chosen as the variate winner
type: Field

Variate Settings
has field: winning combination id
comment: Nested record for Campaign.variateSettings.
type: RecordType
has field: winning campaign id
has field: winner criteria
has field: wait time
has field: test size
has field: subject lines
has field: send times
has field: from names
has field: reply to addresses
has field: contents
has field: combinations

key
field key kind: identifierFieldKey
key text: winning campaign id
type: FieldKey

winning campaign id
is optional: true
max count: 1
field type: Campaign
field key: key
comment: ID of the campaign sent to the remaining audience after a variate winner is selected
type: Field

key
field key kind: identifierFieldKey
key text: winner criteria
type: FieldKey

winner criteria
is optional: true
max count: 1
field type: string
field key: key
comment: Criterion used to pick the variate winner
type: Field

key
field key kind: identifierFieldKey
key text: wait time
type: FieldKey

wait time
is optional: true
max count: 1
field type: unknown
field key: key
comment: Wait time before evaluating variate combinations
type: Field

key
field key kind: identifierFieldKey
key text: test size
type: FieldKey

test size
is optional: true
max count: 1
field type: unknown
field key: key
comment: Fraction of the audience used for the variate test
type: Field

subject lines array
is anonymous: true
array value type: string
type: ArrayExpression

key
field key kind: identifierFieldKey
key text: subject lines
type: FieldKey

subject lines
is optional: true
field type: subject lines array
field key: key
comment: Subject lines tested in this variate campaign
type: Field

send times array
is anonymous: true
array value type: string
type: ArrayExpression

key
field key kind: identifierFieldKey
key text: send times
type: FieldKey

send times
is optional: true
field type: send times array
field key: key
comment: Send times tested in this variate campaign. Local-clock format YYYY-MM-DD HH:MM:SS, not ISO 8601; deliberately string[] rather than utcDateTime[].
type: Field

from names array
is anonymous: true
array value type: string
type: ArrayExpression

key
field key kind: identifierFieldKey
key text: from names
type: FieldKey

from names
is optional: true
field type: from names array
field key: key
comment: From names tested in this variate campaign
type: Field

reply to addresses array
is anonymous: true
array value type: string
type: ArrayExpression

key
field key kind: identifierFieldKey
key text: reply to addresses
type: FieldKey

reply to addresses
is optional: true
field type: reply to addresses array
field key: key
comment: Reply-to addresses tested in this variate campaign
type: Field

contents array
is anonymous: true
array value type: string
type: ArrayExpression

key
field key kind: identifierFieldKey
key text: contents
type: FieldKey

contents
is optional: true
field type: contents array
field key: key
comment: Content blocks tested in this variate campaign
type: Field

combinations array
is anonymous: true
array value type: Variate Combination
type: ArrayExpression

key
field key kind: identifierFieldKey
key text: combinations
type: FieldKey

combinations
is optional: true
field type: combinations array
field key: key
comment: Resolved variate combinations and their per-arm metrics
type: Field

key
field key kind: identifierFieldKey
key text: subject line
type: FieldKey

subject line
is optional: true
max count: 1
field type: string
field key: key
comment: Subject line shown in the recipient's inbox
type: Field

Campaign Settings
has field: subject line
comment: Nested record for Campaign.settings.
type: RecordType
has field: preview text
has field: title
has field: from name
has field: reply to
has field: use conversation
has field: to name
has field: folder id
has field: authenticate
has field: auto footer
has field: inline css
has field: auto tweet
has field: auto fb post
has field: fb comments
has field: timewarp
has field: template id
has field: drag and drop
has field: google analytics
has field: clicktale

key
field key kind: identifierFieldKey
key text: preview text
type: FieldKey

preview text
is optional: true
max count: 1
field type: string
field key: key
comment: Preview snippet rendered in inbox clients alongside the subject
type: Field

key
field key kind: identifierFieldKey
key text: title
type: FieldKey

title
is optional: true
max count: 1
field type: string
field key: key
comment: Internal title of the campaign (not shown to recipients)
type: Field

key
field key kind: identifierFieldKey
key text: from name
type: FieldKey

from name
is optional: true
max count: 1
field type: string
field key: key
comment: Display name shown in the From header
type: Field

key
field key kind: identifierFieldKey
key text: reply to
type: FieldKey

reply to
is optional: true
max count: 1
field type: string
field key: key
comment: Reply-to email address
type: Field

key
field key kind: identifierFieldKey
key text: use conversation
type: FieldKey

use conversation
is optional: true
max count: 1
field type: boolean
field key: key
comment: Whether to enable Mailchimp Conversation for inbound replies
type: Field

key
field key kind: identifierFieldKey
key text: to name
type: FieldKey

to name
is optional: true
max count: 1
field type: string
field key: key
comment: Recipient name expression (merge-tag aware)
type: Field

key
field key kind: identifierFieldKey
key text: folder id
type: FieldKey

folder id
is optional: true
max count: 1
field type: string
field key: key
comment: Campaign folder ID. Dangling Ref<CampaignFolder>; CampaignFolder entity not in v1.
type: Field

key
field key kind: identifierFieldKey
key text: authenticate
type: FieldKey

authenticate
is optional: true
max count: 1
field type: boolean
field key: key
comment: Whether the campaign is authenticated (DKIM/SPF)
type: Field

key
field key kind: identifierFieldKey
key text: auto footer
type: FieldKey

auto footer
is optional: true
max count: 1
field type: boolean
field key: key
comment: Whether the default Mailchimp footer is automatically appended
type: Field

key
field key kind: identifierFieldKey
key text: inline css
type: FieldKey

inline css
is optional: true
max count: 1
field type: boolean
field key: key
comment: Whether CSS is inlined automatically on send
type: Field

key
field key kind: identifierFieldKey
key text: auto tweet
type: FieldKey

auto tweet
is optional: true
max count: 1
field type: boolean
field key: key
comment: Whether the campaign auto-tweets when sent
type: Field

auto fb post array
is anonymous: true
array value type: string
type: ArrayExpression

key
field key kind: identifierFieldKey
key text: auto fb post
type: FieldKey

auto fb post
is optional: true
field type: auto fb post array
field key: key
comment: Facebook page IDs to auto-post the campaign to
type: Field

key
field key kind: identifierFieldKey
key text: fb comments
type: FieldKey

fb comments
is optional: true
max count: 1
field type: boolean
field key: key
comment: Whether Facebook comments are enabled on the campaign
type: Field

key
field key kind: identifierFieldKey
key text: timewarp
type: FieldKey

timewarp
is optional: true
max count: 1
field type: boolean
field key: key
comment: Whether Timewarp delivery is enabled
type: Field

key
field key kind: identifierFieldKey
key text: template id
type: FieldKey

template id
is optional: true
max count: 1
field type: unknown
field key: key
comment: Template ID used to construct the campaign content. Dangling Ref<Template>; Template entity not in v1.
type: Field

key
field key kind: identifierFieldKey
key text: drag and drop
type: FieldKey

drag and drop
is optional: true
max count: 1
field type: boolean
field key: key
comment: Whether the campaign was built with the drag-and-drop editor
type: Field

key
field key kind: identifierFieldKey
key text: google analytics
type: FieldKey

google analytics
is optional: true
max count: 1
field type: string
field key: key
comment: Google Analytics campaign name (max 50 bytes)
type: Field

key
field key kind: identifierFieldKey
key text: clicktale
type: FieldKey

clicktale
is optional: true
max count: 1
field type: string
field key: key
comment: Clicktale campaign name (max 50 bytes)
type: Field

key
field key kind: identifierFieldKey
key text: saved segment id
type: FieldKey

saved segment id
is optional: true
max count: 1
field type: Segment
field key: key
comment: Saved segment ID (integer variant)
type: Field

Campaign Segment Opts
has field: saved segment id
comment: Nested record for Campaign.recipients.segmentOpts.
type: RecordType
has field: prebuilt segment id
has field: match
has field: conditions

key
field key kind: identifierFieldKey
key text: prebuilt segment id
type: FieldKey

prebuilt segment id
is optional: true
max count: 1
field type: string
field key: key
comment: Prebuilt segment ID (string variant). Modeled as plain string because heterogeneous Ref<Segment> across int and string key types cannot be expressed through dual scalars cleanly; resolve at consumer.
type: Field

key
field key kind: identifierFieldKey
key text: match
type: FieldKey

match
is optional: true
max count: 1
field type: string
field key: key
comment: Whether all or any conditions must match
type: Field

conditions array
is anonymous: true
array value type: Segment Condition
type: ArrayExpression

key
field key kind: identifierFieldKey
key text: conditions
type: FieldKey

conditions
is optional: true
field type: conditions array
field key: key
comment: Segment conditions (polymorphic, discriminator condition_type). Promoted to shared SegmentCondition base model in common.tsp.
type: Field

key
field key kind: identifierFieldKey
key text: list id
type: FieldKey

list id
is optional: true
max count: 1
field type: List
field key: key
comment: Audience (list) ID this campaign sends to
type: Field

Campaign Recipients
has field: list id
comment: Nested record for Campaign.recipients.
type: RecordType
has field: list is active
has field: list name
has field: segment text
has field: recipient count
has field: segment opts

key
field key kind: identifierFieldKey
key text: list is active
type: FieldKey

list is active
is optional: true
max count: 1
field type: boolean
field key: key
comment: Whether the target audience is currently active
type: Field

key
field key kind: identifierFieldKey
key text: list name
type: FieldKey

list name
is optional: true
max count: 1
field type: string
field key: key
comment: Display name of the target audience
type: Field

key
field key kind: identifierFieldKey
key text: segment text
type: FieldKey

segment text
is optional: true
max count: 1
field type: string
field key: key
comment: HTML description of the targeted segment
type: Field

key
field key kind: identifierFieldKey
key text: recipient count
type: FieldKey

recipient count
is optional: true
max count: 1
field type: unknown
field key: key
comment: Number of recipients targeted by this campaign
type: Field

key
field key kind: identifierFieldKey
key text: segment opts
type: FieldKey

segment opts
is optional: true
max count: 1
field type: Campaign Segment Opts
field key: key
comment: Segment options applied to the audience
type: Field

key
field key kind: identifierFieldKey
key text: id
type: FieldKey

id
is optional: false
max count: 1
min count: 1
field type: string
field key: key
comment: Campaign ID. Opaque string assigned by Mailchimp.
type: Field

Campaign
has field: id
comment: A Mailchimp email campaign.
type: RecordType
has field: web id
has field: parent campaign id
has field: type
has field: create time
has field: archive url
has field: long archive url
has field: status
has field: emails sent
has field: send time
has field: content type
has field: needs block refresh
has field: resendable
has field: recipients
has field: settings
has field: variate settings
has field: tracking
has field: rss opts
has field: ab split opts
has field: social card
has field: report summary
has field: delivery status
has field: resend shortcut eligibility
has field: resend shortcut usage
has field: links

key
field key kind: identifierFieldKey
key text: web id
type: FieldKey

web id
is optional: true
max count: 1
field type: unknown
field key: key
comment: Display ID used in the Mailchimp web UI; not an entity reference
type: Field

key
field key kind: identifierFieldKey
key text: parent campaign id
type: FieldKey

parent campaign id
is optional: true
max count: 1
field type: Campaign
field key: key
comment: Parent campaign ID for RSS/automation child campaigns; self-reference
type: Field

key
field key kind: identifierFieldKey
key text: type
type: FieldKey

type
is optional: true
max count: 1
field type: string
field key: key
comment: Campaign type (regular, plaintext, absplit, rss, variate)
type: Field

key
field key kind: identifierFieldKey
key text: create time
type: FieldKey

create time
is optional: true
max count: 1
field type: offsetDateTime
field key: key
comment: Timestamp when the campaign was created
type: Field

key
field key kind: identifierFieldKey
key text: archive url
type: FieldKey

archive url
is optional: true
max count: 1
field type: url
field key: key
comment: Public archive URL for the campaign
type: Field

key
field key kind: identifierFieldKey
key text: long archive url
type: FieldKey

long archive url
is optional: true
max count: 1
field type: string
field key: key
comment: Long-form public archive URL for the campaign
type: Field

key
field key kind: identifierFieldKey
key text: status
type: FieldKey

status
is optional: true
max count: 1
field type: string
field key: key
comment: Campaign lifecycle status
type: Field

key
field key kind: identifierFieldKey
key text: emails sent
type: FieldKey

emails sent
is optional: true
max count: 1
field type: unknown
field key: key
comment: Total number of emails sent
type: Field

key
field key kind: identifierFieldKey
key text: send time
type: FieldKey

send time
is optional: true
max count: 1
field type: offsetDateTime
field key: key
comment: Timestamp when the campaign was sent
type: Field

key
field key kind: identifierFieldKey
key text: content type
type: FieldKey

content type
is optional: true
max count: 1
field type: string
field key: key
comment: Source of the campaign content
type: Field

key
field key kind: identifierFieldKey
key text: needs block refresh
type: FieldKey

needs block refresh
is optional: true
max count: 1
field type: boolean
field key: key
comment: Deprecated; always false in current responses
type: Field

key
field key kind: identifierFieldKey
key text: resendable
type: FieldKey

resendable
is optional: true
max count: 1
field type: boolean
field key: key
comment: Whether this campaign is eligible to be resent
type: Field

key
field key kind: identifierFieldKey
key text: recipients
type: FieldKey

recipients
is optional: true
max count: 1
field type: Campaign Recipients
field key: key
comment: Recipient targeting for the campaign
type: Field

key
field key kind: identifierFieldKey
key text: settings
type: FieldKey

settings
is optional: true
max count: 1
field type: Campaign Settings
field key: key
comment: Campaign settings (subject, from, content options)
type: Field

key
field key kind: identifierFieldKey
key text: variate settings
type: FieldKey

variate settings
is optional: true
max count: 1
field type: Variate Settings
field key: key
comment: Variate (multivariate) test configuration; present when type is variate
type: Field

key
field key kind: identifierFieldKey
key text: tracking
type: FieldKey

tracking
is optional: true
max count: 1
field type: Campaign Tracking
field key: key
comment: Open/click/ecommerce tracking flags; see common CampaignTracking
type: Field

key
field key kind: identifierFieldKey
key text: rss opts
type: FieldKey

rss opts
is optional: true
max count: 1
field type: Rss Opts
field key: key
comment: RSS feed options; present when type is rss
type: Field

key
field key kind: identifierFieldKey
key text: ab split opts
type: FieldKey

ab split opts
is optional: true
max count: 1
field type: ABSplit Opts
field key: key
comment: Deprecated legacy A/B split test options. Mailchimp no longer authors classic A/B from the API; use `Campaigns.VariateSettings` for multivariate tests.
type: Field

key
field key kind: identifierFieldKey
key text: social card
type: FieldKey

social card
is optional: true
max count: 1
field type: Social Card
field key: key
comment: Social-card preview image, title, and description
type: Field

key
field key kind: identifierFieldKey
key text: report summary
type: FieldKey

report summary
is optional: true
max count: 1
field type: Report Summary
field key: key
comment: Per-campaign report summary; see common ReportSummary
type: Field

key
field key kind: identifierFieldKey
key text: delivery status
type: FieldKey

delivery status
is optional: true
max count: 1
field type: Delivery Status
field key: key
comment: Delivery status; see common DeliveryStatus
type: Field

key
field key kind: identifierFieldKey
key text: resend shortcut eligibility
type: FieldKey

resend shortcut eligibility
is optional: true
max count: 1
field type: Resend Shortcut Eligibility
field key: key
comment: Eligibility flags for the four resend-shortcut variants
type: Field

key
field key kind: identifierFieldKey
key text: resend shortcut usage
type: FieldKey

resend shortcut usage
is optional: true
max count: 1
field type: Resend Shortcut Usage
field key: key
comment: Records of resend-shortcut campaigns spawned from this campaign
type: Field

links array
is anonymous: true
array value type: HALLink
type: ArrayExpression

key
field key kind: identifierFieldKey
key text: links
type: FieldKey

links
is optional: true
field type: links array
field key: key
comment: HATEOAS links for the campaign resource
type: Field

key
field key kind: identifierFieldKey
key text: merge id
type: FieldKey

merge id
is optional: false
max count: 1
min count: 1
field type: unknown
field key: key
comment: Integer merge-field identifier scoped to the parent list.
type: Field

Merge Field Post Response
has field: merge id
comment: Response variant returned only on `POST /lists/{list_id}/merge-fields`. Extends `MergeField` with the post-response-only counters that Mailchimp omits from the regular GET response.
type: RecordType
has field: tag
has field: name
has field: type
has field: required
has field: default value
has field: public
has field: display order
has field: options
has field: help text
has field: list id
has field: links
has field: total items
has field: merge field limit

key
field key kind: identifierFieldKey
key text: tag
type: FieldKey

tag
is optional: false
max count: 1
min count: 1
field type: string
field key: key
comment: Merge tag used in campaign content (e.g. `FNAME`, `LNAME`, `EMAIL`).
type: Field

key
field key kind: identifierFieldKey
key text: name
type: FieldKey

name
is optional: false
max count: 1
min count: 1
field type: string
field key: key
comment: Display name shown in the Mailchimp admin UI and on forms.
type: Field

key
field key kind: identifierFieldKey
key text: type
type: FieldKey

type
is optional: false
max count: 1
min count: 1
field type: string
field key: key
comment: Data type of the merge field.
type: Field

key
field key kind: identifierFieldKey
key text: required
type: FieldKey

required
is optional: true
max count: 1
field type: boolean
field key: key
comment: Whether the merge field is required on signup.
type: Field

key
field key kind: identifierFieldKey
key text: default value
type: FieldKey

default value
is optional: true
max count: 1
field type: string
field key: key
comment: Default value applied when the subscriber does not supply one.
type: Field

key
field key kind: identifierFieldKey
key text: public
type: FieldKey

public
is optional: true
max count: 1
field type: boolean
field key: key
comment: Whether the merge field is shown on the public signup form.
type: Field

key
field key kind: identifierFieldKey
key text: display order
type: FieldKey

display order
is optional: true
max count: 1
field type: unknown
field key: key
comment: Position of the merge field within the list's form.
type: Field

key
field key kind: identifierFieldKey
key text: options
type: FieldKey

options
is optional: true
max count: 1
field type: Merge Field Options
field key: key
comment: Type-specific configuration options. Populated keys depend on `type`.
type: Field

key
field key kind: identifierFieldKey
key text: help text
type: FieldKey

help text
is optional: true
max count: 1
field type: string
field key: key
comment: Helper text rendered under the merge field on signup forms.
type: Field

key
field key kind: identifierFieldKey
key text: list id
type: FieldKey

list id
is optional: false
max count: 1
min count: 1
field type: List
field key: key
comment: Parent list that owns the merge field.
type: Field

links array
is anonymous: true
array value type: HALLink
type: ArrayExpression

key
field key kind: identifierFieldKey
key text: links
type: FieldKey

links
is optional: true
field type: links array
field key: key
comment: HATEOAS link descriptors for related resources.
type: Field

key
field key kind: identifierFieldKey
key text: total items
type: FieldKey

total items
is optional: false
max count: 1
min count: 1
field type: unknown
field key: key
comment: Total merge fields defined for the parent list after this insert.
type: Field

key
field key kind: identifierFieldKey
key text: merge field limit
type: FieldKey

merge field limit
is optional: false
max count: 1
min count: 1
field type: unknown
field key: key
comment: Account-level cap on merge fields per list.
type: Field

key
field key kind: identifierFieldKey
key text: merge id
type: FieldKey

merge id
is optional: false
max count: 1
min count: 1
field type: unknown
field key: key
comment: Integer merge-field identifier scoped to the parent list.
type: Field

Merge Field
has field: merge id
comment: A merge-field definition on a Mailchimp list. Merge fields are the named subscriber attributes referenced in campaign content via merge tags (e.g. `*|FNAME|*`). Returned by `GET /lists/{list_id}/merge-fields/{merge_id}`.
type: RecordType
has field: tag
has field: name
has field: type
has field: required
has field: default value
has field: public
has field: display order
has field: options
has field: help text
has field: list id
has field: links

key
field key kind: identifierFieldKey
key text: tag
type: FieldKey

tag
is optional: false
max count: 1
min count: 1
field type: string
field key: key
comment: Merge tag used in campaign content (e.g. `FNAME`, `LNAME`, `EMAIL`).
type: Field

key
field key kind: identifierFieldKey
key text: name
type: FieldKey

name
is optional: false
max count: 1
min count: 1
field type: string
field key: key
comment: Display name shown in the Mailchimp admin UI and on forms.
type: Field

key
field key kind: identifierFieldKey
key text: type
type: FieldKey

type
is optional: false
max count: 1
min count: 1
field type: string
field key: key
comment: Data type of the merge field.
type: Field

key
field key kind: identifierFieldKey
key text: required
type: FieldKey

required
is optional: true
max count: 1
field type: boolean
field key: key
comment: Whether the merge field is required on signup.
type: Field

key
field key kind: identifierFieldKey
key text: default value
type: FieldKey

default value
is optional: true
max count: 1
field type: string
field key: key
comment: Default value applied when the subscriber does not supply one.
type: Field

key
field key kind: identifierFieldKey
key text: public
type: FieldKey

public
is optional: true
max count: 1
field type: boolean
field key: key
comment: Whether the merge field is shown on the public signup form.
type: Field

key
field key kind: identifierFieldKey
key text: display order
type: FieldKey

display order
is optional: true
max count: 1
field type: unknown
field key: key
comment: Position of the merge field within the list's form.
type: Field

key
field key kind: identifierFieldKey
key text: options
type: FieldKey

options
is optional: true
max count: 1
field type: Merge Field Options
field key: key
comment: Type-specific configuration options. Populated keys depend on `type`.
type: Field

key
field key kind: identifierFieldKey
key text: help text
type: FieldKey

help text
is optional: true
max count: 1
field type: string
field key: key
comment: Helper text rendered under the merge field on signup forms.
type: Field

key
field key kind: identifierFieldKey
key text: list id
type: FieldKey

list id
is optional: false
max count: 1
min count: 1
field type: List
field key: key
comment: Parent list that owns the merge field.
type: Field

links array
is anonymous: true
array value type: HALLink
type: ArrayExpression

key
field key kind: identifierFieldKey
key text: links
type: FieldKey

links
is optional: true
field type: links array
field key: key
comment: HATEOAS link descriptors for related resources.
type: Field

key
field key kind: identifierFieldKey
key text: default country
type: FieldKey

default country
is optional: true
max count: 1
field type: unknown
field key: key
comment: Numeric Mailchimp country code applied as the default for `address` merge fields.
type: Field

Merge Field Options
has field: default country
comment: Type-specific configuration options for a merge field. Which sub-field is populated depends on the parent `MergeField.type`: - `address` uses `defaultCountry`. - `phone` uses `phoneFormat`. - `date` and `birthday` use `dateFormat`. - `radio` and `dropdown` use `choices`. - `text` and `number` honor `size` for input width.
type: RecordType
has field: phone format
has field: date format
has field: choices
has field: size

key
field key kind: identifierFieldKey
key text: phone format
type: FieldKey

phone format
is optional: true
max count: 1
field type: string
field key: key
comment: Phone-number format applied to `phone` merge fields.
type: Field

key
field key kind: identifierFieldKey
key text: date format
type: FieldKey

date format
is optional: true
max count: 1
field type: string
field key: key
comment: Date format string for `date` and `birthday` merge fields (e.g. `MM/DD/YYYY`).
type: Field

choices array
is anonymous: true
array value type: string
type: ArrayExpression

key
field key kind: identifierFieldKey
key text: choices
type: FieldKey

choices
is optional: true
field type: choices array
field key: key
comment: Enumerated choices for `radio` and `dropdown` merge fields.
type: Field

key
field key kind: identifierFieldKey
key text: size
type: FieldKey

size
is optional: true
max count: 1
field type: unknown
field key: key
comment: Input width hint for `text` and `number` merge fields.
type: Field

key
field key kind: identifierFieldKey
key text: id
type: FieldKey

id
is optional: false
max count: 1
min count: 1
field type: unknown
field key: key
comment: Integer segment identifier scoped to the parent list.
type: Field

Segment
has field: id
comment: A Mailchimp list segment used to target a subset of a list's subscribers. Returned by `GET /lists/{list_id}/segments/{segment_id}`.
type: RecordType
has field: name
has field: member count
has field: type
has field: created at
has field: updated at
has field: options
has field: list id
has field: links

key
field key kind: identifierFieldKey
key text: name
type: FieldKey

name
is optional: false
max count: 1
min count: 1
field type: string
field key: key
comment: Display name of the segment.
type: Field

key
field key kind: identifierFieldKey
key text: member count
type: FieldKey

member count
is optional: false
max count: 1
min count: 1
field type: unknown
field key: key
comment: Cached count of subscribers matching the segment predicate.
type: Field

key
field key kind: identifierFieldKey
key text: type
type: FieldKey

type
is optional: false
max count: 1
min count: 1
field type: string
field key: key
comment: Segment kind.
type: Field

key
field key kind: identifierFieldKey
key text: created at
type: FieldKey

created at
is optional: false
max count: 1
min count: 1
field type: offsetDateTime
field key: key
comment: Timestamp when the segment was created.
type: Field

key
field key kind: identifierFieldKey
key text: updated at
type: FieldKey

updated at
is optional: false
max count: 1
min count: 1
field type: offsetDateTime
field key: key
comment: Timestamp of the most recent edit.
type: Field

key
field key kind: identifierFieldKey
key text: options
type: FieldKey

options
is optional: true
max count: 1
field type: Segment Options
field key: key
comment: Predicate definition. Absent on `static` and `fuzzy` segments.
type: Field

key
field key kind: identifierFieldKey
key text: list id
type: FieldKey

list id
is optional: false
max count: 1
min count: 1
field type: List
field key: key
comment: Parent list that owns the segment.
type: Field

links array
is anonymous: true
array value type: HALLink
type: ArrayExpression

key
field key kind: identifierFieldKey
key text: links
type: FieldKey

links
is optional: true
field type: links array
field key: key
comment: HATEOAS link descriptors for related resources.
type: Field

key
field key kind: identifierFieldKey
key text: match
type: FieldKey

match
is optional: false
max count: 1
min count: 1
field type: string
field key: key
comment: Whether condition rows are combined with logical OR (`any`) or AND (`all`).
type: Field

Segment Options
has field: match
comment: Predicate definition for a saved segment. `match` selects the conjunction; `conditions` is the polymorphic row list.
type: RecordType
has field: conditions

conditions array
is anonymous: true
array value type: Segment Condition
type: ArrayExpression

key
field key kind: identifierFieldKey
key text: conditions
type: FieldKey

conditions
is optional: true
field type: conditions array
field key: key
comment: Polymorphic condition rows; variant is keyed by `conditionType`.
type: Field

key
field key kind: identifierFieldKey
key text: id
type: FieldKey

id
is optional: false
max count: 1
min count: 1
field type: unknown
field key: key
comment: Integer tag identifier scoped to the parent list.
type: Field

Tag
has field: id
comment: A tag applied to subscribers on a Mailchimp list. The parent list is implied by the request path; the Tag entity itself carries no `listId`. Returned inside the `tags[]` array of `GET /lists/{list_id}/tag-search`.
type: RecordType
has field: name

key
field key kind: identifierFieldKey
key text: name
type: FieldKey

name
is optional: false
max count: 1
min count: 1
field type: string
field key: key
comment: Display name of the tag.
type: Field

key
field key kind: identifierFieldKey
key text: id
type: FieldKey

id
is optional: false
max count: 1
min count: 1
field type: Tag
field key: key
comment: Tag identifier within the parent list.
type: Field

Member Tag
has field: id
comment: Tag association embedded on `Member.tags`. Distinct from the canonical `Tag` entity: this embedded form uses `RefInt<Tag>` for the `id` field (denoting a cross-entity reference, not an owned key), and surfaces only the `id`/`name` pair Mailchimp embeds inside a member payload.
type: RecordType
has field: name

key
field key kind: identifierFieldKey
key text: name
type: FieldKey

name
is optional: false
max count: 1
min count: 1
field type: string
field key: key
comment: Tag display name.
type: Field

key
field key kind: identifierFieldKey
key text: id
type: FieldKey

id
is optional: false
max count: 1
min count: 1
field type: string
field key: key
comment: MD5 hash of the lowercased email address. Distinct from `uniqueEmailId`.
type: Field

Member
has field: id
comment: A subscriber on a Mailchimp list. Returned by `GET /lists/{list_id}/members/{subscriber_hash}`. The subscriber-hash path parameter is the MD5 of the lowercased email address, which is also the value of `id`.
type: RecordType
has field: email address
has field: unique email id
has field: contact id
has field: full name
has field: web id
has field: email type
has field: status
has field: unsubscribe reason
has field: consents to one to one messaging
has field: sms phone number
has field: sms subscription status
has field: sms subscription last updated
has field: merge fields
has field: interests
has field: stats
has field: ip signup
has field: ip opt
has field: timestamp signup
has field: timestamp opt
has field: member rating
has field: last changed
has field: language
has field: vip
has field: email client
has field: location
has field: marketing permissions
has field: last note
has field: source
has field: tags count
has field: tags
has field: list id
has field: links

key
field key kind: identifierFieldKey
key text: email address
type: FieldKey

email address
is optional: true
max count: 1
field type: string
field key: key
comment: Subscriber's email address.
type: Field

key
field key kind: identifierFieldKey
key text: unique email id
type: FieldKey

unique email id
is optional: true
max count: 1
field type: string
field key: key
comment: Cross-Mailchimp email-address identifier (different from `id`).
type: Field

key
field key kind: identifierFieldKey
key text: contact id
type: FieldKey

contact id
is optional: true
max count: 1
field type: string
field key: key
comment: Email-agnostic contact identifier persistent across address changes.
type: Field

key
field key kind: identifierFieldKey
key text: full name
type: FieldKey

full name
is optional: true
max count: 1
field type: string
field key: key
comment: Subscriber's full name as resolved from merge fields.
type: Field

key
field key kind: identifierFieldKey
key text: web id
type: FieldKey

web id
is optional: true
max count: 1
field type: unknown
field key: key
comment: Secondary numeric identifier surfaced in the Mailchimp admin UI URL.
type: Field

key
field key kind: identifierFieldKey
key text: email type
type: FieldKey

email type
is optional: true
max count: 1
field type: string
field key: key
comment: Delivery format preference (`html` or `text`).
type: Field

key
field key kind: identifierFieldKey
key text: status
type: FieldKey

status
is optional: true
max count: 1
field type: string
field key: key
comment: Subscription state of the contact on the list.
type: Field

key
field key kind: identifierFieldKey
key text: unsubscribe reason
type: FieldKey

unsubscribe reason
is optional: true
max count: 1
field type: string
field key: key
comment: Free-text reason captured when the subscriber unsubscribed.
type: Field

key
field key kind: identifierFieldKey
key text: consents to one to one messaging
type: FieldKey

consents to one to one messaging
is optional: true
max count: 1
field type: boolean
field key: key
comment: Whether the subscriber consents to one-to-one outreach.
type: Field

key
field key kind: identifierFieldKey
key text: sms phone number
type: FieldKey

sms phone number
is optional: true
max count: 1
field type: string
field key: key
comment: SMS phone number on file. US numbers only.
type: Field

key
field key kind: identifierFieldKey
key text: sms subscription status
type: FieldKey

sms subscription status
is optional: true
max count: 1
field type: string
field key: key
comment: SMS subscription state.
type: Field

key
field key kind: identifierFieldKey
key text: sms subscription last updated
type: FieldKey

sms subscription last updated
is optional: true
max count: 1
field type: string
field key: key
comment: Last update to SMS subscription state. Wire format is unspecified; emitted as a string.
type: Field

key
field key kind: identifierFieldKey
key text: merge fields
type: FieldKey

merge fields
is optional: true
max count: 1
field type: Merge Fields Record
field key: key
comment: Open dictionary of merge-field values keyed by merge tag.
type: Field

key
field key kind: identifierFieldKey
key text: interests
type: FieldKey

interests
is optional: true
max count: 1
field type: Interests Record
field key: key
comment: Map of interest opt-ins. Keys are `Ref<Interest>` identifiers; values indicate whether the subscriber is opted in.
type: Field

key
field key kind: identifierFieldKey
key text: stats
type: FieldKey

stats
is optional: true
max count: 1
field type: Member Stats
field key: key
comment: Engagement and e-commerce summary for the subscriber.
type: Field

key
field key kind: identifierFieldKey
key text: ip signup
type: FieldKey

ip signup
is optional: true
max count: 1
field type: string
field key: key
comment: IP address recorded at signup.
type: Field

key
field key kind: identifierFieldKey
key text: ip opt
type: FieldKey

ip opt
is optional: true
max count: 1
field type: string
field key: key
comment: IP address recorded at confirmed opt-in.
type: Field

key
field key kind: identifierFieldKey
key text: timestamp signup
type: FieldKey

timestamp signup
is optional: true
max count: 1
field type: offsetDateTime
field key: key
comment: Timestamp recorded at signup.
type: Field

key
field key kind: identifierFieldKey
key text: timestamp opt
type: FieldKey

timestamp opt
is optional: true
max count: 1
field type: offsetDateTime
field key: key
comment: Timestamp recorded at confirmed opt-in.
type: Field

key
field key kind: identifierFieldKey
key text: member rating
type: FieldKey

member rating
is optional: true
max count: 1
field type: unknown
field key: key
comment: Mailchimp-assigned engagement rating from 1 (lowest) to 5 (highest).
type: Field

key
field key kind: identifierFieldKey
key text: last changed
type: FieldKey

last changed
is optional: true
max count: 1
field type: offsetDateTime
field key: key
comment: Timestamp of the most recent change to the subscriber record.
type: Field

key
field key kind: identifierFieldKey
key text: language
type: FieldKey

language
is optional: true
max count: 1
field type: string
field key: key
comment: Subscriber language code (e.g. `en`, `es`).
type: Field

key
field key kind: identifierFieldKey
key text: vip
type: FieldKey

vip
is optional: true
max count: 1
field type: boolean
field key: key
comment: Whether the subscriber is flagged as a VIP for the account.
type: Field

key
field key kind: identifierFieldKey
key text: email client
type: FieldKey

email client
is optional: true
max count: 1
field type: string
field key: key
comment: Inferred email client (`Apple Mail`, `Gmail`, etc.).
type: Field

key
field key kind: identifierFieldKey
key text: location
type: FieldKey

location
is optional: true
max count: 1
field type: Member Location
field key: key
comment: Approximate geographic location resolved from the subscriber's IP.
type: Field

marketing permissions array
is anonymous: true
array value type: Member Marketing Permission
type: ArrayExpression

key
field key kind: identifierFieldKey
key text: marketing permissions
type: FieldKey

marketing permissions
is optional: true
field type: marketing permissions array
field key: key
comment: GDPR marketing-permission flags. One entry per permission defined on the parent list.
type: Field

key
field key kind: identifierFieldKey
key text: last note
type: FieldKey

last note
is optional: true
max count: 1
field type: Member Last Note
field key: key
comment: Most recent note attached to the subscriber.
type: Field

key
field key kind: identifierFieldKey
key text: source
type: FieldKey

source
is optional: true
max count: 1
field type: string
field key: key
comment: Acquisition source (e.g. signup form, API, import).
type: Field

key
field key kind: identifierFieldKey
key text: tags count
type: FieldKey

tags count
is optional: true
max count: 1
field type: unknown
field key: key
comment: Number of tags currently applied to the subscriber.
type: Field

tags array
is anonymous: true
array value type: Member Tag
type: ArrayExpression

key
field key kind: identifierFieldKey
key text: tags
type: FieldKey

tags
is optional: true
field type: tags array
field key: key
comment: Tag associations for the subscriber. Each `id` references a `Tag` on the parent list.
type: Field

key
field key kind: identifierFieldKey
key text: list id
type: FieldKey

list id
is optional: true
max count: 1
field type: List
field key: key
comment: Parent list that owns the subscriber.
type: Field

links array
is anonymous: true
array value type: HALLink
type: ArrayExpression

key
field key kind: identifierFieldKey
key text: links
type: FieldKey

links
is optional: true
field type: links array
field key: key
comment: HATEOAS link descriptors for related resources.
type: Field

key
field key kind: identifierFieldKey
key text: id
type: FieldKey

id
is optional: false
max count: 1
min count: 1
field type: string
field key: key
comment: Opaque member-note ID.
type: Field

Member Note
has field: id
comment: Stub — only used to resolve Ref<MemberNote>; full schema deferred to v2.
type: RecordType
has field: member id
has field: note
has field: created at

key
field key kind: identifierFieldKey
key text: member id
type: FieldKey

member id
is optional: false
max count: 1
min count: 1
field type: Member
field key: key
comment: Parent member this note is attached to.
type: Field

key
field key kind: identifierFieldKey
key text: note
type: FieldKey

note
is optional: false
max count: 1
min count: 1
field type: string
field key: key
comment: Free-text note body.
type: Field

key
field key kind: identifierFieldKey
key text: created at
type: FieldKey

created at
is optional: false
max count: 1
min count: 1
field type: offsetDateTime
field key: key
comment: Timestamp when the note was created.
type: Field

key
field key kind: identifierFieldKey
key text: note id
type: FieldKey

note id
is optional: false
max count: 1
min count: 1
field type: Member Note
field key: key
comment: Opaque identifier of the source `MemberNote`.
type: Field

Member Last Note
has field: note id
comment: Most recent note attached to the member by an account user. References `MemberNote` via the opaque note identifier.
type: RecordType
has field: created at
has field: created by
has field: note

key
field key kind: identifierFieldKey
key text: created at
type: FieldKey

created at
is optional: false
max count: 1
min count: 1
field type: offsetDateTime
field key: key
comment: Timestamp when the note was authored.
type: Field

key
field key kind: identifierFieldKey
key text: created by
type: FieldKey

created by
is optional: false
max count: 1
min count: 1
field type: string
field key: key
comment: Display name of the account user who authored the note.
type: Field

key
field key kind: identifierFieldKey
key text: note
type: FieldKey

note
is optional: false
max count: 1
min count: 1
field type: string
field key: key
comment: Free-text note body.
type: Field

key
field key kind: identifierFieldKey
key text: marketing permission id
type: FieldKey

marketing permission id
is optional: false
max count: 1
min count: 1
field type: string
field key: key
comment: Opaque permission identifier scoped to the parent list.
type: Field

Member Marketing Permission
has field: marketing permission id
comment: GDPR marketing-permission flag attached to a subscriber. The `marketingPermissionId` is opaque and scoped to the parent list.
type: RecordType
has field: text
has field: enabled

key
field key kind: identifierFieldKey
key text: text
type: FieldKey

text
is optional: false
max count: 1
min count: 1
field type: string
field key: key
comment: Human-readable description of what the subscriber consented to.
type: Field

key
field key kind: identifierFieldKey
key text: enabled
type: FieldKey

enabled
is optional: false
max count: 1
min count: 1
field type: boolean
field key: key
comment: Whether the subscriber currently grants the permission.
type: Field

key
field key kind: identifierFieldKey
key text: latitude
type: FieldKey

latitude
is optional: true
max count: 1
field type: float
field key: key
comment: Approximate latitude.
type: Field

Member Location
has field: latitude
comment: Approximate geographic location resolved from the subscriber's most recent IP. Coordinates are zeroed when location cannot be determined.
type: RecordType
has field: longitude
has field: gmtoff
has field: dstoff
has field: country code
has field: timezone
has field: region

key
field key kind: identifierFieldKey
key text: longitude
type: FieldKey

longitude
is optional: true
max count: 1
field type: float
field key: key
comment: Approximate longitude.
type: Field

key
field key kind: identifierFieldKey
key text: gmtoff
type: FieldKey

gmtoff
is optional: true
max count: 1
field type: unknown
field key: key
comment: GMT offset in hours at resolution time.
type: Field

key
field key kind: identifierFieldKey
key text: dstoff
type: FieldKey

dstoff
is optional: true
max count: 1
field type: unknown
field key: key
comment: Daylight-savings offset in hours at resolution time.
type: Field

key
field key kind: identifierFieldKey
key text: country code
type: FieldKey

country code
is optional: true
max count: 1
field type: string
field key: key
comment: ISO 3166-1 alpha-2 country code.
type: Field

key
field key kind: identifierFieldKey
key text: timezone
type: FieldKey

timezone
is optional: true
max count: 1
field type: string
field key: key
comment: IANA timezone identifier.
type: Field

key
field key kind: identifierFieldKey
key text: region
type: FieldKey

region
is optional: true
max count: 1
field type: string
field key: key
comment: ISO 3166-2 subdivision code.
type: Field

key
field key kind: identifierFieldKey
key text: avg open rate
type: FieldKey

avg open rate
is optional: false
max count: 1
min count: 1
field type: float
field key: key
comment: Open rate averaged across campaigns sent to this member.
type: Field

Member Stats
has field: avg open rate
comment: Engagement and e-commerce summary for a single subscriber.
type: RecordType
has field: avg click rate
has field: ecommerce data

key
field key kind: identifierFieldKey
key text: avg click rate
type: FieldKey

avg click rate
is optional: false
max count: 1
min count: 1
field type: float
field key: key
comment: Click rate averaged across campaigns sent to this member.
type: Field

key
field key kind: identifierFieldKey
key text: ecommerce data
type: FieldKey

ecommerce data
is optional: true
max count: 1
field type: Member Stats Ecommerce Data
field key: key
comment: Attributed e-commerce aggregates from Ecomm360.
type: Field

key
field key kind: identifierFieldKey
key text: total revenue
type: FieldKey

total revenue
is optional: false
max count: 1
min count: 1
field type: float
field key: key
comment: Lifetime attributed revenue.
type: Field

Member Stats Ecommerce Data
has field: total revenue
comment: Attributed e-commerce activity for the subscriber. Populated from Mailchimp's Ecomm360 store integrations.
type: RecordType
has field: number of orders
has field: currency code

key
field key kind: identifierFieldKey
key text: number of orders
type: FieldKey

number of orders
is optional: false
max count: 1
min count: 1
field type: float
field key: key
comment: Lifetime attributed order count.
type: Field

key
field key kind: identifierFieldKey
key text: currency code
type: FieldKey

currency code
is optional: false
max count: 1
min count: 1
field type: string
field key: key
comment: ISO 4217 currency code of the attributed totals.
type: Field

key
field key kind: identifierFieldKey
key text: id
type: FieldKey

id
is optional: false
max count: 1
min count: 1
field type: string
field key: key
comment: Opaque list identifier.
type: Field

List
has field: id
comment: A Mailchimp audience (a.k.a. list) that contacts can subscribe to. Returned by `GET /lists/{list_id}`.
type: RecordType
has field: web id
has field: name
has field: contact
has field: permission reminder
has field: use archive bar
has field: campaign defaults
has field: notify on subscribe
has field: notify on unsubscribe
has field: date created
has field: list rating
has field: email type option
has field: subscribe url short
has field: subscribe url long
has field: beamer address
has field: visibility
has field: double optin
has field: has welcome
has field: marketing permissions
has field: modules
has field: stats
has field: links

key
field key kind: identifierFieldKey
key text: web id
type: FieldKey

web id
is optional: false
max count: 1
min count: 1
field type: unknown
field key: key
comment: Secondary numeric identifier surfaced in the Mailchimp admin UI URL.
type: Field

key
field key kind: identifierFieldKey
key text: name
type: FieldKey

name
is optional: false
max count: 1
min count: 1
field type: string
field key: key
comment: Display name of the list.
type: Field

key
field key kind: identifierFieldKey
key text: contact
type: FieldKey

contact
is optional: false
max count: 1
min count: 1
field type: List Contact
field key: key
comment: Physical mailing address printed in the campaign footer.
type: Field

key
field key kind: identifierFieldKey
key text: permission reminder
type: FieldKey

permission reminder
is optional: false
max count: 1
min count: 1
field type: string
field key: key
comment: Reminder text explaining why a recipient is on this list.
type: Field

key
field key kind: identifierFieldKey
key text: use archive bar
type: FieldKey

use archive bar
is optional: true
max count: 1
field type: boolean
field key: key
comment: Whether to render the Mailchimp archive bar in sent campaigns.
type: Field

key
field key kind: identifierFieldKey
key text: campaign defaults
type: FieldKey

campaign defaults
is optional: false
max count: 1
min count: 1
field type: List Campaign Defaults
field key: key
comment: Default field values applied to new campaigns drafted against this list.
type: Field

key
field key kind: identifierFieldKey
key text: notify on subscribe
type: FieldKey

notify on subscribe
is optional: true
max count: 1
field type: string
field key: key
comment: Email address notified when a contact subscribes.
type: Field

key
field key kind: identifierFieldKey
key text: notify on unsubscribe
type: FieldKey

notify on unsubscribe
is optional: true
max count: 1
field type: string
field key: key
comment: Email address notified when a contact unsubscribes.
type: Field

key
field key kind: identifierFieldKey
key text: date created
type: FieldKey

date created
is optional: false
max count: 1
min count: 1
field type: offsetDateTime
field key: key
comment: Timestamp when the list was created.
type: Field

key
field key kind: identifierFieldKey
key text: list rating
type: FieldKey

list rating
is optional: false
max count: 1
min count: 1
field type: unknown
field key: key
comment: Mailchimp-assigned engagement rating from 0 (lowest) to 5 (highest).
type: Field

key
field key kind: identifierFieldKey
key text: email type option
type: FieldKey

email type option
is optional: false
max count: 1
min count: 1
field type: boolean
field key: key
comment: Whether subscribers can choose between HTML and plain-text email.
type: Field

key
field key kind: identifierFieldKey
key text: subscribe url short
type: FieldKey

subscribe url short
is optional: false
max count: 1
min count: 1
field type: string
field key: key
comment: Branded short URL hosting the subscribe form.
type: Field

key
field key kind: identifierFieldKey
key text: subscribe url long
type: FieldKey

subscribe url long
is optional: false
max count: 1
min count: 1
field type: string
field key: key
comment: Canonical long URL hosting the subscribe form.
type: Field

key
field key kind: identifierFieldKey
key text: beamer address
type: FieldKey

beamer address
is optional: false
max count: 1
min count: 1
field type: string
field key: key
comment: Email Beamer inbound address for converting emails into campaigns.
type: Field

key
field key kind: identifierFieldKey
key text: visibility
type: FieldKey

visibility
is optional: false
max count: 1
min count: 1
field type: string
field key: key
comment: Legacy public/private visibility flag. Newer accounts always see `prv`.
type: Field

key
field key kind: identifierFieldKey
key text: double optin
type: FieldKey

double optin
is optional: true
max count: 1
field type: boolean
field key: key
comment: Whether subscribers must confirm via a follow-up email before being added.
type: Field

key
field key kind: identifierFieldKey
key text: has welcome
type: FieldKey

has welcome
is optional: true
max count: 1
field type: boolean
field key: key
comment: Whether a welcome email is sent on subscribe.
type: Field

key
field key kind: identifierFieldKey
key text: marketing permissions
type: FieldKey

marketing permissions
is optional: true
max count: 1
field type: boolean
field key: key
comment: Whether the list collects GDPR marketing permission flags.
type: Field

modules array
is anonymous: true
array value type: string
type: ArrayExpression

key
field key kind: identifierFieldKey
key text: modules
type: FieldKey

modules
is optional: true
field type: modules array
field key: key
comment: Mailchimp module identifiers enabled for the list (read-only).
type: Field

key
field key kind: identifierFieldKey
key text: stats
type: FieldKey

stats
is optional: false
max count: 1
min count: 1
field type: List Stats
field key: key
comment: Aggregate counters and rate metrics for the list.
type: Field

links array
is anonymous: true
array value type: HALLink
type: ArrayExpression

key
field key kind: identifierFieldKey
key text: links
type: FieldKey

links
is optional: true
field type: links array
field key: key
comment: HATEOAS link descriptors for related resources.
type: Field

key
field key kind: identifierFieldKey
key text: member count
type: FieldKey

member count
is optional: false
max count: 1
min count: 1
field type: unknown
field key: key
comment: Active subscriber count.
type: Field

List Stats
has field: member count
comment: Aggregate counters and rate metrics for a list. All fields are server-populated.
type: RecordType
has field: total contacts
has field: unsubscribe count
has field: cleaned count
has field: member count since send
has field: unsubscribe count since send
has field: cleaned count since send
has field: campaign count
has field: campaign last sent
has field: merge field count
has field: avg sub rate
has field: avg unsub rate
has field: target sub rate
has field: open rate
has field: click rate
has field: last sub date
has field: last unsub date

key
field key kind: identifierFieldKey
key text: total contacts
type: FieldKey

total contacts
is optional: false
max count: 1
min count: 1
field type: unknown
field key: key
comment: Total contacts in any state (subscribed + unsubscribed + cleaned).
type: Field

key
field key kind: identifierFieldKey
key text: unsubscribe count
type: FieldKey

unsubscribe count
is optional: false
max count: 1
min count: 1
field type: unknown
field key: key
comment: Unsubscribed contact count.
type: Field

key
field key kind: identifierFieldKey
key text: cleaned count
type: FieldKey

cleaned count
is optional: false
max count: 1
min count: 1
field type: unknown
field key: key
comment: Cleaned (bounced/invalid) contact count.
type: Field

key
field key kind: identifierFieldKey
key text: member count since send
type: FieldKey

member count since send
is optional: false
max count: 1
min count: 1
field type: unknown
field key: key
comment: Net subscribers added since the last send.
type: Field

key
field key kind: identifierFieldKey
key text: unsubscribe count since send
type: FieldKey

unsubscribe count since send
is optional: false
max count: 1
min count: 1
field type: unknown
field key: key
comment: Unsubscribes since the last send.
type: Field

key
field key kind: identifierFieldKey
key text: cleaned count since send
type: FieldKey

cleaned count since send
is optional: false
max count: 1
min count: 1
field type: unknown
field key: key
comment: Contacts cleaned since the last send.
type: Field

key
field key kind: identifierFieldKey
key text: campaign count
type: FieldKey

campaign count
is optional: false
max count: 1
min count: 1
field type: unknown
field key: key
comment: Lifetime campaign count for this list.
type: Field

key
field key kind: identifierFieldKey
key text: campaign last sent
type: FieldKey

campaign last sent
is optional: true
max count: 1
field type: offsetDateTime
field key: key
comment: Total campaigns ever sent to this list.
type: Field

key
field key kind: identifierFieldKey
key text: merge field count
type: FieldKey

merge field count
is optional: false
max count: 1
min count: 1
field type: unknown
field key: key
comment: Number of merge fields defined for the list.
type: Field

key
field key kind: identifierFieldKey
key text: avg sub rate
type: FieldKey

avg sub rate
is optional: false
max count: 1
min count: 1
field type: float
field key: key
comment: Average subscribe rate per month.
type: Field

key
field key kind: identifierFieldKey
key text: avg unsub rate
type: FieldKey

avg unsub rate
is optional: false
max count: 1
min count: 1
field type: float
field key: key
comment: Average unsubscribe rate per month.
type: Field

key
field key kind: identifierFieldKey
key text: target sub rate
type: FieldKey

target sub rate
is optional: false
max count: 1
min count: 1
field type: float
field key: key
comment: Target monthly subscribe rate set by the operator.
type: Field

key
field key kind: identifierFieldKey
key text: open rate
type: FieldKey

open rate
is optional: false
max count: 1
min count: 1
field type: float
field key: key
comment: Open rate averaged across recent campaigns.
type: Field

key
field key kind: identifierFieldKey
key text: click rate
type: FieldKey

click rate
is optional: false
max count: 1
min count: 1
field type: float
field key: key
comment: Click rate averaged across recent campaigns.
type: Field

key
field key kind: identifierFieldKey
key text: last sub date
type: FieldKey

last sub date
is optional: true
max count: 1
field type: offsetDateTime
field key: key
comment: Timestamp of the most recent subscribe event.
type: Field

key
field key kind: identifierFieldKey
key text: last unsub date
type: FieldKey

last unsub date
is optional: true
max count: 1
field type: offsetDateTime
field key: key
comment: Timestamp of the most recent unsubscribe event.
type: Field

key
field key kind: identifierFieldKey
key text: from name
type: FieldKey

from name
is optional: false
max count: 1
min count: 1
field type: string
field key: key
comment: Default "from" display name.
type: Field

List Campaign Defaults
has field: from name
comment: Default fields applied to new campaigns drafted against this list.
type: RecordType
has field: from email
has field: subject
has field: language

key
field key kind: identifierFieldKey
key text: from email
type: FieldKey

from email
is optional: false
max count: 1
min count: 1
field type: string
field key: key
comment: Default "from" email address.
type: Field

key
field key kind: identifierFieldKey
key text: subject
type: FieldKey

subject
is optional: false
max count: 1
min count: 1
field type: string
field key: key
comment: Default subject line.
type: Field

key
field key kind: identifierFieldKey
key text: language
type: FieldKey

language
is optional: false
max count: 1
min count: 1
field type: string
field key: key
comment: Default language code (e.g. `en`, `es`).
type: Field

key
field key kind: identifierFieldKey
key text: company
type: FieldKey

company
is optional: false
max count: 1
min count: 1
field type: string
field key: key
comment: Company or organization name printed in the footer.
type: Field

List Contact
has field: company
comment: Mailing address Mailchimp prints in the campaign footer to satisfy CAN-SPAM. Every list must carry a complete physical address.
type: RecordType
has field: address1
has field: address2
has field: city
has field: state
has field: zip
has field: country
has field: phone

key
field key kind: identifierFieldKey
key text: address1
type: FieldKey

address1
is optional: false
max count: 1
min count: 1
field type: string
field key: key
comment: Street address line 1.
type: Field

key
field key kind: identifierFieldKey
key text: address2
type: FieldKey

address2
is optional: true
max count: 1
field type: string
field key: key
comment: Street address line 2 (suite, unit, etc.).
type: Field

key
field key kind: identifierFieldKey
key text: city
type: FieldKey

city
is optional: false
max count: 1
min count: 1
field type: string
field key: key
comment: City.
type: Field

key
field key kind: identifierFieldKey
key text: state
type: FieldKey

state
is optional: false
max count: 1
min count: 1
field type: string
field key: key
comment: State or province.
type: Field

key
field key kind: identifierFieldKey
key text: zip
type: FieldKey

zip
is optional: false
max count: 1
min count: 1
field type: string
field key: key
comment: Postal code.
type: Field

key
field key kind: identifierFieldKey
key text: country
type: FieldKey

country
is optional: false
max count: 1
min count: 1
field type: string
field key: key
comment: ISO 3166-1 alpha-2 country code.
type: Field

key
field key kind: identifierFieldKey
key text: phone
type: FieldKey

phone
is optional: true
max count: 1
field type: string
field key: key
comment: Contact phone number.
type: Field

key
field key kind: identifierFieldKey
key text: condition type
type: FieldKey

condition type
is optional: false
max count: 1
min count: 1
field type: string
field key: key
comment: Discriminator selecting the condition variant.
type: Field

Segment Condition
has field: condition type
comment: Single condition row inside a saved segment definition. Mailchimp's full spec discriminates ~40 variants on `condition_type` (Aim, Automation, CampaignPoll, Conversation, Date, EmailClient, Language, Mandrill, MemberRating, SignupSource, SurveyMonkey, VIP, Interests, EcommCategory, EcommNumber, EcommPurchased, EcommSpent, EcommStore, GoalActivity, GoalTimestamp, LikeNumber, LikeMember, Location, GeolocationZip, GeolocationUsZip, Predicted, SocialAge, SocialGender, SocialNetworkMember, SocialNetworkFollow, SocialInfluence, AddressMerge, ZipMerge, BirthdayMerge, DateMerge, TextMerge, SelectMerge, IPGeoInZip, IPGeoCountryState, IPGeoUS, IPGeoUnknown, IPGeoZip3, Static, Tag), each with a variant-specific shape for `value`. This stub models the common surface shared by every variant so list, segment, campaign-recipient, and automation-recipient endpoints compile. Full discriminated-union expansion is deferred until the Mailchimp segment-condition feature is in scope; the deferral keeps downstream codegen unblocked. See: https://mailchimp.com/developer/marketing/docs/alternative-schemas/#segment-condition-schemas
type: RecordType
has field: field
has field: op
has field: value

key
field key kind: identifierFieldKey
key text: field
type: FieldKey

field
is optional: true
max count: 1
field type: string
field key: key
comment: Member or merge-field path the condition targets. Variant-defined.
type: Field

key
field key kind: identifierFieldKey
key text: op
type: FieldKey

op
is optional: true
max count: 1
field type: string
field key: key
comment: Comparison operator (e.g. `is`, `not`, `greater`). Variant-defined.
type: Field

key
field key kind: identifierFieldKey
key text: value
type: FieldKey

value
is optional: true
max count: 1
field type: JSON
field key: key
comment: Variant-specific comparison value. Concrete type depends on `conditionType` (string, number, boolean, array, or nested object).
type: Field

key
field key kind: identifierFieldKey
key text: opens
type: FieldKey

opens
is optional: false
max count: 1
min count: 1
field type: boolean
field key: key
comment: Track open pixel events.
type: Field

Campaign Tracking
has field: opens
comment: Tracking-feature toggles shared by Campaign and Automation. Controls which engagement signals Mailchimp records for the send.
type: RecordType
has field: html clicks
has field: text clicks
has field: goal tracking
has field: ecomm360
has field: google analytics
has field: clicktale
has field: salesforce
has field: capsule

key
field key kind: identifierFieldKey
key text: html clicks
type: FieldKey

html clicks
is optional: false
max count: 1
min count: 1
field type: boolean
field key: key
comment: Track clicks in the HTML body.
type: Field

key
field key kind: identifierFieldKey
key text: text clicks
type: FieldKey

text clicks
is optional: false
max count: 1
min count: 1
field type: boolean
field key: key
comment: Track clicks in the plain-text body.
type: Field

key
field key kind: identifierFieldKey
key text: goal tracking
type: FieldKey

goal tracking
is optional: false
max count: 1
min count: 1
field type: boolean
field key: key
comment: Track conversions on the operator's website via Mailchimp goals.
type: Field

key
field key kind: identifierFieldKey
key text: ecomm360
type: FieldKey

ecomm360
is optional: false
max count: 1
min count: 1
field type: boolean
field key: key
comment: Track e-commerce events via Mailchimp Ecomm360.
type: Field

key
field key kind: identifierFieldKey
key text: google analytics
type: FieldKey

google analytics
is optional: true
max count: 1
field type: string
field key: key
comment: Google Analytics campaign tag (max 50 bytes).
type: Field

key
field key kind: identifierFieldKey
key text: clicktale
type: FieldKey

clicktale
is optional: true
max count: 1
field type: string
field key: key
comment: ClickTale campaign tag (max 50 bytes).
type: Field

key
field key kind: identifierFieldKey
key text: salesforce
type: FieldKey

salesforce
is optional: true
max count: 1
field type: Campaign Tracking Salesforce
field key: key
comment: Salesforce CRM push toggles.
type: Field

key
field key kind: identifierFieldKey
key text: capsule
type: FieldKey

capsule
is optional: true
max count: 1
field type: Campaign Tracking Capsule
field key: key
comment: Capsule CRM push toggles.
type: Field

key
field key kind: identifierFieldKey
key text: notes
type: FieldKey

notes
is optional: false
max count: 1
min count: 1
field type: boolean
field key: key
comment: Push send activity into Capsule notes.
type: Field

Campaign Tracking Capsule
has field: notes
comment: Capsule CRM integration toggles nested under `CampaignTracking`. Deprecated by Mailchimp but still surface on responses.
type: RecordType

key
field key kind: identifierFieldKey
key text: campaign
type: FieldKey

campaign
is optional: false
max count: 1
min count: 1
field type: boolean
field key: key
comment: Push a Salesforce campaign record on send.
type: Field

Campaign Tracking Salesforce
has field: campaign
comment: Salesforce CRM integration toggles nested under `CampaignTracking`. Both fields are deprecated by Mailchimp but still surface on responses.
type: RecordType
has field: notes

key
field key kind: identifierFieldKey
key text: notes
type: FieldKey

notes
is optional: false
max count: 1
min count: 1
field type: boolean
field key: key
comment: Push send activity into Salesforce notes.
type: Field

key
field key kind: identifierFieldKey
key text: opens
type: FieldKey

opens
is optional: false
max count: 1
min count: 1
field type: unknown
field key: key
comment: Total opens across all recipients.
type: Field

Report Summary
has field: opens
comment: High-level performance summary shared by Campaign and Automation resources. Campaign omits no fields; Automation omits `ecommerce`.
type: RecordType
has field: unique opens
has field: clicks
has field: subscriber clicks
has field: open rate
has field: click rate
has field: ecommerce

key
field key kind: identifierFieldKey
key text: unique opens
type: FieldKey

unique opens
is optional: false
max count: 1
min count: 1
field type: unknown
field key: key
comment: Distinct opening recipients.
type: Field

key
field key kind: identifierFieldKey
key text: clicks
type: FieldKey

clicks
is optional: false
max count: 1
min count: 1
field type: unknown
field key: key
comment: Total link clicks.
type: Field

key
field key kind: identifierFieldKey
key text: subscriber clicks
type: FieldKey

subscriber clicks
is optional: false
max count: 1
min count: 1
field type: unknown
field key: key
comment: Distinct clicking recipients.
type: Field

key
field key kind: identifierFieldKey
key text: open rate
type: FieldKey

open rate
is optional: false
max count: 1
min count: 1
field type: float
field key: key
comment: Opens divided by deliveries.
type: Field

key
field key kind: identifierFieldKey
key text: click rate
type: FieldKey

click rate
is optional: false
max count: 1
min count: 1
field type: float
field key: key
comment: Clicks divided by deliveries.
type: Field

key
field key kind: identifierFieldKey
key text: ecommerce
type: FieldKey

ecommerce
is optional: true
max count: 1
field type: Report Summary Ecommerce
field key: key
comment: Attributed e-commerce aggregates. Absent on Automation summaries.
type: Field

key
field key kind: identifierFieldKey
key text: total orders
type: FieldKey

total orders
is optional: false
max count: 1
min count: 1
field type: unknown
field key: key
comment: Number of attributed orders.
type: Field

Report Summary Ecommerce
has field: total orders
comment: Aggregate e-commerce numbers nested under `ReportSummary.ecommerce`. Mailchimp returns counts as int32 and currency values as float64.
type: RecordType
has field: total spent
has field: total revenue

key
field key kind: identifierFieldKey
key text: total spent
type: FieldKey

total spent
is optional: false
max count: 1
min count: 1
field type: float
field key: key
comment: Total amount spent across attributed orders.
type: Field

key
field key kind: identifierFieldKey
key text: total revenue
type: FieldKey

total revenue
is optional: false
max count: 1
min count: 1
field type: float
field key: key
comment: Net attributed revenue.
type: Field

key
field key kind: identifierFieldKey
key text: enabled
type: FieldKey

enabled
is optional: false
max count: 1
min count: 1
field type: boolean
field key: key
comment: Whether delivery tracking is enabled for this campaign.
type: Field

Delivery Status
has field: enabled
comment: Send-progress snapshot attached to campaign and campaign-report resources. All fields are server-populated (read-only).
type: RecordType
has field: can cancel
has field: status
has field: emails sent
has field: emails canceled

key
field key kind: identifierFieldKey
key text: can cancel
type: FieldKey

can cancel
is optional: false
max count: 1
min count: 1
field type: boolean
field key: key
comment: Whether the operator can still cancel the in-flight send.
type: Field

key
field key kind: identifierFieldKey
key text: status
type: FieldKey

status
is optional: false
max count: 1
min count: 1
field type: string
field key: key
comment: Current state of the send pipeline.
type: Field

key
field key kind: identifierFieldKey
key text: emails sent
type: FieldKey

emails sent
is optional: false
max count: 1
min count: 1
field type: unknown
field key: key
comment: Count of messages successfully handed off to the SMTP layer.
type: Field

key
field key kind: identifierFieldKey
key text: emails canceled
type: FieldKey

emails canceled
is optional: false
max count: 1
min count: 1
field type: unknown
field key: key
comment: Count of messages that were canceled before send.
type: Field

key
field key kind: identifierFieldKey
key text: type
type: FieldKey

type
is optional: false
max count: 1
min count: 1
field type: url
field key: key
comment: URI reference to the error-type documentation.
type: Field

Mailchimp Error
has field: type
comment: Mailchimp Marketing API error envelope. Returned as `application/problem+json` (RFC 7807 Problem Details) for every documented 4xx/5xx response: 400, 401, 403, 404, 405, 414, 422, 426, 429, 500. All five top-level fields are always present; the `errors` array is populated only on validation failures (400).
type: RecordType
has field: title
has field: status
has field: detail
has field: instance
has field: errors

key
field key kind: identifierFieldKey
key text: title
type: FieldKey

title
is optional: false
max count: 1
min count: 1
field type: string
field key: key
comment: Short human-readable summary of the error category.
type: Field

key
field key kind: identifierFieldKey
key text: status
type: FieldKey

status
is optional: false
max count: 1
min count: 1
field type: unknown
field key: key
comment: HTTP status code repeated as an integer.
type: Field

key
field key kind: identifierFieldKey
key text: detail
type: FieldKey

detail
is optional: false
max count: 1
min count: 1
field type: string
field key: key
comment: Instance-specific explanation of what went wrong.
type: Field

key
field key kind: identifierFieldKey
key text: instance
type: FieldKey

instance
is optional: false
max count: 1
min count: 1
field type: string
field key: key
comment: Unique request identifier (UUID) for support correlation.
type: Field

errors array
is anonymous: true
array value type: Mailchimp Field Error
type: ArrayExpression

key
field key kind: identifierFieldKey
key text: errors
type: FieldKey

errors
is optional: true
field type: errors array
field key: key
comment: Per-field validation errors. Present only on `400 Bad Request`.
type: Field

key
field key kind: identifierFieldKey
key text: field
type: FieldKey

field
is optional: false
max count: 1
min count: 1
field type: string
field key: key
comment: Dotted path of the offending request field.
type: Field

Mailchimp Field Error
has field: field
comment: Per-field validation error returned inside `MailchimpError.errors` on `400 Bad Request` responses.
type: RecordType
has field: message

key
field key kind: identifierFieldKey
key text: message
type: FieldKey

message
is optional: false
max count: 1
min count: 1
field type: string
field key: key
comment: Human-readable description of why validation failed.
type: Field

key
field key kind: identifierFieldKey
key text: rel
type: FieldKey

rel
is optional: false
max count: 1
min count: 1
field type: string
field key: key
comment: Link relation type (e.g. `self`, `parent`, `create`, `update`, `delete`).
type: Field

HALLink
has field: rel
comment: HATEOAS link descriptor attached to every Mailchimp resource and list envelope under the `_links` array. Follows JSON Hyper-Schema conventions. `schema` is present only on links whose `method` accepts a request body (POST/PATCH/PUT). `targetSchema` describes the response payload shape.
type: RecordType
has field: href
has field: method
has field: target schema
has field: schema

key
field key kind: identifierFieldKey
key text: href
type: FieldKey

href
is optional: false
max count: 1
min count: 1
field type: url
field key: key
comment: Absolute URL of the linked resource.
type: Field

key
field key kind: identifierFieldKey
key text: method
type: FieldKey

method
is optional: true
max count: 1
field type: string
field key: key
comment: HTTP method used to follow the link.
type: Field

key
field key kind: identifierFieldKey
key text: target schema
type: FieldKey

target schema
is optional: true
max count: 1
field type: string
field key: key
comment: JSON Schema describing the response payload for this link.
type: Field

key
field key kind: identifierFieldKey
key text: schema
type: FieldKey

schema
is optional: true
max count: 1
field type: string
field key: key
comment: JSON Schema describing the request payload for this link (write methods only).
type: Field