Mailchimp Ontology
license: https://creativecommons.org/licenses/by/4.0/
publisher: inferal.com
preferred namespace prefix: mailchimp

HALLink
type: Class
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.
subclass of: EntryPoint

Mailchimp Field Error
type: Class
comment: Per-field validation error returned inside `MailchimpError.errors` on `400 Bad Request` responses.
subclass of: Thing

Mailchimp Error
type: Class
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).
subclass of: Thing

Delivery Status
type: Class
comment: Send-progress snapshot attached to campaign and campaign-report resources. All fields are server-populated (read-only).
subclass of: DeliveryEvent

Report Summary Ecommerce
type: Class
comment: Aggregate e-commerce numbers nested under `ReportSummary.ecommerce`. Mailchimp returns counts as int32 and currency values as float64.
subclass of: QuantitativeValue

Report Summary
type: Class
comment: High-level performance summary shared by Campaign and Automation resources. Campaign omits no fields; Automation omits `ecommerce`.
subclass of: QuantitativeValue

Campaign Tracking Salesforce
type: Class
comment: Salesforce CRM integration toggles nested under `CampaignTracking`. Both fields are deprecated by Mailchimp but still surface on responses.
subclass of: Thing

Campaign Tracking Capsule
type: Class
comment: Capsule CRM integration toggles nested under `CampaignTracking`. Deprecated by Mailchimp but still surface on responses.
subclass of: Thing

Campaign Tracking
type: Class
comment: Tracking-feature toggles shared by Campaign and Automation. Controls which engagement signals Mailchimp records for the send.
subclass of: Thing

Segment Condition
type: Class
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
subclass of: Thing

List Contact
type: Class
comment: Mailing address Mailchimp prints in the campaign footer to satisfy CAN-SPAM. Every list must carry a complete physical address.
subclass of: PostalAddress

List Campaign Defaults
type: Class
comment: Default fields applied to new campaigns drafted against this list.
subclass of: Thing

List Stats
type: Class
comment: Aggregate counters and rate metrics for a list. All fields are server-populated.
subclass of: QuantitativeValue

List
type: Class
comment: A Mailchimp audience (a.k.a. list) that contacts can subscribe to. Returned by `GET /lists/{list_id}`.
subclass of: Audience

Member Stats Ecommerce Data
type: Class
comment: Attributed e-commerce activity for the subscriber. Populated from Mailchimp's Ecomm360 store integrations.
subclass of: QuantitativeValue

Member Stats
type: Class
comment: Engagement and e-commerce summary for a single subscriber.
subclass of: QuantitativeValue

Member Location
type: Class
comment: Approximate geographic location resolved from the subscriber's most recent IP. Coordinates are zeroed when location cannot be determined.
subclass of: Place

Member Marketing Permission
type: Class
comment: GDPR marketing-permission flag attached to a subscriber. The `marketingPermissionId` is opaque and scoped to the parent list.
subclass of: Thing

Member Last Note
type: Class
comment: Most recent note attached to the member by an account user. References `MemberNote` via the opaque note identifier.
subclass of: Comment

Member Note
type: Class
comment: Stub — only used to resolve Ref<MemberNote>; full schema deferred to v2.
subclass of: Comment

Member
type: Class
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`.
subclass of: Person

Member Tag
type: Class
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.
subclass of: DefinedTerm

Tag
type: Class
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`.
subclass of: DefinedTerm

Segment Options
type: Class
comment: Predicate definition for a saved segment. `match` selects the conjunction; `conditions` is the polymorphic row list.
subclass of: Thing

Segment
type: Class
comment: A Mailchimp list segment used to target a subset of a list's subscribers. Returned by `GET /lists/{list_id}/segments/{segment_id}`.
subclass of: DefinedTermSet

Merge Field Options
type: Class
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.
subclass of: Thing

Merge Field
type: Class
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}`.
subclass of: PropertyValueSpecification

Merge Field Post Response
type: Class
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.

Campaign
type: Class
comment: A Mailchimp email campaign.
subclass of: CreativeWork

Campaign Recipients
type: Class
comment: Nested record for Campaign.recipients.
subclass of: Audience

Campaign Segment Opts
type: Class
comment: Nested record for Campaign.recipients.segmentOpts.
subclass of: Thing

Campaign Settings
type: Class
comment: Nested record for Campaign.settings.
subclass of: Thing

Variate Settings
type: Class
comment: Nested record for Campaign.variateSettings.
subclass of: Thing

Variate Combination
type: Class
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>.
subclass of: Thing

Rss Opts
type: Class
comment: Nested record for Campaign.rssOpts.
subclass of: Schedule

Rss Schedule
type: Class
comment: Nested record for Campaign.rssOpts.schedule.
subclass of: Schedule

Rss Daily Send
type: Class
comment: Nested record for Campaign.rssOpts.schedule.dailySend.
subclass of: Thing

ABSplit Opts
type: Class
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.
subclass of: Thing

Social Card
type: Class
comment: Nested record for Campaign.socialCard.
subclass of: Thing

Resend Shortcut Eligibility
type: Class
comment: Nested record for Campaign.resendShortcutEligibility. Only populated when the request includes `include_resend_shortcuts=true`.
subclass of: Thing

Resend Eligibility Entry
type: Class
comment: Nested record for a single resend-shortcut eligibility entry.
subclass of: Thing

Resend Shortcut Usage
type: Class
comment: Nested record for Campaign.resendShortcutUsage.
subclass of: Thing

Shortcut Campaign
type: Class
comment: Nested record for a resend-shortcut child campaign. Every field on this sub-shape is read-only.
subclass of: Thing

Original Shortcut Campaign
type: Class
comment: Nested record for Campaign.resendShortcutUsage.originalCampaign. Every field on this sub-shape is read-only.
subclass of: Thing

Campaign Report
type: Class
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
subclass of: Report

Bounces
type: Class
comment: Nested record for CampaignReport.bounces.
subclass of: QuantitativeValue

Forwards
type: Class
comment: Nested record for CampaignReport.forwards.
subclass of: QuantitativeValue

Opens
type: Class
comment: Nested record for CampaignReport.opens.
subclass of: InteractionCounter

Clicks
type: Class
comment: Nested record for CampaignReport.clicks.
subclass of: InteractionCounter

Facebook Likes
type: Class
comment: Nested record for CampaignReport.facebookLikes.
subclass of: InteractionCounter

Industry Stats
type: Class
comment: Nested record for CampaignReport.industryStats. Industry benchmark rates Mailchimp publishes for the campaign's declared industry segment.
subclass of: QuantitativeValue

Report List Stats
type: Class
comment: Nested record for CampaignReport.listStats.
subclass of: QuantitativeValue

ABSplit Result
type: Class
comment: Nested record for CampaignReport.abSplit (legacy A/B test results).
subclass of: Thing

ABSplit Arm
type: Class
comment: Nested record for a single A/B split arm in CampaignReport.abSplit.
subclass of: QuantitativeValue

Timewarp Entry
type: Class
comment: Nested record for a single Timewarp delivery slice in CampaignReport.timewarp[].
subclass of: QuantitativeValue

Timeseries Entry
type: Class
comment: Nested record for a single time-series bucket in CampaignReport.timeseries[].
subclass of: QuantitativeValue

Share Report
type: Class
comment: Nested record for CampaignReport.shareReport.
subclass of: Thing

Ecommerce
type: Class
comment: Nested record for CampaignReport.ecommerce.
subclass of: QuantitativeValue

Automation
type: Class
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}`.
subclass of: Action

Automation Recipients
type: Class
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.
subclass of: Audience

Automation Segment Opts
type: Class
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).
subclass of: Thing

Automation Settings
type: Class
comment: Sender and content settings nested under `Automation.settings`. Strict subset of `CampaignSettings` — no folder, template, social, or Google-Analytics fields.
subclass of: Thing

Trigger Settings
type: Class
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.
subclass of: Thing

Automation Runtime
type: Class
comment: Schedule constraints attached to `TriggerSettings.runtime`.
subclass of: Schedule

Automation Runtime Hours
type: Class
comment: Run-window descriptor nested under `TriggerSettings.runtime`. Restricts which weekdays and which hours the workflow may dispatch on.
subclass of: Schedule

Email Activity
type: Class
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.
subclass of: InteractionCounter

Email Activity Recipient
type: Class
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).
subclass of: Person

Email Activity Entry
type: Class
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.
subclass of: Action

List Webhook
type: Class
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}`.
subclass of: WebAPI

Webhook Events
type: Class
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.
subclass of: Thing

Webhook Sources
type: Class
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.
subclass of: Thing

Interest
type: Class
comment: Stub — only used to resolve Ref<Interest>; full schema deferred to v2.
subclass of: DefinedTerm

Interest Category
type: Class
comment: Stub — only used to resolve Ref<InterestCategory>; full schema deferred to v2.
subclass of: DefinedTermSet

List List Response
type: Class
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.

List Batch Members Input
type: Class
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.

List Batch Members Response
type: Class
comment: Response shape returned by `POST /lists/{list_id}`. Mailchimp returns three parallel arrays plus per-bucket counts and per-error detail.

List Input
type: Class
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}`.

Member List Response
type: Class
comment: Collection envelope returned by `GET /lists/{list_id}/members`.

Member Create Input
type: Class
comment: Body of `POST /lists/{list_id}/members`. Required to subscribe a new member; `email_address` and `status` are the only mandatory fields.

Member Upsert Input
type: Class
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).

Member Patch Input
type: Class
comment: Body of `PATCH /lists/{list_id}/members/{subscriber_hash}`. All fields optional; Mailchimp applies the supplied fields and leaves the rest.

Member Tag Assignment
type: Class
comment: Single tag entry returned by `GET /lists/{list_id}/members/{subscriber_hash}/tags`.

Member Tags Response
type: Class
comment: Envelope returned by `GET /lists/{list_id}/members/{subscriber_hash}/tags`.

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

Segment List Response
type: Class
comment: Collection envelope returned by `GET /lists/{list_id}/segments`.

Segment Input
type: Class
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.

Segment Batch Members Input
type: Class
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.

Segment Batch Members Response
type: Class
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.

Tag Search Response
type: Class
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.

Merge Field List Response
type: Class
comment: Collection envelope returned by `GET /lists/{list_id}/merge-fields`.

Merge Field Create Input
type: Class
comment: Body of `POST /lists/{list_id}/merge-fields`. Mailchimp generates the uppercase `tag` from the name when omitted.

Merge Field Update Input
type: Class
comment: Body of `PATCH /lists/{list_id}/merge-fields/{merge_id}`. Mailchimp disallows updating `type` after creation; the field is omitted here.

Campaign List Response
type: Class
comment: Collection envelope returned by `GET /campaigns`.

Campaign Create Input
type: Class
comment: Body of `POST /campaigns`. Mailchimp requires `type`; recipients, settings, and tracking are all optional at create time but become mandatory before send.

Campaign Update Input
type: Class
comment: Body of `PATCH /campaigns/{campaign_id}`. Mailchimp requires `settings`; all other top-level groups are optional.

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

Campaign Schedule Input
type: Class
comment: Body of `POST /campaigns/{campaign_id}/actions/schedule`.

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

Automation List Response
type: Class
comment: Collection envelope returned by `GET /automations`.

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

List Webhook List Response
type: Class
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.

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

Errors
type: Class

Tags
type: Class

Errors
type: Class

Batch Delivery Record
type: Class

Batch Delivery Entry
type: Class

Members Record
type: Class

Members Entry
type: Class

New Members Record
type: Class

New Members Entry
type: Class

Updated Members Record
type: Class

Updated Members Entry
type: Class

Constraints Record
type: Class

Constraints Entry
type: Class

Interests Record
type: Class

Interests Entry
type: Class

Merge Fields Record
type: Class

Merge Fields Entry
type: Class

Interests Record
type: Class

Interests Entry
type: Class

Location Record
type: Class

Location Entry
type: Class

Marketing Permissions Record
type: Class

Marketing Permissions Entry
type: Class

Merge Fields Record
type: Class

Merge Fields Entry
type: Class

Interests Record
type: Class

Interests Entry
type: Class

Location Record
type: Class

Location Entry
type: Class

Marketing Permissions Record
type: Class

Marketing Permissions Entry
type: Class

Merge Fields Record
type: Class

Merge Fields Entry
type: Class

Interests Record
type: Class

Interests Entry
type: Class

Location Record
type: Class

Location Entry
type: Class

Marketing Permissions Record
type: Class

Marketing Permissions Entry
type: Class

Merge Fields Record
type: Class

Merge Fields Entry
type: Class

Options Record
type: Class

Options Entry
type: Class

Options Record
type: Class

Options Entry
type: Class

Members Added Record
type: Class

Members Added Entry
type: Class

Members Removed Record
type: Class

Members Removed Entry
type: Class

Options Record
type: Class

Options Entry
type: Class

ABSplitPickWinner
type: ConceptScheme
comment: Winner-selection criterion for legacy A/B split tests.
has top concept: Opens
has top concept: Clicks
has top concept: Manual

Opens
type: Concept
in scheme: ABSplitPickWinner
top concept of: ABSplitPickWinner
alternative label: opens
definition: Pick winner by open rate
notation: opens

Clicks
type: Concept
in scheme: ABSplitPickWinner
top concept of: ABSplitPickWinner
alternative label: clicks
definition: Pick winner by click rate
notation: clicks

Manual
type: Concept
in scheme: ABSplitPickWinner
top concept of: ABSplitPickWinner
alternative label: manual
definition: Pick winner manually
notation: manual

ABSplitTest
type: ConceptScheme
comment: A/B split test variable being tested (legacy abSplitOpts).
has top concept: Subject
has top concept: From Name
has top concept: Schedule

Subject
type: Concept
in scheme: ABSplitTest
top concept of: ABSplitTest
alternative label: subject
definition: Test different subject lines
notation: subject

From Name
type: Concept
in scheme: ABSplitTest
top concept of: ABSplitTest
alternative label: fromName
definition: Test different from names
notation: from_name

Schedule
type: Concept
in scheme: ABSplitTest
top concept of: ABSplitTest
alternative label: schedule
definition: Test different send times
notation: schedule

ABSplitWaitUnits
type: ConceptScheme
comment: Wait-time unit for legacy A/B split tests and variate tests.
has top concept: Hours
has top concept: Days

Hours
type: Concept
in scheme: ABSplitWaitUnits
top concept of: ABSplitWaitUnits
alternative label: hours
definition: Wait time expressed in hours
notation: hours

Days
type: Concept
in scheme: ABSplitWaitUnits
top concept of: ABSplitWaitUnits
alternative label: days
definition: Wait time expressed in days
notation: days

AutomationRuntimeDay
type: ConceptScheme
comment: Day-of-week tokens accepted by `TriggerSettings.runtime.days`.
has top concept: Sunday
has top concept: Monday
has top concept: Tuesday
has top concept: Wednesday
has top concept: Thursday
has top concept: Friday
has top concept: Saturday

Sunday
type: Concept
in scheme: AutomationRuntimeDay
top concept of: AutomationRuntimeDay
alternative label: sunday
notation: sunday

Monday
type: Concept
in scheme: AutomationRuntimeDay
top concept of: AutomationRuntimeDay
alternative label: monday
notation: monday

Tuesday
type: Concept
in scheme: AutomationRuntimeDay
top concept of: AutomationRuntimeDay
alternative label: tuesday
notation: tuesday

Wednesday
type: Concept
in scheme: AutomationRuntimeDay
top concept of: AutomationRuntimeDay
alternative label: wednesday
notation: wednesday

Thursday
type: Concept
in scheme: AutomationRuntimeDay
top concept of: AutomationRuntimeDay
alternative label: thursday
notation: thursday

Friday
type: Concept
in scheme: AutomationRuntimeDay
top concept of: AutomationRuntimeDay
alternative label: friday
notation: friday

Saturday
type: Concept
in scheme: AutomationRuntimeDay
top concept of: AutomationRuntimeDay
alternative label: saturday
notation: saturday

AutomationRuntimeHoursType
type: ConceptScheme
comment: Daily run-window mode that gates when emails in the workflow may fire.
has top concept: Send Asap
has top concept: Send Between
has top concept: Send At

Send Asap
type: Concept
in scheme: AutomationRuntimeHoursType
top concept of: AutomationRuntimeHoursType
alternative label: sendAsap
notation: send_asap

Send Between
type: Concept
in scheme: AutomationRuntimeHoursType
top concept of: AutomationRuntimeHoursType
alternative label: sendBetween
notation: send_between

Send At
type: Concept
in scheme: AutomationRuntimeHoursType
top concept of: AutomationRuntimeHoursType
alternative label: sendAt
notation: send_at

AutomationSegmentMatch
type: ConceptScheme
comment: Segment-condition combinator used inside `Automation.recipients.segmentOpts`.
has top concept: Any
has top concept: All

Any
type: Concept
in scheme: AutomationSegmentMatch
top concept of: AutomationSegmentMatch
alternative label: any
notation: any

All
type: Concept
in scheme: AutomationSegmentMatch
top concept of: AutomationSegmentMatch
alternative label: all
notation: all

AutomationStatus
type: ConceptScheme
comment: Lifecycle state of an automation workflow.
has top concept: Save
has top concept: Paused
has top concept: Sending

Save
type: Concept
in scheme: AutomationStatus
top concept of: AutomationStatus
alternative label: save
notation: save

Paused
type: Concept
in scheme: AutomationStatus
top concept of: AutomationStatus
alternative label: paused
notation: paused

Sending
type: Concept
in scheme: AutomationStatus
top concept of: AutomationStatus
alternative label: sending
notation: sending

AutomationWorkflowType
type: ConceptScheme
comment: Built-in workflow templates Mailchimp exposes for an automation. `workflowType` is the only `required: true` field in the entire automation response schema. The 17 variants map one-to-one to Mailchimp's pre-built automation recipes (welcome series, abandoned-cart follow-ups, date-driven sends, integration-triggered sends, etc.).
has top concept: Abandoned Browse
has top concept: Abandoned Cart
has top concept: Api
has top concept: Best Customers
has top concept: Category Followup
has top concept: Date Added
has top concept: Email Followup
has top concept: Email Series
has top concept: Group Add
has top concept: Group Remove
has top concept: Mandrill
has top concept: Product Followup
has top concept: Purchase Followup
has top concept: Recurring Event
has top concept: Special Event
has top concept: Visit Url
has top concept: Welcome Series

Abandoned Browse
type: Concept
in scheme: AutomationWorkflowType
top concept of: AutomationWorkflowType
alternative label: abandonedBrowse
notation: abandonedBrowse

Abandoned Cart
type: Concept
in scheme: AutomationWorkflowType
top concept of: AutomationWorkflowType
alternative label: abandonedCart
notation: abandonedCart

Api
type: Concept
in scheme: AutomationWorkflowType
top concept of: AutomationWorkflowType
alternative label: api
notation: api

Best Customers
type: Concept
in scheme: AutomationWorkflowType
top concept of: AutomationWorkflowType
alternative label: bestCustomers
notation: bestCustomers

Category Followup
type: Concept
in scheme: AutomationWorkflowType
top concept of: AutomationWorkflowType
alternative label: categoryFollowup
notation: categoryFollowup

Date Added
type: Concept
in scheme: AutomationWorkflowType
top concept of: AutomationWorkflowType
alternative label: dateAdded
notation: dateAdded

Email Followup
type: Concept
in scheme: AutomationWorkflowType
top concept of: AutomationWorkflowType
alternative label: emailFollowup
notation: emailFollowup

Email Series
type: Concept
in scheme: AutomationWorkflowType
top concept of: AutomationWorkflowType
alternative label: emailSeries
notation: emailSeries

Group Add
type: Concept
in scheme: AutomationWorkflowType
top concept of: AutomationWorkflowType
alternative label: groupAdd
notation: groupAdd

Group Remove
type: Concept
in scheme: AutomationWorkflowType
top concept of: AutomationWorkflowType
alternative label: groupRemove
notation: groupRemove

Mandrill
type: Concept
in scheme: AutomationWorkflowType
top concept of: AutomationWorkflowType
alternative label: mandrill
notation: mandrill

Product Followup
type: Concept
in scheme: AutomationWorkflowType
top concept of: AutomationWorkflowType
alternative label: productFollowup
notation: productFollowup

Purchase Followup
type: Concept
in scheme: AutomationWorkflowType
top concept of: AutomationWorkflowType
alternative label: purchaseFollowup
notation: purchaseFollowup

Recurring Event
type: Concept
in scheme: AutomationWorkflowType
top concept of: AutomationWorkflowType
alternative label: recurringEvent
notation: recurringEvent

Special Event
type: Concept
in scheme: AutomationWorkflowType
top concept of: AutomationWorkflowType
alternative label: specialEvent
notation: specialEvent

Visit Url
type: Concept
in scheme: AutomationWorkflowType
top concept of: AutomationWorkflowType
alternative label: visitUrl
notation: visitUrl

Welcome Series
type: Concept
in scheme: AutomationWorkflowType
top concept of: AutomationWorkflowType
alternative label: welcomeSeries
notation: welcomeSeries

CampaignContentType
type: ConceptScheme
comment: Campaign content source.
has top concept: Template
has top concept: Html
has top concept: Url
has top concept: Multichannel

Template
type: Concept
in scheme: CampaignContentType
top concept of: CampaignContentType
alternative label: template
definition: Built from a saved template
notation: template

Html
type: Concept
in scheme: CampaignContentType
top concept of: CampaignContentType
alternative label: html
definition: Custom HTML
notation: html

Url
type: Concept
in scheme: CampaignContentType
top concept of: CampaignContentType
alternative label: url
definition: Imported from a URL
notation: url

Multichannel
type: Concept
in scheme: CampaignContentType
top concept of: CampaignContentType
alternative label: multichannel
definition: Multichannel content
notation: multichannel

CampaignReportType
type: ConceptScheme
comment: Campaign report type — a separate enum from CampaignType. The reports endpoint returns a loose, non-strictly-enforced variant with hyphen/underscore wire-format drift from Campaign.type. The set also includes `automation` and `auto` which Campaign.type omits.
has top concept: Regular
has top concept: Plain Text
has top concept: Ab Split
has top concept: Rss
has top concept: Variate
has top concept: Automation
has top concept: Auto

Regular
type: Concept
in scheme: CampaignReportType
top concept of: CampaignReportType
alternative label: regular
definition: Standard email campaign
notation: regular

Plain Text
type: Concept
in scheme: CampaignReportType
top concept of: CampaignReportType
alternative label: plainText
definition: Plain-text campaign (hyphenated wire form)
notation: plain-text

Ab Split
type: Concept
in scheme: CampaignReportType
top concept of: CampaignReportType
alternative label: abSplit
definition: Legacy A/B split test campaign (underscored wire form)
notation: ab_split

Rss
type: Concept
in scheme: CampaignReportType
top concept of: CampaignReportType
alternative label: rss
definition: RSS-driven recurring campaign
notation: rss

Variate
type: Concept
in scheme: CampaignReportType
top concept of: CampaignReportType
alternative label: variate
definition: Multivariate test campaign
notation: variate

Automation
type: Concept
in scheme: CampaignReportType
top concept of: CampaignReportType
alternative label: automation
definition: Automation-triggered campaign
notation: automation

Auto
type: Concept
in scheme: CampaignReportType
top concept of: CampaignReportType
alternative label: auto
definition: Auto-generated campaign
notation: auto

CampaignResendShortcut
type: ConceptScheme
comment: Resend shortcut variant accepted by `POST /campaigns/{campaign_id}/actions/create-resend`.
has top concept: To Non Openers
has top concept: To Non Clickers
has top concept: To Non Purchasers
has top concept: To New Subscribers

To Non Openers
type: Concept
in scheme: CampaignResendShortcut
top concept of: CampaignResendShortcut
alternative label: toNonOpeners
notation: to_non_openers

To Non Clickers
type: Concept
in scheme: CampaignResendShortcut
top concept of: CampaignResendShortcut
alternative label: toNonClickers
notation: to_non_clickers

To Non Purchasers
type: Concept
in scheme: CampaignResendShortcut
top concept of: CampaignResendShortcut
alternative label: toNonPurchasers
notation: to_non_purchasers

To New Subscribers
type: Concept
in scheme: CampaignResendShortcut
top concept of: CampaignResendShortcut
alternative label: toNewSubscribers
notation: to_new_subscribers

CampaignStatus
type: ConceptScheme
comment: Campaign lifecycle status.
has top concept: Save
has top concept: Paused
has top concept: Schedule
has top concept: Sending
has top concept: Sent
has top concept: Canceled
has top concept: Canceling
has top concept: Archived

Save
type: Concept
in scheme: CampaignStatus
top concept of: CampaignStatus
alternative label: save
definition: Saved draft
notation: save

Paused
type: Concept
in scheme: CampaignStatus
top concept of: CampaignStatus
alternative label: paused
definition: Paused (RSS/automation only)
notation: paused

Schedule
type: Concept
in scheme: CampaignStatus
top concept of: CampaignStatus
alternative label: schedule
definition: Scheduled for future delivery
notation: schedule

Sending
type: Concept
in scheme: CampaignStatus
top concept of: CampaignStatus
alternative label: sending
definition: Currently sending
notation: sending

Sent
type: Concept
in scheme: CampaignStatus
top concept of: CampaignStatus
alternative label: sent
definition: Send completed
notation: sent

Canceled
type: Concept
in scheme: CampaignStatus
top concept of: CampaignStatus
alternative label: canceled
definition: Send cancelled
notation: canceled

Canceling
type: Concept
in scheme: CampaignStatus
top concept of: CampaignStatus
alternative label: canceling
definition: Cancellation in progress
notation: canceling

Archived
type: Concept
in scheme: CampaignStatus
top concept of: CampaignStatus
alternative label: archived
definition: Archived
notation: archived

CampaignTestSendType
type: ConceptScheme
comment: Send-type filter for `POST /campaigns/{campaign_id}/actions/test`.
has top concept: Html
has top concept: Plaintext

Html
type: Concept
in scheme: CampaignTestSendType
top concept of: CampaignTestSendType
alternative label: html
notation: html

Plaintext
type: Concept
in scheme: CampaignTestSendType
top concept of: CampaignTestSendType
alternative label: plaintext
notation: plaintext

CampaignType
type: ConceptScheme
comment: Campaign type. Differs in wire format from CampaignReport.type (which uses hyphen/underscore variants and additional values).
has top concept: Regular
has top concept: Plaintext
has top concept: Absplit
has top concept: Rss
has top concept: Variate

Regular
type: Concept
in scheme: CampaignType
top concept of: CampaignType
alternative label: regular
definition: Standard email campaign
notation: regular

Plaintext
type: Concept
in scheme: CampaignType
top concept of: CampaignType
alternative label: plaintext
definition: Plain-text campaign
notation: plaintext

Absplit
type: Concept
in scheme: CampaignType
top concept of: CampaignType
alternative label: absplit
definition: Legacy A/B split test campaign (use variate instead)
notation: absplit

Rss
type: Concept
in scheme: CampaignType
top concept of: CampaignType
alternative label: rss
definition: RSS-driven recurring campaign
notation: rss

Variate
type: Concept
in scheme: CampaignType
top concept of: CampaignType
alternative label: variate
definition: Multivariate test campaign
notation: variate

DayOfWeek
type: ConceptScheme
comment: Day-of-week selector for RSS weekly schedules and automation runtime days.
has top concept: Sunday
has top concept: Monday
has top concept: Tuesday
has top concept: Wednesday
has top concept: Thursday
has top concept: Friday
has top concept: Saturday

Sunday
type: Concept
in scheme: DayOfWeek
top concept of: DayOfWeek
alternative label: sunday
notation: sunday

Monday
type: Concept
in scheme: DayOfWeek
top concept of: DayOfWeek
alternative label: monday
notation: monday

Tuesday
type: Concept
in scheme: DayOfWeek
top concept of: DayOfWeek
alternative label: tuesday
notation: tuesday

Wednesday
type: Concept
in scheme: DayOfWeek
top concept of: DayOfWeek
alternative label: wednesday
notation: wednesday

Thursday
type: Concept
in scheme: DayOfWeek
top concept of: DayOfWeek
alternative label: thursday
notation: thursday

Friday
type: Concept
in scheme: DayOfWeek
top concept of: DayOfWeek
alternative label: friday
notation: friday

Saturday
type: Concept
in scheme: DayOfWeek
top concept of: DayOfWeek
alternative label: saturday
notation: saturday

DeliveryStatusState
type: ConceptScheme
comment: Delivery progress envelope shared by `Campaign.deliveryStatus` and `CampaignReport.deliveryStatus`.
has top concept: Delivering
has top concept: Delivered
has top concept: Canceling
has top concept: Canceled

Delivering
type: Concept
in scheme: DeliveryStatusState
top concept of: DeliveryStatusState
alternative label: delivering
notation: delivering

Delivered
type: Concept
in scheme: DeliveryStatusState
top concept of: DeliveryStatusState
alternative label: delivered
notation: delivered

Canceling
type: Concept
in scheme: DeliveryStatusState
top concept of: DeliveryStatusState
alternative label: canceling
notation: canceling

Canceled
type: Concept
in scheme: DeliveryStatusState
top concept of: DeliveryStatusState
alternative label: canceled
notation: canceled

EmailActivityAction
type: ConceptScheme
comment: Action recorded for a single per-recipient activity row. Mailchimp documents the action set as prose only (no `enum` block in the spec). The three observed values are open, click, and bounce; sibling fields specialise per action (`url` set on click, `type` set on bounce).
has top concept: Open
has top concept: Click
has top concept: Bounce

Open
type: Concept
in scheme: EmailActivityAction
top concept of: EmailActivityAction
alternative label: open
notation: open

Click
type: Concept
in scheme: EmailActivityAction
top concept of: EmailActivityAction
alternative label: click
notation: click

Bounce
type: Concept
in scheme: EmailActivityAction
top concept of: EmailActivityAction
alternative label: bounce
notation: bounce

EmailActivityBounceType
type: ConceptScheme
comment: Bounce sub-classification used when `action == bounce`.
has top concept: Hard
has top concept: Soft

Hard
type: Concept
in scheme: EmailActivityBounceType
top concept of: EmailActivityBounceType
alternative label: hard
notation: hard

Soft
type: Concept
in scheme: EmailActivityBounceType
top concept of: EmailActivityBounceType
alternative label: soft
notation: soft

HALMethod
type: ConceptScheme
comment: HTTP methods reported by a HATEOAS link descriptor. Source: every Mailchimp `_links[].method` field across the v3 API.
has top concept: Get
has top concept: Post
has top concept: Put
has top concept: Patch
has top concept: Delete
has top concept: Head
has top concept: Options

Get
type: Concept
in scheme: HALMethod
top concept of: HALMethod
alternative label: GET
notation: GET

Post
type: Concept
in scheme: HALMethod
top concept of: HALMethod
alternative label: POST
notation: POST

Put
type: Concept
in scheme: HALMethod
top concept of: HALMethod
alternative label: PUT
notation: PUT

Patch
type: Concept
in scheme: HALMethod
top concept of: HALMethod
alternative label: PATCH
notation: PATCH

Delete
type: Concept
in scheme: HALMethod
top concept of: HALMethod
alternative label: DELETE
notation: DELETE

Head
type: Concept
in scheme: HALMethod
top concept of: HALMethod
alternative label: HEAD
notation: HEAD

Options
type: Concept
in scheme: HALMethod
top concept of: HALMethod
alternative label: OPTIONS
notation: OPTIONS

InterestCategoryType
type: ConceptScheme
comment: Presentation style Mailchimp uses to render the interest category on signup and preference forms.
has top concept: Checkboxes
has top concept: Dropdown
has top concept: Radio
has top concept: Hidden

Checkboxes
type: Concept
in scheme: InterestCategoryType
top concept of: InterestCategoryType
alternative label: checkboxes
notation: checkboxes

Dropdown
type: Concept
in scheme: InterestCategoryType
top concept of: InterestCategoryType
alternative label: dropdown
notation: dropdown

Radio
type: Concept
in scheme: InterestCategoryType
top concept of: InterestCategoryType
alternative label: radio
notation: radio

Hidden
type: Concept
in scheme: InterestCategoryType
top concept of: InterestCategoryType
alternative label: hidden
notation: hidden

ListVisibility
type: ConceptScheme
comment: Whether the list appears in Mailchimp's legacy public archive. Newer accounts only ever see `prv`; preserved for completeness.
has top concept: Pub
has top concept: Prv

Pub
type: Concept
in scheme: ListVisibility
top concept of: ListVisibility
alternative label: pub
notation: pub

Prv
type: Concept
in scheme: ListVisibility
top concept of: ListVisibility
alternative label: prv
notation: prv

MemberEmailType
type: ConceptScheme
comment: Format Mailchimp uses to deliver email to this subscriber. `html` is the default; `text` strips HTML to a plain-text alternative.
has top concept: Html
has top concept: Text

Html
type: Concept
in scheme: MemberEmailType
top concept of: MemberEmailType
alternative label: html
notation: html

Text
type: Concept
in scheme: MemberEmailType
top concept of: MemberEmailType
alternative label: text
notation: text

MemberSmsSubscriptionStatus
type: ConceptScheme
comment: SMS subscription state. `nonsubscribed` indicates the contact has a recorded phone number but has not opted in.
has top concept: Subscribed
has top concept: Unsubscribed
has top concept: Nonsubscribed
has top concept: Pending

Subscribed
type: Concept
in scheme: MemberSmsSubscriptionStatus
top concept of: MemberSmsSubscriptionStatus
alternative label: subscribed
notation: subscribed

Unsubscribed
type: Concept
in scheme: MemberSmsSubscriptionStatus
top concept of: MemberSmsSubscriptionStatus
alternative label: unsubscribed
notation: unsubscribed

Nonsubscribed
type: Concept
in scheme: MemberSmsSubscriptionStatus
top concept of: MemberSmsSubscriptionStatus
alternative label: nonsubscribed
notation: nonsubscribed

Pending
type: Concept
in scheme: MemberSmsSubscriptionStatus
top concept of: MemberSmsSubscriptionStatus
alternative label: pending
notation: pending

MemberStatus
type: ConceptScheme
comment: Subscription state of a contact on the list. `archived` removes the contact from the active subscriber count but preserves their history.
has top concept: Subscribed
has top concept: Unsubscribed
has top concept: Cleaned
has top concept: Pending
has top concept: Transactional
has top concept: Archived

Subscribed
type: Concept
in scheme: MemberStatus
top concept of: MemberStatus
alternative label: subscribed
notation: subscribed

Unsubscribed
type: Concept
in scheme: MemberStatus
top concept of: MemberStatus
alternative label: unsubscribed
notation: unsubscribed

Cleaned
type: Concept
in scheme: MemberStatus
top concept of: MemberStatus
alternative label: cleaned
notation: cleaned

Pending
type: Concept
in scheme: MemberStatus
top concept of: MemberStatus
alternative label: pending
notation: pending

Transactional
type: Concept
in scheme: MemberStatus
top concept of: MemberStatus
alternative label: transactional
notation: transactional

Archived
type: Concept
in scheme: MemberStatus
top concept of: MemberStatus
alternative label: archived
notation: archived

MergeFieldPhoneFormat
type: ConceptScheme
comment: Phone-number format expected for `MergeFieldType.phone`. `US` enforces a 10-digit US format; `International` accepts free-form numbers.
has top concept: Us
has top concept: International

Us
type: Concept
in scheme: MergeFieldPhoneFormat
top concept of: MergeFieldPhoneFormat
alternative label: us
notation: US

International
type: Concept
in scheme: MergeFieldPhoneFormat
top concept of: MergeFieldPhoneFormat
alternative label: international
notation: International

MergeFieldType
type: ConceptScheme
comment: Data type of a merge field. Drives validation and the input widget Mailchimp renders on signup and preference forms.
has top concept: Text
has top concept: Number
has top concept: Address
has top concept: Phone
has top concept: Date
has top concept: Url
has top concept: Imageurl
has top concept: Radio
has top concept: Dropdown
has top concept: Birthday
has top concept: Zip

Text
type: Concept
in scheme: MergeFieldType
top concept of: MergeFieldType
alternative label: text
notation: text

Number
type: Concept
in scheme: MergeFieldType
top concept of: MergeFieldType
alternative label: number
notation: number

Address
type: Concept
in scheme: MergeFieldType
top concept of: MergeFieldType
alternative label: address
notation: address

Phone
type: Concept
in scheme: MergeFieldType
top concept of: MergeFieldType
alternative label: phone
notation: phone

Date
type: Concept
in scheme: MergeFieldType
top concept of: MergeFieldType
alternative label: date
notation: date

Url
type: Concept
in scheme: MergeFieldType
top concept of: MergeFieldType
alternative label: url
notation: url

Imageurl
type: Concept
in scheme: MergeFieldType
top concept of: MergeFieldType
alternative label: imageurl
notation: imageurl

Radio
type: Concept
in scheme: MergeFieldType
top concept of: MergeFieldType
alternative label: radio
notation: radio

Dropdown
type: Concept
in scheme: MergeFieldType
top concept of: MergeFieldType
alternative label: dropdown
notation: dropdown

Birthday
type: Concept
in scheme: MergeFieldType
top concept of: MergeFieldType
alternative label: birthday
notation: birthday

Zip
type: Concept
in scheme: MergeFieldType
top concept of: MergeFieldType
alternative label: zip
notation: zip

ResendShortcutType
type: ConceptScheme
comment: Eligibility/usage shortcut type for resend campaigns.
has top concept: Non Openers
has top concept: New Subscribers
has top concept: Non Clickers
has top concept: Non Purchasers

Non Openers
type: Concept
in scheme: ResendShortcutType
top concept of: ResendShortcutType
alternative label: nonOpeners
definition: Resend to recipients who did not open the original
notation: non_openers

New Subscribers
type: Concept
in scheme: ResendShortcutType
top concept of: ResendShortcutType
alternative label: newSubscribers
definition: Resend to subscribers who joined after the original send
notation: new_subscribers

Non Clickers
type: Concept
in scheme: ResendShortcutType
top concept of: ResendShortcutType
alternative label: nonClickers
definition: Resend to recipients who opened but did not click
notation: non_clickers

Non Purchasers
type: Concept
in scheme: ResendShortcutType
top concept of: ResendShortcutType
alternative label: nonPurchasers
definition: Resend to recipients who did not purchase
notation: non_purchasers

RssFrequency
type: ConceptScheme
comment: RSS feed polling frequency.
has top concept: Daily
has top concept: Weekly
has top concept: Monthly

Daily
type: Concept
in scheme: RssFrequency
top concept of: RssFrequency
alternative label: daily
definition: Poll the RSS feed daily
notation: daily

Weekly
type: Concept
in scheme: RssFrequency
top concept of: RssFrequency
alternative label: weekly
definition: Poll the RSS feed weekly
notation: weekly

Monthly
type: Concept
in scheme: RssFrequency
top concept of: RssFrequency
alternative label: monthly
definition: Poll the RSS feed monthly
notation: monthly

SegmentMatch
type: ConceptScheme
comment: Conjunction applied across the condition rows of a saved segment.
has top concept: Any
has top concept: All

Any
type: Concept
in scheme: SegmentMatch
top concept of: SegmentMatch
alternative label: any
notation: any

All
type: Concept
in scheme: SegmentMatch
top concept of: SegmentMatch
alternative label: all
notation: all

SegmentMatchMode
type: ConceptScheme
comment: Segment matching mode for campaign recipients.
has top concept: Any
has top concept: All

Any
type: Concept
in scheme: SegmentMatchMode
top concept of: SegmentMatchMode
alternative label: any
definition: Match any condition (OR)
notation: any

All
type: Concept
in scheme: SegmentMatchMode
top concept of: SegmentMatchMode
alternative label: all
definition: Match all conditions (AND)
notation: all

SegmentType
type: ConceptScheme
comment: Segment kind. `saved` is a stored predicate, `static` is a tag-style fixed membership list, and `fuzzy` is a predictive Mailchimp-managed audience.
has top concept: Saved
has top concept: Static
has top concept: Fuzzy

Saved
type: Concept
in scheme: SegmentType
top concept of: SegmentType
alternative label: saved
notation: saved

Static
type: Concept
in scheme: SegmentType
top concept of: SegmentType
alternative label: static
notation: static

Fuzzy
type: Concept
in scheme: SegmentType
top concept of: SegmentType
alternative label: fuzzy
notation: fuzzy

VariateWinnerCriteria
type: ConceptScheme
comment: Winner-selection criterion for variate (multivariate) tests.
has top concept: Opens
has top concept: Clicks
has top concept: Manual
has top concept: Total Revenue

Opens
type: Concept
in scheme: VariateWinnerCriteria
top concept of: VariateWinnerCriteria
alternative label: opens
definition: Pick winner by open rate
notation: opens

Clicks
type: Concept
in scheme: VariateWinnerCriteria
top concept of: VariateWinnerCriteria
alternative label: clicks
definition: Pick winner by click rate
notation: clicks

Manual
type: Concept
in scheme: VariateWinnerCriteria
top concept of: VariateWinnerCriteria
alternative label: manual
definition: Pick winner manually
notation: manual

Total Revenue
type: Concept
in scheme: VariateWinnerCriteria
top concept of: VariateWinnerCriteria
alternative label: totalRevenue
definition: Pick winner by total ecommerce revenue
notation: total_revenue

a
type: Property
comment: Query alias: 1 model declares a.

ab split
type: Property
comment: Query alias: 1 model declares abSplit.

ab split opts
type: Property
comment: Query alias: 1 model declares abSplitOpts.

abuse rate
type: Property
comment: Query alias: 1 model declares abuseRate.

abuse reports
type: Property
comment: Query alias: 2 models declare abuseReports.

action
type: Property
comment: Query alias: 1 model declares action.

activity
type: Property
comment: Query alias: 1 model declares activity.

address1
type: Property
comment: Query alias: 1 model declares address1.

address2
type: Property
comment: Query alias: 1 model declares address2.

admin
type: Property
comment: Query alias: 1 model declares admin.

api
type: Property
comment: Query alias: 1 model declares api.

archive url
type: Property
comment: Query alias: 1 model declares archiveUrl.

authenticate
type: Property
comment: Query alias: 2 models declare authenticate.

auto fb post
type: Property
comment: Query alias: 1 model declares autoFbPost.

auto footer
type: Property
comment: Query alias: 2 models declare autoFooter.

automations
type: Property
comment: Query alias: 1 model declares automations.

auto tweet
type: Property
comment: Query alias: 1 model declares autoTweet.

avg click rate
type: Property
comment: Query alias: 1 model declares avgClickRate.

avg open rate
type: Property
comment: Query alias: 1 model declares avgOpenRate.

avg sub rate
type: Property
comment: Query alias: 1 model declares avgSubRate.

avg unsub rate
type: Property
comment: Query alias: 1 model declares avgUnsubRate.

b
type: Property
comment: Query alias: 1 model declares b.

batch delivery
type: Property
comment: Query alias: 1 model declares batchDelivery.

beamer address
type: Property
comment: Query alias: 1 model declares beamerAddress.

bounce rate
type: Property
comment: Query alias: 1 model declares bounceRate.

campaign
type: Property
comment: Query alias: 2 models declare campaign.

campaign count
type: Property
comment: Query alias: 1 model declares campaignCount.

campaign defaults
type: Property
comment: Query alias: 2 models declare campaignDefaults.

campaign id
type: Property
comment: Query alias: 2 models declare campaignId.

campaign last sent
type: Property
comment: Query alias: 1 model declares campaignLastSent.

campaigns
type: Property
comment: Query alias: 1 model declares campaigns.

campaign title
type: Property
comment: Query alias: 1 model declares campaignTitle.

can cancel
type: Property
comment: Query alias: 1 model declares canCancel.

capsule
type: Property
comment: Query alias: 1 model declares capsule.

category id
type: Property
comment: Query alias: 1 model declares categoryId.

choices
type: Property
comment: Query alias: 1 model declares choices.

city
type: Property
comment: Query alias: 1 model declares city.

cleaned
type: Property
comment: Query alias: 1 model declares cleaned.

cleaned count
type: Property
comment: Query alias: 1 model declares cleanedCount.

cleaned count since send
type: Property
comment: Query alias: 1 model declares cleanedCountSinceSend.

click rate
type: Property
comment: Query alias: 5 models declare clickRate.

clicks total
type: Property
comment: Query alias: 1 model declares clicksTotal.

clicktale
type: Property
comment: Query alias: 2 models declare clicktale.

combinations
type: Property
comment: Query alias: 1 model declares combinations.

company
type: Property
comment: Query alias: 1 model declares company.

conditions
type: Property
comment: Query alias: 3 models declare conditions.

condition type
type: Property
comment: Query alias: 1 model declares conditionType.

consents to one to one messaging
type: Property
comment: Query alias: 1 model declares consentsToOneToOneMessaging.

constrain rss img
type: Property
comment: Query alias: 1 model declares constrainRssImg.

constraints
type: Property
comment: Query alias: 1 model declares constraints.

contact
type: Property
comment: Query alias: 2 models declare contact.

contact id
type: Property
comment: Query alias: 1 model declares contactId.

content description
type: Property
comment: Query alias: 1 model declares contentDescription.

contents
type: Property
comment: Query alias: 1 model declares contents.

content type
type: Property
comment: Query alias: 2 models declare contentType.

country
type: Property
comment: Query alias: 1 model declares country.

country code
type: Property
comment: Query alias: 1 model declares countryCode.

created at
type: Property
comment: Query alias: 3 models declare createdAt.

created by
type: Property
comment: Query alias: 1 model declares createdBy.

create time
type: Property
comment: Query alias: 2 models declare createTime.

currency code
type: Property
comment: Query alias: 2 models declare currencyCode.

daily send
type: Property
comment: Query alias: 1 model declares dailySend.

date added
type: Property
comment: Query alias: 1 model declares dateAdded.

date created
type: Property
comment: Query alias: 1 model declares dateCreated.

date format
type: Property
comment: Query alias: 1 model declares dateFormat.

days
type: Property
comment: Query alias: 1 model declares days.

default country
type: Property
comment: Query alias: 1 model declares defaultCountry.

default value
type: Property
comment: Query alias: 4 models declare defaultValue.

delivery status
type: Property
comment: Query alias: 2 models declare deliveryStatus.

description
type: Property
comment: Query alias: 1 model declares description.

detail
type: Property
comment: Query alias: 1 model declares detail.

display order
type: Property
comment: Query alias: 4 models declare displayOrder.

double optin
type: Property
comment: Query alias: 2 models declare doubleOptin.

drag and drop
type: Property
comment: Query alias: 1 model declares dragAndDrop.

dstoff
type: Property
comment: Query alias: 1 model declares dstoff.

ecomm360
type: Property
comment: Query alias: 1 model declares ecomm360.

ecommerce data
type: Property
comment: Query alias: 1 model declares ecommerceData.

email address
type: Property
comment: Query alias: 6 models declare emailAddress.

email addresses
type: Property
comment: Query alias: 1 model declares emailAddresses.

email client
type: Property
comment: Query alias: 1 model declares emailClient.

email id
type: Property
comment: Query alias: 1 model declares emailId.

emails
type: Property
comment: Query alias: 1 model declares emails.

emails canceled
type: Property
comment: Query alias: 1 model declares emailsCanceled.

emails sent
type: Property
comment: Query alias: 5 models declare emailsSent.

email type
type: Property
comment: Query alias: 4 models declare emailType.

email type option
type: Property
comment: Query alias: 2 models declare emailTypeOption.

enabled
type: Property
comment: Query alias: 2 models declare enabled.

error
type: Property
comment: Query alias: 2 models declare error.

error code
type: Property
comment: Query alias: 1 model declares errorCode.

error count
type: Property
comment: Query alias: 2 models declare errorCount.

events
type: Property
comment: Query alias: 2 models declare events.

fb comments
type: Property
comment: Query alias: 1 model declares fbComments.

feed url
type: Property
comment: Query alias: 1 model declares feedUrl.

field
type: Property
comment: Query alias: 2 models declare field.

folder id
type: Property
comment: Query alias: 1 model declares folderId.

forwards count
type: Property
comment: Query alias: 1 model declares forwardsCount.

forwards opens
type: Property
comment: Query alias: 2 models declare forwardsOpens.

frequency
type: Property
comment: Query alias: 1 model declares frequency.

friday
type: Property
comment: Query alias: 1 model declares friday.

from email
type: Property
comment: Query alias: 1 model declares fromEmail.

from name a
type: Property
comment: Query alias: 1 model declares fromNameA.

from name b
type: Property
comment: Query alias: 1 model declares fromNameB.

from names
type: Property
comment: Query alias: 1 model declares fromNames.

full name
type: Property
comment: Query alias: 1 model declares fullName.

gmtoff
type: Property
comment: Query alias: 1 model declares gmtoff.

gmt offset
type: Property
comment: Query alias: 1 model declares gmtOffset.

goal tracking
type: Property
comment: Query alias: 1 model declares goalTracking.

google analytics
type: Property
comment: Query alias: 2 models declare googleAnalytics.

hard bounces
type: Property
comment: Query alias: 1 model declares hardBounces.

has welcome
type: Property
comment: Query alias: 1 model declares hasWelcome.

help text
type: Property
comment: Query alias: 4 models declare helpText.

hour
type: Property
comment: Query alias: 1 model declares hour.

hours
type: Property
comment: Query alias: 1 model declares hours.

href
type: Property
comment: Query alias: 1 model declares href.

html clicks
type: Property
comment: Query alias: 1 model declares htmlClicks.

image url
type: Property
comment: Query alias: 1 model declares imageUrl.

industry stats
type: Property
comment: Query alias: 1 model declares industryStats.

inline css
type: Property
comment: Query alias: 2 models declare inlineCss.

instance
type: Property
comment: Query alias: 1 model declares instance.

ip
type: Property
comment: Query alias: 1 model declares ip.

ip opt
type: Property
comment: Query alias: 4 models declare ipOpt.

ip signup
type: Property
comment: Query alias: 4 models declare ipSignup.

is eligible
type: Property
comment: Query alias: 1 model declares isEligible.

is syncing
type: Property
comment: Query alias: 1 model declares isSyncing.

language
type: Property
comment: Query alias: 5 models declare language.

last changed
type: Property
comment: Query alias: 1 model declares lastChanged.

last click
type: Property
comment: Query alias: 2 models declare lastClick.

last note
type: Property
comment: Query alias: 1 model declares lastNote.

last sent
type: Property
comment: Query alias: 1 model declares lastSent.

last sub date
type: Property
comment: Query alias: 1 model declares lastSubDate.

last unsub date
type: Property
comment: Query alias: 1 model declares lastUnsubDate.

latitude
type: Property
comment: Query alias: 1 model declares latitude.

links
type: Property
comment: Query alias: 17 models declare links.

list id
type: Property
comment: Query alias: 16 models declare listId.

list is active
type: Property
comment: Query alias: 4 models declare listIsActive.

list name
type: Property
comment: Query alias: 3 models declare listName.

list rating
type: Property
comment: Query alias: 1 model declares listRating.

lists
type: Property
comment: Query alias: 1 model declares lists.

list stats
type: Property
comment: Query alias: 1 model declares listStats.

long archive url
type: Property
comment: Query alias: 1 model declares longArchiveUrl.

longitude
type: Property
comment: Query alias: 1 model declares longitude.

marketing permission id
type: Property
comment: Query alias: 1 model declares marketingPermissionId.

match
type: Property
comment: Query alias: 3 models declare match.

member count
type: Property
comment: Query alias: 2 models declare memberCount.

member count since send
type: Property
comment: Query alias: 1 model declares memberCountSinceSend.

member id
type: Property
comment: Query alias: 1 model declares memberId.

member rating
type: Property
comment: Query alias: 1 model declares memberRating.

members added
type: Property
comment: Query alias: 1 model declares membersAdded.

members removed
type: Property
comment: Query alias: 1 model declares membersRemoved.

members to add
type: Property
comment: Query alias: 1 model declares membersToAdd.

members to remove
type: Property
comment: Query alias: 1 model declares membersToRemove.

merge field count
type: Property
comment: Query alias: 1 model declares mergeFieldCount.

merge field limit
type: Property
comment: Query alias: 1 model declares mergeFieldLimit.

merge id
type: Property
comment: Query alias: 2 models declare mergeId.

message
type: Property
comment: Query alias: 1 model declares message.

method
type: Property
comment: Query alias: 1 model declares method.

modules
type: Property
comment: Query alias: 1 model declares modules.

monday
type: Property
comment: Query alias: 1 model declares monday.

monthly send date
type: Property
comment: Query alias: 1 model declares monthlySendDate.

name
type: Property
comment: Query alias: 13 models declare name.

needs block refresh
type: Property
comment: Query alias: 1 model declares needsBlockRefresh.

new members
type: Property
comment: Query alias: 1 model declares newMembers.

note
type: Property
comment: Query alias: 2 models declare note.

note id
type: Property
comment: Query alias: 1 model declares noteId.

notes
type: Property
comment: Query alias: 2 models declare notes.

notify on subscribe
type: Property
comment: Query alias: 2 models declare notifyOnSubscribe.

notify on unsubscribe
type: Property
comment: Query alias: 2 models declare notifyOnUnsubscribe.

number of orders
type: Property
comment: Query alias: 1 model declares numberOfOrders.

op
type: Property
comment: Query alias: 1 model declares op.

open rate
type: Property
comment: Query alias: 5 models declare openRate.

opens total
type: Property
comment: Query alias: 1 model declares opensTotal.

original campaign
type: Property
comment: Query alias: 1 model declares originalCampaign.

parent campaign id
type: Property
comment: Query alias: 1 model declares parentCampaignId.

permission reminder
type: Property
comment: Query alias: 2 models declare permissionReminder.

phone
type: Property
comment: Query alias: 1 model declares phone.

phone format
type: Property
comment: Query alias: 1 model declares phoneFormat.

pick winner
type: Property
comment: Query alias: 1 model declares pickWinner.

prebuilt segment id
type: Property
comment: Query alias: 1 model declares prebuiltSegmentId.

preview text
type: Property
comment: Query alias: 2 models declare previewText.

profile
type: Property
comment: Query alias: 1 model declares profile.

proxy excluded open rate
type: Property
comment: Query alias: 2 models declare proxyExcludedOpenRate.

proxy excluded opens
type: Property
comment: Query alias: 1 model declares proxyExcludedOpens.

proxy excluded unique opens
type: Property
comment: Query alias: 2 models declare proxyExcludedUniqueOpens.

public
type: Property
comment: Query alias: 4 models declare public.

reason
type: Property
comment: Query alias: 1 model declares reason.

recipient clicks
type: Property
comment: Query alias: 1 model declares recipientClicks.

recipient count
type: Property
comment: Query alias: 1 model declares recipientCount.

recipient likes
type: Property
comment: Query alias: 1 model declares recipientLikes.

recipients clicks
type: Property
comment: Query alias: 1 model declares recipientsClicks.

region
type: Property
comment: Query alias: 1 model declares region.

rel
type: Property
comment: Query alias: 1 model declares rel.

reply email a
type: Property
comment: Query alias: 1 model declares replyEmailA.

reply email b
type: Property
comment: Query alias: 1 model declares replyEmailB.

reply to addresses
type: Property
comment: Query alias: 1 model declares replyToAddresses.

report summary
type: Property
comment: Query alias: 2 models declare reportSummary.

required
type: Property
comment: Query alias: 4 models declare required.

resendable
type: Property
comment: Query alias: 1 model declares resendable.

resend shortcut eligibility
type: Property
comment: Query alias: 1 model declares resendShortcutEligibility.

resend shortcut usage
type: Property
comment: Query alias: 1 model declares resendShortcutUsage.

rss last send
type: Property
comment: Query alias: 1 model declares rssLastSend.

rss opts
type: Property
comment: Query alias: 3 models declare rssOpts.

runtime
type: Property
comment: Query alias: 1 model declares runtime.

salesforce
type: Property
comment: Query alias: 1 model declares salesforce.

saturday
type: Property
comment: Query alias: 1 model declares saturday.

saved segment id
type: Property
comment: Query alias: 2 models declare savedSegmentId.

schedule
type: Property
comment: Query alias: 1 model declares schedule.

schedule time
type: Property
comment: Query alias: 1 model declares scheduleTime.

schema
type: Property
comment: Query alias: 1 model declares schema.

segments
type: Property
comment: Query alias: 1 model declares segments.

segment text
type: Property
comment: Query alias: 1 model declares segmentText.

send time a
type: Property
comment: Query alias: 1 model declares sendTimeA.

send time b
type: Property
comment: Query alias: 1 model declares sendTimeB.

send times
type: Property
comment: Query alias: 1 model declares sendTimes.

send time winner
type: Property
comment: Query alias: 1 model declares sendTimeWinner.

send type
type: Property
comment: Query alias: 1 model declares sendType.

share password
type: Property
comment: Query alias: 1 model declares sharePassword.

share report
type: Property
comment: Query alias: 1 model declares shareReport.

share url
type: Property
comment: Query alias: 1 model declares shareUrl.

shortcut campaigns
type: Property
comment: Query alias: 1 model declares shortcutCampaigns.

shortcut type
type: Property
comment: Query alias: 3 models declare shortcutType.

size
type: Property
comment: Query alias: 1 model declares size.

sms phone number
type: Property
comment: Query alias: 1 model declares smsPhoneNumber.

sms subscription last updated
type: Property
comment: Query alias: 1 model declares smsSubscriptionLastUpdated.

sms subscription status
type: Property
comment: Query alias: 1 model declares smsSubscriptionStatus.

social card
type: Property
comment: Query alias: 3 models declare socialCard.

soft bounces
type: Property
comment: Query alias: 1 model declares softBounces.

source
type: Property
comment: Query alias: 1 model declares source.

sources
type: Property
comment: Query alias: 2 models declare sources.

split size
type: Property
comment: Query alias: 1 model declares splitSize.

split test
type: Property
comment: Query alias: 1 model declares splitTest.

start time
type: Property
comment: Query alias: 1 model declares startTime.

state
type: Property
comment: Query alias: 1 model declares state.

static segment
type: Property
comment: Query alias: 1 model declares staticSegment.

status if new
type: Property
comment: Query alias: 1 model declares statusIfNew.

store id
type: Property
comment: Query alias: 1 model declares storeId.

subject
type: Property
comment: Query alias: 1 model declares subject.

subject a
type: Property
comment: Query alias: 1 model declares subjectA.

subject b
type: Property
comment: Query alias: 1 model declares subjectB.

subject lines
type: Property
comment: Query alias: 1 model declares subjectLines.

sub rate
type: Property
comment: Query alias: 1 model declares subRate.

subscribe
type: Property
comment: Query alias: 1 model declares subscribe.

subscriber clicks
type: Property
comment: Query alias: 1 model declares subscriberClicks.

subscribe url long
type: Property
comment: Query alias: 1 model declares subscribeUrlLong.

subscribe url short
type: Property
comment: Query alias: 1 model declares subscribeUrlShort.

sunday
type: Property
comment: Query alias: 1 model declares sunday.

sync tags
type: Property
comment: Query alias: 1 model declares syncTags.

syntax errors
type: Property
comment: Query alias: 1 model declares syntaxErrors.

tag
type: Property
comment: Query alias: 4 models declare tag.

tags count
type: Property
comment: Query alias: 1 model declares tagsCount.

target schema
type: Property
comment: Query alias: 1 model declares targetSchema.

target sub rate
type: Property
comment: Query alias: 1 model declares targetSubRate.

template id
type: Property
comment: Query alias: 1 model declares templateId.

test emails
type: Property
comment: Query alias: 1 model declares testEmails.

test size
type: Property
comment: Query alias: 1 model declares testSize.

text
type: Property
comment: Query alias: 1 model declares text.

text clicks
type: Property
comment: Query alias: 1 model declares textClicks.

thursday
type: Property
comment: Query alias: 1 model declares thursday.

timeseries
type: Property
comment: Query alias: 1 model declares timeseries.

timestamp
type: Property
comment: Query alias: 2 models declare timestamp.

timestamp opt
type: Property
comment: Query alias: 4 models declare timestampOpt.

timestamp signup
type: Property
comment: Query alias: 4 models declare timestampSignup.

timezone
type: Property
comment: Query alias: 1 model declares timezone.

title
type: Property
comment: Query alias: 6 models declare title.

to name
type: Property
comment: Query alias: 2 models declare toName.

to new subscribers
type: Property
comment: Query alias: 1 model declares toNewSubscribers.

to non clickers
type: Property
comment: Query alias: 1 model declares toNonClickers.

to non openers
type: Property
comment: Query alias: 1 model declares toNonOpeners.

to non purchasers
type: Property
comment: Query alias: 1 model declares toNonPurchasers.

total added
type: Property
comment: Query alias: 1 model declares totalAdded.

total contacts
type: Property
comment: Query alias: 1 model declares totalContacts.

total created
type: Property
comment: Query alias: 1 model declares totalCreated.

total items
type: Property
comment: Query alias: 10 models declare totalItems.

total orders
type: Property
comment: Query alias: 2 models declare totalOrders.

total removed
type: Property
comment: Query alias: 1 model declares totalRemoved.

total revenue
type: Property
comment: Query alias: 3 models declare totalRevenue.

total spent
type: Property
comment: Query alias: 2 models declare totalSpent.

total updated
type: Property
comment: Query alias: 1 model declares totalUpdated.

tracking
type: Property
comment: Query alias: 4 models declare tracking.

trigger settings
type: Property
comment: Query alias: 2 models declare triggerSettings.

tuesday
type: Property
comment: Query alias: 1 model declares tuesday.

unique clicks
type: Property
comment: Query alias: 2 models declare uniqueClicks.

unique email id
type: Property
comment: Query alias: 1 model declares uniqueEmailId.

unique likes
type: Property
comment: Query alias: 1 model declares uniqueLikes.

unique opens
type: Property
comment: Query alias: 5 models declare uniqueOpens.

unique subscriber clicks
type: Property
comment: Query alias: 1 model declares uniqueSubscriberClicks.

unopen rate
type: Property
comment: Query alias: 1 model declares unopenRate.

unsub rate
type: Property
comment: Query alias: 2 models declare unsubRate.

unsubs
type: Property
comment: Query alias: 1 model declares unsubs.

unsubscribe
type: Property
comment: Query alias: 1 model declares unsubscribe.

unsubscribe count
type: Property
comment: Query alias: 1 model declares unsubscribeCount.

unsubscribe count since send
type: Property
comment: Query alias: 1 model declares unsubscribeCountSinceSend.

unsubscribed
type: Property
comment: Query alias: 1 model declares unsubscribed.

unsubscribe reason
type: Property
comment: Query alias: 1 model declares unsubscribeReason.

updated at
type: Property
comment: Query alias: 1 model declares updatedAt.

updated members
type: Property
comment: Query alias: 1 model declares updatedMembers.

update existing
type: Property
comment: Query alias: 1 model declares updateExisting.

upemail
type: Property
comment: Query alias: 1 model declares upemail.

use archive bar
type: Property
comment: Query alias: 2 models declare useArchiveBar.

use conversation
type: Property
comment: Query alias: 2 models declare useConversation.

user
type: Property
comment: Query alias: 1 model declares user.

value
type: Property
comment: Query alias: 1 model declares value.

variate settings
type: Property
comment: Query alias: 3 models declare variateSettings.

vip
type: Property
comment: Query alias: 4 models declare vip.

visibility
type: Property
comment: Query alias: 1 model declares visibility.

wait time
type: Property
comment: Query alias: 2 models declare waitTime.

wait units
type: Property
comment: Query alias: 1 model declares waitUnits.

webhooks
type: Property
comment: Query alias: 1 model declares webhooks.

web id
type: Property
comment: Query alias: 5 models declare webId.

wednesday
type: Property
comment: Query alias: 1 model declares wednesday.

weekly send day
type: Property
comment: Query alias: 1 model declares weeklySendDay.

winner criteria
type: Property
comment: Query alias: 1 model declares winnerCriteria.

winning campaign id
type: Property
comment: Query alias: 1 model declares winningCampaignId.

winning combination id
type: Property
comment: Query alias: 1 model declares winningCombinationId.

workflow emails count
type: Property
comment: Query alias: 1 model declares workflowEmailsCount.

workflow title
type: Property
comment: Query alias: 1 model declares workflowTitle.

workflow type
type: Property
comment: Query alias: 1 model declares workflowType.

zip
type: Property
comment: Query alias: 1 model declares zip.

rel
type: Property
comment: Link relation type (e.g. `self`, `parent`, `create`, `update`, `delete`).
alternate name: rel
sub property of: rel
domain: HALLink
range: string

href
type: Property
comment: Absolute URL of the linked resource.
alternate name: href
sub property of: href
sub property of: url
domain: HALLink
range: anyURI

method
type: Property
comment: HTTP method used to follow the link.
alternate name: method
sub property of: method
sub property of: httpMethod
domain: HALLink
range: string
code list: HALMethod

target schema
type: Property
comment: JSON Schema describing the response payload for this link.
alternate name: targetSchema
sub property of: target schema
domain: HALLink
range: string

schema
type: Property
comment: JSON Schema describing the request payload for this link (write methods only).
alternate name: schema
sub property of: schema
domain: HALLink
range: string

field
type: Property
comment: Dotted path of the offending request field.
alternate name: field
sub property of: field
domain: Mailchimp Field Error
range: string

message
type: Property
comment: Human-readable description of why validation failed.
alternate name: message
sub property of: message
sub property of: description
domain: Mailchimp Field Error
range: string

type
type: Property
comment: URI reference to the error-type documentation.
alternate name: type
sub property of: url
domain: Mailchimp Error
range: anyURI

title
type: Property
comment: Short human-readable summary of the error category.
alternate name: title
sub property of: title
sub property of: name
domain: Mailchimp Error
range: string

status
type: Property
comment: HTTP status code repeated as an integer.
alternate name: status
sub property of: statusCodeValue
domain: Mailchimp Error
range: int

detail
type: Property
comment: Instance-specific explanation of what went wrong.
alternate name: detail
sub property of: detail
sub property of: description
domain: Mailchimp Error
range: string

instance
type: Property
comment: Unique request identifier (UUID) for support correlation.
alternate name: instance
sub property of: instance
sub property of: identifier
domain: Mailchimp Error
range: string

errors
type: Property
comment: Per-field validation errors. Present only on `400 Bad Request`.
alternate name: errors
domain: Mailchimp Error
range: Mailchimp Field Error

enabled
type: Property
comment: Whether delivery tracking is enabled for this campaign.
alternate name: enabled
sub property of: enabled
domain: Delivery Status
range: boolean

can cancel
type: Property
comment: Whether the operator can still cancel the in-flight send.
alternate name: can_cancel
sub property of: can cancel
domain: Delivery Status
range: boolean

status
type: Property
comment: Current state of the send pipeline.
alternate name: status
domain: Delivery Status
range: string
code list: DeliveryStatusState

emails sent
type: Property
comment: Count of messages successfully handed off to the SMTP layer.
alternate name: emails_sent
sub property of: emails sent
sub property of: numberOfItems
domain: Delivery Status
range: int

emails canceled
type: Property
comment: Count of messages that were canceled before send.
alternate name: emails_canceled
sub property of: emails canceled
domain: Delivery Status
range: int

total orders
type: Property
comment: Number of attributed orders.
alternate name: total_orders
sub property of: total orders
sub property of: numberOfItems
domain: Report Summary Ecommerce
range: int

total spent
type: Property
comment: Total amount spent across attributed orders.
alternate name: total_spent
sub property of: total spent
domain: Report Summary Ecommerce
range: double

total revenue
type: Property
comment: Net attributed revenue.
alternate name: total_revenue
sub property of: total revenue
domain: Report Summary Ecommerce
range: double

opens
type: Property
comment: Total opens across all recipients.
alternate name: opens
domain: Report Summary
range: int

unique opens
type: Property
comment: Distinct opening recipients.
alternate name: unique_opens
sub property of: unique opens
domain: Report Summary
range: int

clicks
type: Property
comment: Total link clicks.
alternate name: clicks
domain: Report Summary
range: int

subscriber clicks
type: Property
comment: Distinct clicking recipients.
alternate name: subscriber_clicks
sub property of: subscriber clicks
domain: Report Summary
range: int

open rate
type: Property
comment: Opens divided by deliveries.
alternate name: open_rate
sub property of: open rate
domain: Report Summary
range: double

click rate
type: Property
comment: Clicks divided by deliveries.
alternate name: click_rate
sub property of: click rate
domain: Report Summary
range: double

ecommerce
type: Property
comment: Attributed e-commerce aggregates. Absent on Automation summaries.
alternate name: ecommerce
domain: Report Summary
range: Report Summary Ecommerce

campaign
type: Property
comment: Push a Salesforce campaign record on send.
alternate name: campaign
sub property of: campaign
domain: Campaign Tracking Salesforce
range: boolean

notes
type: Property
comment: Push send activity into Salesforce notes.
alternate name: notes
sub property of: notes
domain: Campaign Tracking Salesforce
range: boolean

notes
type: Property
comment: Push send activity into Capsule notes.
alternate name: notes
sub property of: notes
domain: Campaign Tracking Capsule
range: boolean

opens
type: Property
comment: Track open pixel events.
alternate name: opens
domain: Campaign Tracking
range: boolean

html clicks
type: Property
comment: Track clicks in the HTML body.
alternate name: html_clicks
sub property of: html clicks
domain: Campaign Tracking
range: boolean

text clicks
type: Property
comment: Track clicks in the plain-text body.
alternate name: text_clicks
sub property of: text clicks
domain: Campaign Tracking
range: boolean

goal tracking
type: Property
comment: Track conversions on the operator's website via Mailchimp goals.
alternate name: goal_tracking
sub property of: goal tracking
domain: Campaign Tracking
range: boolean

ecomm360
type: Property
comment: Track e-commerce events via Mailchimp Ecomm360.
alternate name: ecomm360
sub property of: ecomm360
domain: Campaign Tracking
range: boolean

google analytics
type: Property
comment: Google Analytics campaign tag (max 50 bytes).
alternate name: google_analytics
sub property of: google analytics
domain: Campaign Tracking
range: string

clicktale
type: Property
comment: ClickTale campaign tag (max 50 bytes).
alternate name: clicktale
sub property of: clicktale
domain: Campaign Tracking
range: string

salesforce
type: Property
comment: Salesforce CRM push toggles.
alternate name: salesforce
sub property of: salesforce
domain: Campaign Tracking
range: Campaign Tracking Salesforce
deprecated: true

capsule
type: Property
comment: Capsule CRM push toggles.
alternate name: capsule
sub property of: capsule
domain: Campaign Tracking
range: Campaign Tracking Capsule
deprecated: true

condition type
type: Property
comment: Discriminator selecting the condition variant.
alternate name: condition_type
sub property of: condition type
domain: Segment Condition
range: string

field
type: Property
comment: Member or merge-field path the condition targets. Variant-defined.
alternate name: field
sub property of: field
domain: Segment Condition
range: string

op
type: Property
comment: Comparison operator (e.g. `is`, `not`, `greater`). Variant-defined.
alternate name: op
sub property of: op
domain: Segment Condition
range: string

value
type: Property
comment: Variant-specific comparison value. Concrete type depends on `conditionType` (string, number, boolean, array, or nested object).
alternate name: value
sub property of: value
domain: Segment Condition
range: JSON

company
type: Property
comment: Company or organization name printed in the footer.
alternate name: company
sub property of: company
domain: List Contact
range: string

address1
type: Property
comment: Street address line 1.
alternate name: address1
sub property of: address1
sub property of: streetAddress
domain: List Contact
range: string

address2
type: Property
comment: Street address line 2 (suite, unit, etc.).
alternate name: address2
sub property of: address2
sub property of: streetAddress
domain: List Contact
range: string

city
type: Property
comment: City.
alternate name: city
sub property of: city
sub property of: addressLocality
domain: List Contact
range: string

state
type: Property
comment: State or province.
alternate name: state
sub property of: state
sub property of: addressRegion
domain: List Contact
range: string

zip
type: Property
comment: Postal code.
alternate name: zip
sub property of: zip
sub property of: postalCode
domain: List Contact
range: string

country
type: Property
comment: ISO 3166-1 alpha-2 country code.
alternate name: country
sub property of: country
sub property of: addressCountry
domain: List Contact
range: string

phone
type: Property
comment: Contact phone number.
alternate name: phone
sub property of: phone
sub property of: telephone
domain: List Contact
range: string

from name
type: Property
comment: Default "from" display name.
alternate name: from_name
sub property of: name
domain: List Campaign Defaults
range: string

from email
type: Property
comment: Default "from" email address.
alternate name: from_email
sub property of: from email
sub property of: email
domain: List Campaign Defaults
range: string

subject
type: Property
comment: Default subject line.
alternate name: subject
sub property of: subject
domain: List Campaign Defaults
range: string

language
type: Property
comment: Default language code (e.g. `en`, `es`).
alternate name: language
sub property of: language
sub property of: inLanguage
domain: List Campaign Defaults
range: string

member count
type: Property
comment: Active subscriber count.
alternate name: member_count
sub property of: member count
sub property of: numberOfItems
domain: List Stats
range: int

total contacts
type: Property
comment: Total contacts in any state (subscribed + unsubscribed + cleaned).
alternate name: total_contacts
sub property of: total contacts
domain: List Stats
range: int

unsubscribe count
type: Property
comment: Unsubscribed contact count.
alternate name: unsubscribe_count
sub property of: unsubscribe count
domain: List Stats
range: int

cleaned count
type: Property
comment: Cleaned (bounced/invalid) contact count.
alternate name: cleaned_count
sub property of: cleaned count
domain: List Stats
range: int

member count since send
type: Property
comment: Net subscribers added since the last send.
alternate name: member_count_since_send
sub property of: member count since send
domain: List Stats
range: int

unsubscribe count since send
type: Property
comment: Unsubscribes since the last send.
alternate name: unsubscribe_count_since_send
sub property of: unsubscribe count since send
domain: List Stats
range: int

cleaned count since send
type: Property
comment: Contacts cleaned since the last send.
alternate name: cleaned_count_since_send
sub property of: cleaned count since send
domain: List Stats
range: int

campaign count
type: Property
comment: Lifetime campaign count for this list.
alternate name: campaign_count
sub property of: campaign count
domain: List Stats
range: int

campaign last sent
type: Property
comment: Total campaigns ever sent to this list.
alternate name: campaign_last_sent
sub property of: campaign last sent
domain: List Stats
range: dateTime

merge field count
type: Property
comment: Number of merge fields defined for the list.
alternate name: merge_field_count
sub property of: merge field count
domain: List Stats
range: int

avg sub rate
type: Property
comment: Average subscribe rate per month.
alternate name: avg_sub_rate
sub property of: avg sub rate
domain: List Stats
range: double

avg unsub rate
type: Property
comment: Average unsubscribe rate per month.
alternate name: avg_unsub_rate
sub property of: avg unsub rate
domain: List Stats
range: double

target sub rate
type: Property
comment: Target monthly subscribe rate set by the operator.
alternate name: target_sub_rate
sub property of: target sub rate
domain: List Stats
range: double

open rate
type: Property
comment: Open rate averaged across recent campaigns.
alternate name: open_rate
sub property of: open rate
domain: List Stats
range: double

click rate
type: Property
comment: Click rate averaged across recent campaigns.
alternate name: click_rate
sub property of: click rate
domain: List Stats
range: double

last sub date
type: Property
comment: Timestamp of the most recent subscribe event.
alternate name: last_sub_date
sub property of: last sub date
domain: List Stats
range: dateTime

last unsub date
type: Property
comment: Timestamp of the most recent unsubscribe event.
alternate name: last_unsub_date
sub property of: last unsub date
domain: List Stats
range: dateTime

id
type: Property
comment: Opaque list identifier.
alternate name: id
sub property of: identifier
domain: List
range: string

web id
type: Property
comment: Secondary numeric identifier surfaced in the Mailchimp admin UI URL.
alternate name: web_id
sub property of: web id
domain: List
range: int

name
type: Property
comment: Display name of the list.
alternate name: name
sub property of: name
domain: List
range: string

contact
type: Property
comment: Physical mailing address printed in the campaign footer.
alternate name: contact
sub property of: contact
sub property of: contactPoint
domain: List
range: List Contact

permission reminder
type: Property
comment: Reminder text explaining why a recipient is on this list.
alternate name: permission_reminder
sub property of: permission reminder
domain: List
range: string

use archive bar
type: Property
comment: Whether to render the Mailchimp archive bar in sent campaigns.
alternate name: use_archive_bar
sub property of: use archive bar
domain: List
range: boolean

campaign defaults
type: Property
comment: Default field values applied to new campaigns drafted against this list.
alternate name: campaign_defaults
sub property of: campaign defaults
domain: List
range: List Campaign Defaults

notify on subscribe
type: Property
comment: Email address notified when a contact subscribes.
alternate name: notify_on_subscribe
sub property of: notify on subscribe
domain: List
range: string

notify on unsubscribe
type: Property
comment: Email address notified when a contact unsubscribes.
alternate name: notify_on_unsubscribe
sub property of: notify on unsubscribe
domain: List
range: string

date created
type: Property
comment: Timestamp when the list was created.
alternate name: date_created
sub property of: date created
sub property of: dateCreated
domain: List
range: dateTime

list rating
type: Property
comment: Mailchimp-assigned engagement rating from 0 (lowest) to 5 (highest).
alternate name: list_rating
sub property of: list rating
domain: List
range: int

email type option
type: Property
comment: Whether subscribers can choose between HTML and plain-text email.
alternate name: email_type_option
sub property of: email type option
domain: List
range: boolean

subscribe url short
type: Property
comment: Branded short URL hosting the subscribe form.
alternate name: subscribe_url_short
sub property of: subscribe url short
domain: List
range: string

subscribe url long
type: Property
comment: Canonical long URL hosting the subscribe form.
alternate name: subscribe_url_long
sub property of: subscribe url long
domain: List
range: string

beamer address
type: Property
comment: Email Beamer inbound address for converting emails into campaigns.
alternate name: beamer_address
sub property of: beamer address
domain: List
range: string

visibility
type: Property
comment: Legacy public/private visibility flag. Newer accounts always see `prv`.
alternate name: visibility
sub property of: visibility
domain: List
range: string
code list: ListVisibility

double optin
type: Property
comment: Whether subscribers must confirm via a follow-up email before being added.
alternate name: double_optin
sub property of: double optin
domain: List
range: boolean

has welcome
type: Property
comment: Whether a welcome email is sent on subscribe.
alternate name: has_welcome
sub property of: has welcome
domain: List
range: boolean

marketing permissions
type: Property
comment: Whether the list collects GDPR marketing permission flags.
alternate name: marketing_permissions
domain: List
range: boolean

modules
type: Property
comment: Mailchimp module identifiers enabled for the list (read-only).
alternate name: modules
sub property of: modules
domain: List
range: string

stats
type: Property
comment: Aggregate counters and rate metrics for the list.
alternate name: stats
domain: List
range: List Stats

links
type: Property
comment: HATEOAS link descriptors for related resources.
alternate name: _links
sub property of: links
domain: List
range: HALLink

total revenue
type: Property
comment: Lifetime attributed revenue.
alternate name: total_revenue
sub property of: total revenue
domain: Member Stats Ecommerce Data
range: double

number of orders
type: Property
comment: Lifetime attributed order count.
alternate name: number_of_orders
sub property of: number of orders
domain: Member Stats Ecommerce Data
range: double

currency code
type: Property
comment: ISO 4217 currency code of the attributed totals.
alternate name: currency_code
sub property of: currency code
sub property of: currency
domain: Member Stats Ecommerce Data
range: string

avg open rate
type: Property
comment: Open rate averaged across campaigns sent to this member.
alternate name: avg_open_rate
sub property of: avg open rate
domain: Member Stats
range: double

avg click rate
type: Property
comment: Click rate averaged across campaigns sent to this member.
alternate name: avg_click_rate
sub property of: avg click rate
domain: Member Stats
range: double

ecommerce data
type: Property
comment: Attributed e-commerce aggregates from Ecomm360.
alternate name: ecommerce_data
sub property of: ecommerce data
domain: Member Stats
range: Member Stats Ecommerce Data

latitude
type: Property
comment: Approximate latitude.
alternate name: latitude
sub property of: latitude
domain: Member Location
range: double

longitude
type: Property
comment: Approximate longitude.
alternate name: longitude
sub property of: longitude
domain: Member Location
range: double

gmtoff
type: Property
comment: GMT offset in hours at resolution time.
alternate name: gmtoff
sub property of: gmtoff
domain: Member Location
range: int

dstoff
type: Property
comment: Daylight-savings offset in hours at resolution time.
alternate name: dstoff
sub property of: dstoff
domain: Member Location
range: int

country code
type: Property
comment: ISO 3166-1 alpha-2 country code.
alternate name: country_code
sub property of: country code
sub property of: addressCountry
domain: Member Location
range: string

timezone
type: Property
comment: IANA timezone identifier.
alternate name: timezone
sub property of: timezone
domain: Member Location
range: string

region
type: Property
comment: ISO 3166-2 subdivision code.
alternate name: region
sub property of: region
sub property of: addressRegion
domain: Member Location
range: string

marketing permission id
type: Property
comment: Opaque permission identifier scoped to the parent list.
alternate name: marketing_permission_id
sub property of: marketing permission id
sub property of: identifier
domain: Member Marketing Permission
range: string

text
type: Property
comment: Human-readable description of what the subscriber consented to.
alternate name: text
sub property of: text
sub property of: description
domain: Member Marketing Permission
range: string

enabled
type: Property
comment: Whether the subscriber currently grants the permission.
alternate name: enabled
sub property of: enabled
domain: Member Marketing Permission
range: boolean

note id
type: Property
comment: Opaque identifier of the source `MemberNote`.
alternate name: note_id
sub property of: note id
domain: Member Last Note
range: Member Note

created at
type: Property
comment: Timestamp when the note was authored.
alternate name: created_at
sub property of: created at
sub property of: dateCreated
domain: Member Last Note
range: dateTime

created by
type: Property
comment: Display name of the account user who authored the note.
alternate name: created_by
sub property of: created by
domain: Member Last Note
range: string

note
type: Property
comment: Free-text note body.
alternate name: note
sub property of: note
sub property of: text
domain: Member Last Note
range: string

id
type: Property
comment: Opaque member-note ID.
alternate name: id
sub property of: identifier
domain: Member Note
range: string

member id
type: Property
comment: Parent member this note is attached to.
alternate name: member_id
sub property of: member id
sub property of: about
domain: Member Note
range: Member

note
type: Property
comment: Free-text note body.
alternate name: note
sub property of: note
sub property of: text
domain: Member Note
range: string

created at
type: Property
comment: Timestamp when the note was created.
alternate name: created_at
sub property of: created at
sub property of: dateCreated
domain: Member Note
range: dateTime

id
type: Property
comment: MD5 hash of the lowercased email address. Distinct from `uniqueEmailId`.
alternate name: id
sub property of: identifier
domain: Member
range: string

email address
type: Property
comment: Subscriber's email address.
alternate name: email_address
sub property of: email address
sub property of: email
domain: Member
range: string

unique email id
type: Property
comment: Cross-Mailchimp email-address identifier (different from `id`).
alternate name: unique_email_id
sub property of: unique email id
domain: Member
range: string

contact id
type: Property
comment: Email-agnostic contact identifier persistent across address changes.
alternate name: contact_id
sub property of: contact id
domain: Member
range: string

full name
type: Property
comment: Subscriber's full name as resolved from merge fields.
alternate name: full_name
sub property of: full name
sub property of: name
domain: Member
range: string

web id
type: Property
comment: Secondary numeric identifier surfaced in the Mailchimp admin UI URL.
alternate name: web_id
sub property of: web id
domain: Member
range: int

email type
type: Property
comment: Delivery format preference (`html` or `text`).
alternate name: email_type
sub property of: email type
domain: Member
range: string
code list: MemberEmailType

status
type: Property
comment: Subscription state of the contact on the list.
alternate name: status
domain: Member
range: string
code list: MemberStatus

unsubscribe reason
type: Property
comment: Free-text reason captured when the subscriber unsubscribed.
alternate name: unsubscribe_reason
sub property of: unsubscribe reason
domain: Member
range: string

consents to one to one messaging
type: Property
comment: Whether the subscriber consents to one-to-one outreach.
alternate name: consents_to_one_to_one_messaging
sub property of: consents to one to one messaging
domain: Member
range: boolean

sms phone number
type: Property
comment: SMS phone number on file. US numbers only.
alternate name: sms_phone_number
sub property of: sms phone number
sub property of: telephone
domain: Member
range: string

sms subscription status
type: Property
comment: SMS subscription state.
alternate name: sms_subscription_status
sub property of: sms subscription status
domain: Member
range: string
code list: MemberSmsSubscriptionStatus

sms subscription last updated
type: Property
comment: Last update to SMS subscription state. Wire format is unspecified; emitted as a string.
alternate name: sms_subscription_last_updated
sub property of: sms subscription last updated
domain: Member
range: string

merge fields
type: Property
comment: Open dictionary of merge-field values keyed by merge tag.
alternate name: merge_fields
sub property of: additionalProperty
domain: Member
range: Merge Fields Record

interests
type: Property
comment: Map of interest opt-ins. Keys are `Ref<Interest>` identifiers; values indicate whether the subscriber is opted in.
alternate name: interests
domain: Member
range: Interests Record

stats
type: Property
comment: Engagement and e-commerce summary for the subscriber.
alternate name: stats
domain: Member
range: Member Stats

ip signup
type: Property
comment: IP address recorded at signup.
alternate name: ip_signup
sub property of: ip signup
domain: Member
range: string

ip opt
type: Property
comment: IP address recorded at confirmed opt-in.
alternate name: ip_opt
sub property of: ip opt
domain: Member
range: string

timestamp signup
type: Property
comment: Timestamp recorded at signup.
alternate name: timestamp_signup
sub property of: timestamp signup
sub property of: dateCreated
domain: Member
range: dateTime

timestamp opt
type: Property
comment: Timestamp recorded at confirmed opt-in.
alternate name: timestamp_opt
sub property of: timestamp opt
domain: Member
range: dateTime

member rating
type: Property
comment: Mailchimp-assigned engagement rating from 1 (lowest) to 5 (highest).
alternate name: member_rating
sub property of: member rating
domain: Member
range: int

last changed
type: Property
comment: Timestamp of the most recent change to the subscriber record.
alternate name: last_changed
sub property of: last changed
sub property of: dateModified
domain: Member
range: dateTime

language
type: Property
comment: Subscriber language code (e.g. `en`, `es`).
alternate name: language
sub property of: language
sub property of: inLanguage
domain: Member
range: string

vip
type: Property
comment: Whether the subscriber is flagged as a VIP for the account.
alternate name: vip
sub property of: vip
domain: Member
range: boolean

email client
type: Property
comment: Inferred email client (`Apple Mail`, `Gmail`, etc.).
alternate name: email_client
sub property of: email client
domain: Member
range: string

location
type: Property
comment: Approximate geographic location resolved from the subscriber's IP.
alternate name: location
sub property of: contentLocation
domain: Member
range: Member Location

marketing permissions
type: Property
comment: GDPR marketing-permission flags. One entry per permission defined on the parent list.
alternate name: marketing_permissions
domain: Member
range: Member Marketing Permission

last note
type: Property
comment: Most recent note attached to the subscriber.
alternate name: last_note
sub property of: last note
domain: Member
range: Member Last Note

source
type: Property
comment: Acquisition source (e.g. signup form, API, import).
alternate name: source
sub property of: source
domain: Member
range: string

tags count
type: Property
comment: Number of tags currently applied to the subscriber.
alternate name: tags_count
sub property of: tags count
domain: Member
range: int

tags
type: Property
comment: Tag associations for the subscriber. Each `id` references a `Tag` on the parent list.
alternate name: tags
sub property of: keywords
domain: Member
range: Member Tag

list id
type: Property
comment: Parent list that owns the subscriber.
alternate name: list_id
sub property of: list id
domain: Member
range: List

links
type: Property
comment: HATEOAS link descriptors for related resources.
alternate name: _links
sub property of: links
domain: Member
range: HALLink

id
type: Property
comment: Tag identifier within the parent list.
alternate name: id
domain: Member Tag
range: Tag

name
type: Property
comment: Tag display name.
alternate name: name
sub property of: name
domain: Member Tag
range: string

id
type: Property
comment: Integer tag identifier scoped to the parent list.
alternate name: id
domain: Tag
range: int

name
type: Property
comment: Display name of the tag.
alternate name: name
sub property of: name
domain: Tag
range: string

match
type: Property
comment: Whether condition rows are combined with logical OR (`any`) or AND (`all`).
alternate name: match
sub property of: match
domain: Segment Options
range: string
code list: SegmentMatch

conditions
type: Property
comment: Polymorphic condition rows; variant is keyed by `conditionType`.
alternate name: conditions
sub property of: conditions
domain: Segment Options
range: Segment Condition

id
type: Property
comment: Integer segment identifier scoped to the parent list.
alternate name: id
domain: Segment
range: int

name
type: Property
comment: Display name of the segment.
alternate name: name
sub property of: name
domain: Segment
range: string

member count
type: Property
comment: Cached count of subscribers matching the segment predicate.
alternate name: member_count
sub property of: member count
sub property of: numberOfItems
domain: Segment
range: int

type
type: Property
comment: Segment kind.
alternate name: type
domain: Segment
range: string
code list: SegmentType

created at
type: Property
comment: Timestamp when the segment was created.
alternate name: created_at
sub property of: created at
sub property of: dateCreated
domain: Segment
range: dateTime

updated at
type: Property
comment: Timestamp of the most recent edit.
alternate name: updated_at
sub property of: updated at
sub property of: dateModified
domain: Segment
range: dateTime

options
type: Property
comment: Predicate definition. Absent on `static` and `fuzzy` segments.
alternate name: options
domain: Segment
range: Segment Options

list id
type: Property
comment: Parent list that owns the segment.
alternate name: list_id
sub property of: list id
domain: Segment
range: List

links
type: Property
comment: HATEOAS link descriptors for related resources.
alternate name: _links
sub property of: links
domain: Segment
range: HALLink

default country
type: Property
comment: Numeric Mailchimp country code applied as the default for `address` merge fields.
alternate name: default_country
sub property of: default country
domain: Merge Field Options
range: int

phone format
type: Property
comment: Phone-number format applied to `phone` merge fields.
alternate name: phone_format
sub property of: phone format
domain: Merge Field Options
range: string
code list: MergeFieldPhoneFormat

date format
type: Property
comment: Date format string for `date` and `birthday` merge fields (e.g. `MM/DD/YYYY`).
alternate name: date_format
sub property of: date format
domain: Merge Field Options
range: string

choices
type: Property
comment: Enumerated choices for `radio` and `dropdown` merge fields.
alternate name: choices
sub property of: choices
domain: Merge Field Options
range: string

size
type: Property
comment: Input width hint for `text` and `number` merge fields.
alternate name: size
sub property of: size
domain: Merge Field Options
range: int

merge id
type: Property
comment: Integer merge-field identifier scoped to the parent list.
alternate name: merge_id
sub property of: merge id
domain: Merge Field
range: int

tag
type: Property
comment: Merge tag used in campaign content (e.g. `FNAME`, `LNAME`, `EMAIL`).
alternate name: tag
sub property of: tag
domain: Merge Field
range: string

name
type: Property
comment: Display name shown in the Mailchimp admin UI and on forms.
alternate name: name
sub property of: name
domain: Merge Field
range: string

type
type: Property
comment: Data type of the merge field.
alternate name: type
domain: Merge Field
range: string
code list: MergeFieldType

required
type: Property
comment: Whether the merge field is required on signup.
alternate name: required
sub property of: required
sub property of: valueRequired
domain: Merge Field
range: boolean

default value
type: Property
comment: Default value applied when the subscriber does not supply one.
alternate name: default_value
sub property of: default value
sub property of: defaultValue
domain: Merge Field
range: string

public
type: Property
comment: Whether the merge field is shown on the public signup form.
alternate name: public
sub property of: public
domain: Merge Field
range: boolean

display order
type: Property
comment: Position of the merge field within the list's form.
alternate name: display_order
sub property of: display order
domain: Merge Field
range: int

options
type: Property
comment: Type-specific configuration options. Populated keys depend on `type`.
alternate name: options
domain: Merge Field
range: Merge Field Options

help text
type: Property
comment: Helper text rendered under the merge field on signup forms.
alternate name: help_text
sub property of: help text
sub property of: description
domain: Merge Field
range: string

list id
type: Property
comment: Parent list that owns the merge field.
alternate name: list_id
sub property of: list id
domain: Merge Field
range: List

links
type: Property
comment: HATEOAS link descriptors for related resources.
alternate name: _links
sub property of: links
domain: Merge Field
range: HALLink

merge id
type: Property
comment: Integer merge-field identifier scoped to the parent list.
alternate name: merge_id
sub property of: merge id
domain: Merge Field Post Response
range: int

tag
type: Property
comment: Merge tag used in campaign content (e.g. `FNAME`, `LNAME`, `EMAIL`).
alternate name: tag
sub property of: tag
domain: Merge Field Post Response
range: string

name
type: Property
comment: Display name shown in the Mailchimp admin UI and on forms.
alternate name: name
sub property of: name
domain: Merge Field Post Response
range: string

type
type: Property
comment: Data type of the merge field.
alternate name: type
domain: Merge Field Post Response
range: string
code list: MergeFieldType

required
type: Property
comment: Whether the merge field is required on signup.
alternate name: required
sub property of: required
sub property of: valueRequired
domain: Merge Field Post Response
range: boolean

default value
type: Property
comment: Default value applied when the subscriber does not supply one.
alternate name: default_value
sub property of: default value
sub property of: defaultValue
domain: Merge Field Post Response
range: string

public
type: Property
comment: Whether the merge field is shown on the public signup form.
alternate name: public
sub property of: public
domain: Merge Field Post Response
range: boolean

display order
type: Property
comment: Position of the merge field within the list's form.
alternate name: display_order
sub property of: display order
domain: Merge Field Post Response
range: int

options
type: Property
comment: Type-specific configuration options. Populated keys depend on `type`.
alternate name: options
domain: Merge Field Post Response
range: Merge Field Options

help text
type: Property
comment: Helper text rendered under the merge field on signup forms.
alternate name: help_text
sub property of: help text
sub property of: description
domain: Merge Field Post Response
range: string

list id
type: Property
comment: Parent list that owns the merge field.
alternate name: list_id
sub property of: list id
domain: Merge Field Post Response
range: List

links
type: Property
comment: HATEOAS link descriptors for related resources.
alternate name: _links
sub property of: links
domain: Merge Field Post Response
range: HALLink

total items
type: Property
comment: Total merge fields defined for the parent list after this insert.
alternate name: total_items
sub property of: total items
domain: Merge Field Post Response
range: int

merge field limit
type: Property
comment: Account-level cap on merge fields per list.
alternate name: merge_field_limit
sub property of: merge field limit
domain: Merge Field Post Response
range: int

id
type: Property
comment: Campaign ID. Opaque string assigned by Mailchimp.
alternate name: id
sub property of: identifier
domain: Campaign
range: string

web id
type: Property
comment: Display ID used in the Mailchimp web UI; not an entity reference
alternate name: web_id
sub property of: web id
domain: Campaign
range: int

parent campaign id
type: Property
comment: Parent campaign ID for RSS/automation child campaigns; self-reference
alternate name: parent_campaign_id
sub property of: parent campaign id
sub property of: isPartOf
domain: Campaign
range: Campaign

type
type: Property
comment: Campaign type (regular, plaintext, absplit, rss, variate)
alternate name: type
domain: Campaign
range: string
code list: CampaignType

create time
type: Property
comment: Timestamp when the campaign was created
alternate name: create_time
sub property of: create time
sub property of: dateCreated
domain: Campaign
range: dateTime

archive url
type: Property
comment: Public archive URL for the campaign
alternate name: archive_url
sub property of: archive url
sub property of: url
domain: Campaign
range: anyURI

long archive url
type: Property
comment: Long-form public archive URL for the campaign
alternate name: long_archive_url
sub property of: long archive url
domain: Campaign
range: string

status
type: Property
comment: Campaign lifecycle status
alternate name: status
domain: Campaign
range: string
code list: CampaignStatus

emails sent
type: Property
comment: Total number of emails sent
alternate name: emails_sent
sub property of: emails sent
sub property of: numberOfItems
domain: Campaign
range: int

send time
type: Property
comment: Timestamp when the campaign was sent
alternate name: send_time
sub property of: datePublished
domain: Campaign
range: dateTime

content type
type: Property
comment: Source of the campaign content
alternate name: content_type
sub property of: content type
domain: Campaign
range: string
code list: CampaignContentType

needs block refresh
type: Property
comment: Deprecated; always false in current responses
alternate name: needs_block_refresh
sub property of: needs block refresh
domain: Campaign
range: boolean

resendable
type: Property
comment: Whether this campaign is eligible to be resent
alternate name: resendable
sub property of: resendable
domain: Campaign
range: boolean

recipients
type: Property
comment: Recipient targeting for the campaign
alternate name: recipients
sub property of: audience
domain: Campaign
range: Campaign Recipients

settings
type: Property
comment: Campaign settings (subject, from, content options)
alternate name: settings
domain: Campaign
range: Campaign Settings

variate settings
type: Property
comment: Variate (multivariate) test configuration; present when type is variate
alternate name: variate_settings
sub property of: variate settings
domain: Campaign
range: Variate Settings

tracking
type: Property
comment: Open/click/ecommerce tracking flags; see common CampaignTracking
alternate name: tracking
sub property of: tracking
domain: Campaign
range: Campaign Tracking

rss opts
type: Property
comment: RSS feed options; present when type is rss
alternate name: rss_opts
sub property of: rss opts
domain: Campaign
range: Rss Opts

ab split opts
type: Property
comment: Deprecated legacy A/B split test options. Mailchimp no longer authors classic A/B from the API; use `Campaigns.VariateSettings` for multivariate tests.
alternate name: ab_split_opts
sub property of: ab split opts
domain: Campaign
range: ABSplit Opts

social card
type: Property
comment: Social-card preview image, title, and description
alternate name: social_card
sub property of: social card
domain: Campaign
range: Social Card

report summary
type: Property
comment: Per-campaign report summary; see common ReportSummary
alternate name: report_summary
sub property of: report summary
domain: Campaign
range: Report Summary

delivery status
type: Property
comment: Delivery status; see common DeliveryStatus
alternate name: delivery_status
sub property of: delivery status
domain: Campaign
range: Delivery Status

resend shortcut eligibility
type: Property
comment: Eligibility flags for the four resend-shortcut variants
alternate name: resend_shortcut_eligibility
sub property of: resend shortcut eligibility
domain: Campaign
range: Resend Shortcut Eligibility

resend shortcut usage
type: Property
comment: Records of resend-shortcut campaigns spawned from this campaign
alternate name: resend_shortcut_usage
sub property of: resend shortcut usage
domain: Campaign
range: Resend Shortcut Usage

links
type: Property
comment: HATEOAS links for the campaign resource
alternate name: _links
sub property of: links
domain: Campaign
range: HALLink

list id
type: Property
comment: Audience (list) ID this campaign sends to
alternate name: list_id
sub property of: list id
sub property of: audience
domain: Campaign Recipients
range: List

list is active
type: Property
comment: Whether the target audience is currently active
alternate name: list_is_active
sub property of: list is active
domain: Campaign Recipients
range: boolean

list name
type: Property
comment: Display name of the target audience
alternate name: list_name
sub property of: list name
sub property of: name
domain: Campaign Recipients
range: string

segment text
type: Property
comment: HTML description of the targeted segment
alternate name: segment_text
sub property of: segment text
sub property of: description
domain: Campaign Recipients
range: string

recipient count
type: Property
comment: Number of recipients targeted by this campaign
alternate name: recipient_count
sub property of: recipient count
sub property of: numberOfItems
domain: Campaign Recipients
range: int

segment opts
type: Property
comment: Segment options applied to the audience
alternate name: segment_opts
domain: Campaign Recipients
range: Campaign Segment Opts

saved segment id
type: Property
comment: Saved segment ID (integer variant)
alternate name: saved_segment_id
sub property of: saved segment id
domain: Campaign Segment Opts
range: Segment

prebuilt segment id
type: Property
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.
alternate name: prebuilt_segment_id
sub property of: prebuilt segment id
sub property of: identifier
domain: Campaign Segment Opts
range: string

match
type: Property
comment: Whether all or any conditions must match
alternate name: match
sub property of: match
domain: Campaign Segment Opts
range: string
code list: SegmentMatchMode

conditions
type: Property
comment: Segment conditions (polymorphic, discriminator condition_type). Promoted to shared SegmentCondition base model in common.tsp.
alternate name: conditions
sub property of: conditions
domain: Campaign Segment Opts
range: Segment Condition

subject line
type: Property
comment: Subject line shown in the recipient's inbox
alternate name: subject_line
domain: Campaign Settings
range: string

preview text
type: Property
comment: Preview snippet rendered in inbox clients alongside the subject
alternate name: preview_text
sub property of: preview text
sub property of: abstract
domain: Campaign Settings
range: string

title
type: Property
comment: Internal title of the campaign (not shown to recipients)
alternate name: title
sub property of: title
sub property of: name
domain: Campaign Settings
range: string

from name
type: Property
comment: Display name shown in the From header
alternate name: from_name
domain: Campaign Settings
range: string

reply to
type: Property
comment: Reply-to email address
alternate name: reply_to
domain: Campaign Settings
range: string

use conversation
type: Property
comment: Whether to enable Mailchimp Conversation for inbound replies
alternate name: use_conversation
sub property of: use conversation
domain: Campaign Settings
range: boolean

to name
type: Property
comment: Recipient name expression (merge-tag aware)
alternate name: to_name
sub property of: to name
domain: Campaign Settings
range: string

folder id
type: Property
comment: Campaign folder ID. Dangling Ref<CampaignFolder>; CampaignFolder entity not in v1.
alternate name: folder_id
sub property of: folder id
sub property of: identifier
domain: Campaign Settings
range: string

authenticate
type: Property
comment: Whether the campaign is authenticated (DKIM/SPF)
alternate name: authenticate
sub property of: authenticate
domain: Campaign Settings
range: boolean

auto footer
type: Property
comment: Whether the default Mailchimp footer is automatically appended
alternate name: auto_footer
sub property of: auto footer
domain: Campaign Settings
range: boolean

inline css
type: Property
comment: Whether CSS is inlined automatically on send
alternate name: inline_css
sub property of: inline css
domain: Campaign Settings
range: boolean

auto tweet
type: Property
comment: Whether the campaign auto-tweets when sent
alternate name: auto_tweet
sub property of: auto tweet
domain: Campaign Settings
range: boolean

auto fb post
type: Property
comment: Facebook page IDs to auto-post the campaign to
alternate name: auto_fb_post
sub property of: auto fb post
domain: Campaign Settings
range: string

fb comments
type: Property
comment: Whether Facebook comments are enabled on the campaign
alternate name: fb_comments
sub property of: fb comments
domain: Campaign Settings
range: boolean

timewarp
type: Property
comment: Whether Timewarp delivery is enabled
alternate name: timewarp
domain: Campaign Settings
range: boolean

template id
type: Property
comment: Template ID used to construct the campaign content. Dangling Ref<Template>; Template entity not in v1.
alternate name: template_id
sub property of: template id
domain: Campaign Settings
range: int

drag and drop
type: Property
comment: Whether the campaign was built with the drag-and-drop editor
alternate name: drag_and_drop
sub property of: drag and drop
domain: Campaign Settings
range: boolean

google analytics
type: Property
comment: Google Analytics campaign name (max 50 bytes)
alternate name: google_analytics
sub property of: google analytics
domain: Campaign Settings
range: string

clicktale
type: Property
comment: Clicktale campaign name (max 50 bytes)
alternate name: clicktale
sub property of: clicktale
domain: Campaign Settings
range: string

winning combination id
type: Property
comment: ID of the combination chosen as the variate winner
alternate name: winning_combination_id
sub property of: winning combination id
sub property of: identifier
domain: Variate Settings
range: string

winning campaign id
type: Property
comment: ID of the campaign sent to the remaining audience after a variate winner is selected
alternate name: winning_campaign_id
sub property of: winning campaign id
domain: Variate Settings
range: Campaign

winner criteria
type: Property
comment: Criterion used to pick the variate winner
alternate name: winner_criteria
sub property of: winner criteria
domain: Variate Settings
range: string
code list: VariateWinnerCriteria

wait time
type: Property
comment: Wait time before evaluating variate combinations
alternate name: wait_time
sub property of: wait time
domain: Variate Settings
range: int

test size
type: Property
comment: Fraction of the audience used for the variate test
alternate name: test_size
sub property of: test size
domain: Variate Settings
range: int

subject lines
type: Property
comment: Subject lines tested in this variate campaign
alternate name: subject_lines
sub property of: subject lines
domain: Variate Settings
range: string

send times
type: Property
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[].
alternate name: send_times
sub property of: send times
domain: Variate Settings
range: string

from names
type: Property
comment: From names tested in this variate campaign
alternate name: from_names
sub property of: from names
domain: Variate Settings
range: string

reply to addresses
type: Property
comment: Reply-to addresses tested in this variate campaign
alternate name: reply_to_addresses
sub property of: reply to addresses
domain: Variate Settings
range: string

contents
type: Property
comment: Content blocks tested in this variate campaign
alternate name: contents
sub property of: contents
domain: Variate Settings
range: string

combinations
type: Property
comment: Resolved variate combinations and their per-arm metrics
alternate name: combinations
sub property of: combinations
domain: Variate Settings
range: Variate Combination

id
type: Property
comment: Unique ID for this variate combination
alternate name: id
sub property of: identifier
domain: Variate Combination
range: string

subject line
type: Property
comment: Array index into Campaign.variateSettings.subject_lines; NOT a Ref.
alternate name: subject_line
domain: Variate Combination
range: int

send time
type: Property
comment: Array index into Campaign.variateSettings.send_times; NOT a Ref.
alternate name: send_time
domain: Variate Combination
range: int

from name
type: Property
comment: Array index into Campaign.variateSettings.from_names; NOT a Ref.
alternate name: from_name
domain: Variate Combination
range: int

reply to
type: Property
comment: Array index into Campaign.variateSettings.reply_to_addresses; NOT a Ref.
alternate name: reply_to
domain: Variate Combination
range: int

content description
type: Property
comment: Array index into Campaign.variateSettings.contents; NOT a Ref.
alternate name: content_description
sub property of: content description
domain: Variate Combination
range: int

recipients
type: Property
comment: Array index recording which recipient slice received this combination; NOT a Ref.
alternate name: recipients
domain: Variate Combination
range: int

feed url
type: Property
comment: RSS feed URL polled to drive the campaign
alternate name: feed_url
sub property of: feed url
sub property of: url
domain: Rss Opts
range: anyURI

frequency
type: Property
comment: Polling cadence for the RSS feed
alternate name: frequency
sub property of: frequency
domain: Rss Opts
range: string
code list: RssFrequency

schedule
type: Property
comment: Detailed schedule controlling when the feed is polled
alternate name: schedule
sub property of: schedule
sub property of: eventSchedule
domain: Rss Opts
range: Rss Schedule

last sent
type: Property
comment: Timestamp of the most recent RSS send
alternate name: last_sent
sub property of: last sent
domain: Rss Opts
range: dateTime

constrain rss img
type: Property
comment: Whether to constrain RSS images to the template width
alternate name: constrain_rss_img
sub property of: constrain rss img
domain: Rss Opts
range: boolean

hour
type: Property
comment: Hour of the day to send (0-23)
alternate name: hour
sub property of: hour
domain: Rss Schedule
range: int

daily send
type: Property
comment: Per-day enable flags for daily RSS sends
alternate name: daily_send
sub property of: daily send
domain: Rss Schedule
range: Rss Daily Send

weekly send day
type: Property
comment: Day of the week to send for weekly RSS campaigns
alternate name: weekly_send_day
sub property of: weekly send day
domain: Rss Schedule
range: string
code list: DayOfWeek

monthly send date
type: Property
comment: Day of the month to send for monthly RSS campaigns (0-31; 0 means the last day of the month)
alternate name: monthly_send_date
sub property of: monthly send date
domain: Rss Schedule
range: double

sunday
type: Property
comment: Send on Sundays
alternate name: sunday
sub property of: sunday
domain: Rss Daily Send
range: boolean

monday
type: Property
comment: Send on Mondays
alternate name: monday
sub property of: monday
domain: Rss Daily Send
range: boolean

tuesday
type: Property
comment: Send on Tuesdays
alternate name: tuesday
sub property of: tuesday
domain: Rss Daily Send
range: boolean

wednesday
type: Property
comment: Send on Wednesdays
alternate name: wednesday
sub property of: wednesday
domain: Rss Daily Send
range: boolean

thursday
type: Property
comment: Send on Thursdays
alternate name: thursday
sub property of: thursday
domain: Rss Daily Send
range: boolean

friday
type: Property
comment: Send on Fridays
alternate name: friday
sub property of: friday
domain: Rss Daily Send
range: boolean

saturday
type: Property
comment: Send on Saturdays
alternate name: saturday
sub property of: saturday
domain: Rss Daily Send
range: boolean

split test
type: Property
comment: Which campaign attribute is being split-tested
alternate name: split_test
sub property of: split test
domain: ABSplit Opts
range: string
code list: ABSplitTest

pick winner
type: Property
comment: How the winning variant is selected
alternate name: pick_winner
sub property of: pick winner
domain: ABSplit Opts
range: string
code list: ABSplitPickWinner

wait units
type: Property
comment: Unit used for waitTime before evaluating the winner
alternate name: wait_units
sub property of: wait units
domain: ABSplit Opts
range: string
code list: ABSplitWaitUnits

wait time
type: Property
comment: Time to wait before evaluating the winner
alternate name: wait_time
sub property of: wait time
domain: ABSplit Opts
range: int

split size
type: Property
comment: Percentage of the audience used for the test split
alternate name: split_size
sub property of: split size
domain: ABSplit Opts
range: int

from name a
type: Property
comment: From name used for variant A
alternate name: from_name_a
sub property of: from name a
domain: ABSplit Opts
range: string

from name b
type: Property
comment: From name used for variant B
alternate name: from_name_b
sub property of: from name b
domain: ABSplit Opts
range: string

reply email a
type: Property
comment: Reply-to email used for variant A
alternate name: reply_email_a
sub property of: reply email a
domain: ABSplit Opts
range: string

reply email b
type: Property
comment: Reply-to email used for variant B
alternate name: reply_email_b
sub property of: reply email b
domain: ABSplit Opts
range: string

subject a
type: Property
comment: Subject line used for variant A
alternate name: subject_a
sub property of: subject a
domain: ABSplit Opts
range: string

subject b
type: Property
comment: Subject line used for variant B
alternate name: subject_b
sub property of: subject b
domain: ABSplit Opts
range: string

send time a
type: Property
comment: Send time for variant A
alternate name: send_time_a
sub property of: send time a
domain: ABSplit Opts
range: dateTime

send time b
type: Property
comment: Send time for variant B
alternate name: send_time_b
sub property of: send time b
domain: ABSplit Opts
range: dateTime

send time winner
type: Property
comment: Send time for the winning variant. Local-clock string, not ISO 8601; deliberately string rather than utcDateTime.
alternate name: send_time_winner
sub property of: send time winner
domain: ABSplit Opts
range: string

image url
type: Property
comment: Image URL used for the social-card preview
alternate name: image_url
sub property of: image url
sub property of: image
domain: Social Card
range: anyURI

description
type: Property
comment: Social-card description text
alternate name: description
sub property of: description
domain: Social Card
range: string

title
type: Property
comment: Social-card title
alternate name: title
sub property of: title
sub property of: name
domain: Social Card
range: string

to non openers
type: Property
comment: Eligibility for resending to non-openers
alternate name: to_non_openers
sub property of: to non openers
domain: Resend Shortcut Eligibility
range: Resend Eligibility Entry

to new subscribers
type: Property
comment: Eligibility for resending to new subscribers
alternate name: to_new_subscribers
sub property of: to new subscribers
domain: Resend Shortcut Eligibility
range: Resend Eligibility Entry

to non clickers
type: Property
comment: Eligibility for resending to non-clickers
alternate name: to_non_clickers
sub property of: to non clickers
domain: Resend Shortcut Eligibility
range: Resend Eligibility Entry

to non purchasers
type: Property
comment: Eligibility for resending to non-purchasers
alternate name: to_non_purchasers
sub property of: to non purchasers
domain: Resend Shortcut Eligibility
range: Resend Eligibility Entry

is eligible
type: Property
comment: Whether this shortcut is eligible to be triggered
alternate name: is_eligible
sub property of: is eligible
domain: Resend Eligibility Entry
range: boolean

reason
type: Property
comment: Reason explaining why this shortcut is or is not eligible
alternate name: reason
sub property of: reason
sub property of: description
domain: Resend Eligibility Entry
range: string

shortcut campaigns
type: Property
comment: Campaigns generated from resend shortcuts on this original campaign
alternate name: shortcut_campaigns
sub property of: shortcut campaigns
domain: Resend Shortcut Usage
range: Shortcut Campaign

original campaign
type: Property
comment: Original campaign that produced these resend shortcuts
alternate name: original_campaign
sub property of: original campaign
domain: Resend Shortcut Usage
range: Original Shortcut Campaign

id
type: Property
comment: Resend campaign ID
alternate name: id
domain: Shortcut Campaign
range: Campaign

web id
type: Property
comment: Display ID used in the Mailchimp web UI; not an entity reference
alternate name: web_id
sub property of: web id
domain: Shortcut Campaign
range: int

shortcut type
type: Property
comment: Resend shortcut variant used to generate this campaign
alternate name: shortcut_type
sub property of: shortcut type
domain: Shortcut Campaign
range: string
code list: ResendShortcutType

send time
type: Property
comment: Send time of the resend campaign
alternate name: send_time
sub property of: datePublished
domain: Shortcut Campaign
range: dateTime

status
type: Property
comment: Lifecycle status of the resend campaign
alternate name: status
domain: Shortcut Campaign
range: string
code list: CampaignStatus

id
type: Property
comment: Original campaign ID
alternate name: id
domain: Original Shortcut Campaign
range: Campaign

web id
type: Property
comment: Display ID used in the Mailchimp web UI; not an entity reference
alternate name: web_id
sub property of: web id
domain: Original Shortcut Campaign
range: int

title
type: Property
comment: Internal title of the original campaign
alternate name: title
sub property of: title
sub property of: name
domain: Original Shortcut Campaign
range: string

shortcut type
type: Property
comment: Resend shortcut variant used
alternate name: shortcut_type
sub property of: shortcut type
domain: Original Shortcut Campaign
range: string
code list: ResendShortcutType

id
type: Property
comment: Campaign report ID. Equal to the corresponding Campaign.id verbatim (1:1 keying). Acts as @key for this entity AND as Ref<Campaign>.
alternate name: id
domain: Campaign Report
range: Campaign

campaign title
type: Property
comment: Title of the source campaign
alternate name: campaign_title
sub property of: campaign title
sub property of: name
domain: Campaign Report
range: string

type
type: Property
comment: Campaign report type. Wire formats differ from Campaign.type (hyphen/underscore drift; extra `automation` and `auto` values).
alternate name: type
domain: Campaign Report
range: string
code list: CampaignReportType

list id
type: Property
comment: Audience (list) the source campaign sent to
alternate name: list_id
sub property of: list id
sub property of: audience
domain: Campaign Report
range: List

list is active
type: Property
comment: Whether the target audience is currently active
alternate name: list_is_active
sub property of: list is active
domain: Campaign Report
range: boolean

list name
type: Property
comment: Display name of the target audience
alternate name: list_name
sub property of: list name
domain: Campaign Report
range: string

subject line
type: Property
comment: Subject line of the source campaign
alternate name: subject_line
domain: Campaign Report
range: string

preview text
type: Property
comment: Preview text of the source campaign
alternate name: preview_text
sub property of: preview text
sub property of: abstract
domain: Campaign Report
range: string

emails sent
type: Property
comment: Total number of emails sent
alternate name: emails_sent
sub property of: emails sent
sub property of: numberOfItems
domain: Campaign Report
range: int

abuse reports
type: Property
comment: Total number of abuse reports
alternate name: abuse_reports
sub property of: abuse reports
domain: Campaign Report
range: int

unsubscribed
type: Property
comment: Total number of unsubscribes
alternate name: unsubscribed
sub property of: unsubscribed
domain: Campaign Report
range: int

send time
type: Property
comment: Timestamp when the campaign was sent
alternate name: send_time
sub property of: datePublished
domain: Campaign Report
range: dateTime

rss last send
type: Property
comment: Timestamp of the most recent RSS send for RSS campaigns
alternate name: rss_last_send
sub property of: rss last send
domain: Campaign Report
range: dateTime

bounces
type: Property
comment: Bounce breakdown
alternate name: bounces
domain: Campaign Report
range: Bounces

forwards
type: Property
comment: Forward counts
alternate name: forwards
domain: Campaign Report
range: Forwards

opens
type: Property
comment: Open counts, rates, and last-open timestamp
alternate name: opens
domain: Campaign Report
range: Opens

clicks
type: Property
comment: Click counts, rates, and last-click timestamp
alternate name: clicks
domain: Campaign Report
range: Clicks

facebook likes
type: Property
comment: Facebook likes attributable to the campaign
alternate name: facebook_likes
domain: Campaign Report
range: Facebook Likes

industry stats
type: Property
comment: Industry benchmark rates
alternate name: industry_stats
sub property of: industry stats
domain: Campaign Report
range: Industry Stats

list stats
type: Property
comment: Audience-level rate snapshot
alternate name: list_stats
sub property of: list stats
domain: Campaign Report
range: Report List Stats

ab split
type: Property
comment: Legacy A/B split test arm metrics
alternate name: ab_split
sub property of: ab split
domain: Campaign Report
range: ABSplit Result

timewarp
type: Property
comment: Per-timezone Timewarp delivery slices
alternate name: timewarp
domain: Campaign Report
range: Timewarp Entry

timeseries
type: Property
comment: Send/open/click counts bucketed over time
alternate name: timeseries
sub property of: timeseries
domain: Campaign Report
range: Timeseries Entry

share report
type: Property
comment: Shareable URL and password for the campaign report
alternate name: share_report
sub property of: share report
domain: Campaign Report
range: Share Report

ecommerce
type: Property
comment: Ecommerce totals attributed to the campaign
alternate name: ecommerce
domain: Campaign Report
range: Ecommerce

delivery status
type: Property
comment: Delivery status; see common DeliveryStatus
alternate name: delivery_status
sub property of: delivery status
domain: Campaign Report
range: Delivery Status

links
type: Property
comment: HATEOAS links for the campaign report resource
alternate name: _links
sub property of: links
domain: Campaign Report
range: HALLink

hard bounces
type: Property
comment: Number of hard bounces
alternate name: hard_bounces
sub property of: hard bounces
domain: Bounces
range: int

soft bounces
type: Property
comment: Number of soft bounces
alternate name: soft_bounces
sub property of: soft bounces
domain: Bounces
range: int

syntax errors
type: Property
comment: Number of syntax errors in recipient addresses
alternate name: syntax_errors
sub property of: syntax errors
domain: Bounces
range: int

forwards count
type: Property
comment: Number of times the campaign was forwarded
alternate name: forwards_count
sub property of: forwards count
domain: Forwards
range: int

forwards opens
type: Property
comment: Number of opens generated by forwarded copies
alternate name: forwards_opens
sub property of: forwards opens
domain: Forwards
range: int

opens total
type: Property
comment: Total number of opens (including proxy opens)
alternate name: opens_total
sub property of: opens total
domain: Opens
range: int

proxy excluded opens
type: Property
comment: Total opens excluding privacy-proxy-generated opens
alternate name: proxy_excluded_opens
sub property of: proxy excluded opens
domain: Opens
range: int

unique opens
type: Property
comment: Number of unique recipients who opened the campaign
alternate name: unique_opens
sub property of: unique opens
domain: Opens
range: int

proxy excluded unique opens
type: Property
comment: Unique opens excluding privacy-proxy-generated opens
alternate name: proxy_excluded_unique_opens
sub property of: proxy excluded unique opens
domain: Opens
range: int

open rate
type: Property
comment: Open rate (opens / emails sent)
alternate name: open_rate
sub property of: open rate
domain: Opens
range: double

proxy excluded open rate
type: Property
comment: Open rate excluding privacy-proxy-generated opens
alternate name: proxy_excluded_open_rate
sub property of: proxy excluded open rate
domain: Opens
range: double

last open
type: Property
comment: Timestamp of the most recent open
alternate name: last_open
domain: Opens
range: dateTime

clicks total
type: Property
comment: Total number of clicks
alternate name: clicks_total
sub property of: clicks total
domain: Clicks
range: int

unique clicks
type: Property
comment: Number of unique clicks
alternate name: unique_clicks
sub property of: unique clicks
domain: Clicks
range: int

unique subscriber clicks
type: Property
comment: Number of unique subscribers who clicked
alternate name: unique_subscriber_clicks
sub property of: unique subscriber clicks
domain: Clicks
range: int

click rate
type: Property
comment: Click rate (clicks / emails sent)
alternate name: click_rate
sub property of: click rate
domain: Clicks
range: double

last click
type: Property
comment: Timestamp of the most recent click
alternate name: last_click
sub property of: last click
domain: Clicks
range: dateTime

recipient likes
type: Property
comment: Number of likes from recipients of this campaign
alternate name: recipient_likes
sub property of: recipient likes
domain: Facebook Likes
range: int

unique likes
type: Property
comment: Number of unique users who liked the campaign on Facebook
alternate name: unique_likes
sub property of: unique likes
domain: Facebook Likes
range: int

facebook likes
type: Property
comment: Total Facebook likes attributed to the campaign
alternate name: facebook_likes
domain: Facebook Likes
range: int

type
type: Property
comment: Industry segment label
alternate name: type
sub property of: category
domain: Industry Stats
range: string

open rate
type: Property
comment: Industry-average open rate
alternate name: open_rate
sub property of: open rate
domain: Industry Stats
range: double

click rate
type: Property
comment: Industry-average click rate
alternate name: click_rate
sub property of: click rate
domain: Industry Stats
range: double

bounce rate
type: Property
comment: Industry-average bounce rate
alternate name: bounce_rate
sub property of: bounce rate
domain: Industry Stats
range: double

unopen rate
type: Property
comment: Industry-average unopen rate
alternate name: unopen_rate
sub property of: unopen rate
domain: Industry Stats
range: double

unsub rate
type: Property
comment: Industry-average unsubscribe rate
alternate name: unsub_rate
sub property of: unsub rate
domain: Industry Stats
range: double

abuse rate
type: Property
comment: Industry-average abuse-report rate
alternate name: abuse_rate
sub property of: abuse rate
domain: Industry Stats
range: double

sub rate
type: Property
comment: Audience subscribe rate
alternate name: sub_rate
sub property of: sub rate
domain: Report List Stats
range: double

unsub rate
type: Property
comment: Audience unsubscribe rate
alternate name: unsub_rate
sub property of: unsub rate
domain: Report List Stats
range: double

open rate
type: Property
comment: Audience open rate
alternate name: open_rate
sub property of: open rate
domain: Report List Stats
range: double

proxy excluded open rate
type: Property
comment: Audience open rate excluding privacy-proxy-generated opens
alternate name: proxy_excluded_open_rate
sub property of: proxy excluded open rate
domain: Report List Stats
range: double

click rate
type: Property
comment: Audience click rate
alternate name: click_rate
sub property of: click rate
domain: Report List Stats
range: double

a
type: Property
comment: Metrics for variant A
alternate name: a
sub property of: a
domain: ABSplit Result
range: ABSplit Arm

b
type: Property
comment: Metrics for variant B
alternate name: b
sub property of: b
domain: ABSplit Result
range: ABSplit Arm

bounces
type: Property
comment: Number of bounces for this arm
alternate name: bounces
domain: ABSplit Arm
range: int

abuse reports
type: Property
comment: Number of abuse reports for this arm
alternate name: abuse_reports
sub property of: abuse reports
domain: ABSplit Arm
range: int

unsubs
type: Property
comment: Number of unsubscribes for this arm
alternate name: unsubs
sub property of: unsubs
domain: ABSplit Arm
range: int

recipient clicks
type: Property
comment: Total recipient clicks for this arm
alternate name: recipient_clicks
sub property of: recipient clicks
domain: ABSplit Arm
range: int

forwards
type: Property
comment: Number of forwards for this arm
alternate name: forwards
domain: ABSplit Arm
range: int

forwards opens
type: Property
comment: Number of opens from forwarded copies for this arm
alternate name: forwards_opens
sub property of: forwards opens
domain: ABSplit Arm
range: int

opens
type: Property
comment: Number of opens for this arm
alternate name: opens
domain: ABSplit Arm
range: int

unique opens
type: Property
comment: Number of unique opens for this arm
alternate name: unique_opens
sub property of: unique opens
domain: ABSplit Arm
range: int

last open
type: Property
comment: Timestamp of the last open in this arm. The spec does not declare a datetime format on this field; deliberately string.
alternate name: last_open
domain: ABSplit Arm
range: string

gmt offset
type: Property
comment: GMT offset (in hours) for this delivery slice
alternate name: gmt_offset
sub property of: gmt offset
domain: Timewarp Entry
range: int

opens
type: Property
comment: Number of opens in this slice
alternate name: opens
domain: Timewarp Entry
range: int

unique opens
type: Property
comment: Number of unique opens in this slice
alternate name: unique_opens
sub property of: unique opens
domain: Timewarp Entry
range: int

clicks
type: Property
comment: Number of clicks in this slice
alternate name: clicks
domain: Timewarp Entry
range: int

unique clicks
type: Property
comment: Number of unique clicks in this slice
alternate name: unique_clicks
sub property of: unique clicks
domain: Timewarp Entry
range: int

bounces
type: Property
comment: Number of bounces in this slice
alternate name: bounces
domain: Timewarp Entry
range: int

last open
type: Property
comment: Timestamp of the last open in this slice
alternate name: last_open
domain: Timewarp Entry
range: dateTime

last click
type: Property
comment: Timestamp of the last click in this slice
alternate name: last_click
sub property of: last click
domain: Timewarp Entry
range: dateTime

timestamp
type: Property
comment: Timestamp marking the start of this time-series bucket
alternate name: timestamp
sub property of: timestamp
sub property of: startTime
domain: Timeseries Entry
range: dateTime

emails sent
type: Property
comment: Number of emails sent during this bucket
alternate name: emails_sent
sub property of: emails sent
domain: Timeseries Entry
range: int

unique opens
type: Property
comment: Number of unique opens recorded during this bucket
alternate name: unique_opens
sub property of: unique opens
domain: Timeseries Entry
range: int

proxy excluded unique opens
type: Property
comment: Unique opens during this bucket excluding privacy-proxy-generated opens
alternate name: proxy_excluded_unique_opens
sub property of: proxy excluded unique opens
domain: Timeseries Entry
range: int

recipients clicks
type: Property
comment: Number of recipient clicks during this bucket
alternate name: recipients_clicks
sub property of: recipients clicks
domain: Timeseries Entry
range: int

share url
type: Property
comment: Shareable URL for the campaign report
alternate name: share_url
sub property of: share url
sub property of: url
domain: Share Report
range: anyURI

share password
type: Property
comment: Password protecting the share URL
alternate name: share_password
sub property of: share password
domain: Share Report
range: string

total orders
type: Property
comment: Total ecommerce orders attributed to the campaign
alternate name: total_orders
sub property of: total orders
sub property of: numberOfItems
domain: Ecommerce
range: int

total spent
type: Property
comment: Total spent by attributed orders
alternate name: total_spent
sub property of: total spent
domain: Ecommerce
range: double

total revenue
type: Property
comment: Total revenue attributed to the campaign
alternate name: total_revenue
sub property of: total revenue
domain: Ecommerce
range: double

currency code
type: Property
comment: ISO 4217 currency code for the ecommerce totals
alternate name: currency_code
sub property of: currency code
sub property of: priceCurrency
domain: Ecommerce
range: string

id
type: Property
comment: Opaque automation workflow ID.
alternate name: id
sub property of: identifier
domain: Automation
range: string

create time
type: Property
comment: Timestamp when the workflow was created.
alternate name: create_time
sub property of: create time
sub property of: dateCreated
domain: Automation
range: dateTime

start time
type: Property
comment: Timestamp when the workflow was last started (set to sending).
alternate name: start_time
sub property of: start time
sub property of: startTime
domain: Automation
range: dateTime

status
type: Property
comment: Lifecycle state of the workflow.
alternate name: status
domain: Automation
range: string
code list: AutomationStatus

emails sent
type: Property
comment: Total emails dispatched across all steps of the workflow.
alternate name: emails_sent
sub property of: emails sent
sub property of: numberOfItems
domain: Automation
range: int

recipients
type: Property
comment: Recipient targeting (parent list and optional segment).
alternate name: recipients
domain: Automation
range: Automation Recipients

settings
type: Property
comment: Sender, footer, and content toggles applied to every step.
alternate name: settings
domain: Automation
range: Automation Settings

tracking
type: Property
comment: Engagement-tracking toggles shared with regular campaigns.
alternate name: tracking
sub property of: tracking
domain: Automation
range: Campaign Tracking

trigger settings
type: Property
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.
alternate name: trigger_settings
sub property of: trigger settings
domain: Automation
range: Trigger Settings

report summary
type: Property
comment: Aggregate engagement summary (without the e-commerce sub-block).
alternate name: report_summary
sub property of: report summary
domain: Automation
range: Report Summary

links
type: Property
comment: HATEOAS link descriptors for this resource.
alternate name: _links
sub property of: links
domain: Automation
range: HALLink

list id
type: Property
comment: Parent audience the workflow runs against.
alternate name: list_id
sub property of: list id
sub property of: audience
domain: Automation Recipients
range: List

list is active
type: Property
comment: Whether the parent list is currently active.
alternate name: list_is_active
sub property of: list is active
domain: Automation Recipients
range: boolean

list name
type: Property
comment: Display name of the parent list.
alternate name: list_name
sub property of: list name
sub property of: name
domain: Automation Recipients
range: string

segment opts
type: Property
comment: Segment definition narrowing the recipient set.
alternate name: segment_opts
domain: Automation Recipients
range: Automation Segment Opts

store id
type: Property
comment: Connected store ID. Dangling Ref<Store>; not in v1.
alternate name: store_id
sub property of: store id
sub property of: identifier
domain: Automation Recipients
range: string

saved segment id
type: Property
comment: Saved-segment integer ID referenced by this automation.
alternate name: saved_segment_id
sub property of: saved segment id
domain: Automation Segment Opts
range: Segment

match
type: Property
comment: Combinator across `conditions`.
alternate name: match
sub property of: match
domain: Automation Segment Opts
range: string
code list: AutomationSegmentMatch

conditions
type: Property
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.
alternate name: conditions
sub property of: conditions
domain: Automation Segment Opts
range: Segment Condition

title
type: Property
comment: Internal title shown in the Mailchimp UI.
alternate name: title
sub property of: title
sub property of: name
domain: Automation Settings
range: string

from name
type: Property
comment: Display "from" name presented to recipients.
alternate name: from_name
domain: Automation Settings
range: string

reply to
type: Property
comment: Reply-to address attached to every send in the workflow.
alternate name: reply_to
domain: Automation Settings
range: string

to name
type: Property
comment: Personalised "to" name template (e.g. `*|FNAME|*`).
alternate name: to_name
sub property of: to name
domain: Automation Settings
range: string

use conversation
type: Property
comment: Convert replies to recipients into a Mailchimp Conversation thread.
alternate name: use_conversation
sub property of: use conversation
domain: Automation Settings
range: boolean

authenticate
type: Property
comment: Apply Mailchimp's authentication (SPF/DKIM) on outbound mail.
alternate name: authenticate
sub property of: authenticate
domain: Automation Settings
range: boolean

auto footer
type: Property
comment: Append the standard Mailchimp footer to the body.
alternate name: auto_footer
sub property of: auto footer
domain: Automation Settings
range: boolean

inline css
type: Property
comment: Inline CSS on send to maximise email-client compatibility.
alternate name: inline_css
sub property of: inline css
domain: Automation Settings
range: boolean

workflow type
type: Property
comment: Built-in workflow recipe selected for this automation. Required by the Mailchimp spec.
alternate name: workflow_type
sub property of: workflow type
domain: Trigger Settings
range: string
code list: AutomationWorkflowType

workflow title
type: Property
comment: Display title of the workflow recipe.
alternate name: workflow_title
sub property of: workflow title
sub property of: name
domain: Trigger Settings
range: string

runtime
type: Property
comment: Schedule constraints restricting when the workflow fires.
alternate name: runtime
sub property of: runtime
domain: Trigger Settings
range: Automation Runtime

workflow emails count
type: Property
comment: Count of email steps configured under this workflow.
alternate name: workflow_emails_count
sub property of: workflow emails count
sub property of: numberOfItems
domain: Trigger Settings
range: int

days
type: Property
comment: Weekdays on which the workflow may fire. Empty array means the trigger fires on any day.
alternate name: days
sub property of: days
domain: Automation Runtime
range: string
code list: AutomationRuntimeDay

hours
type: Property
comment: Daily run-window configuration.
alternate name: hours
sub property of: hours
domain: Automation Runtime
range: Automation Runtime Hours

type
type: Property
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`.
alternate name: type
domain: Automation Runtime Hours
range: string
code list: AutomationRuntimeHoursType

emails
type: Property
comment: Per-recipient activity envelopes for this campaign.
alternate name: emails
sub property of: emails
sub property of: recipient
domain: Email Activity
range: Email Activity Recipient

campaign id
type: Property
comment: Parent campaign the report belongs to.
alternate name: campaign_id
sub property of: campaign id
domain: Email Activity
range: Campaign

list id
type: Property
comment: Parent audience the campaign sent to.
alternate name: list_id
sub property of: list id
sub property of: audience
domain: Email Activity
range: List

total items
type: Property
comment: Total recipient rows available across all pages.
alternate name: total_items
sub property of: total items
sub property of: numberOfItems
domain: Email Activity
range: int

links
type: Property
comment: HATEOAS link descriptors for this report.
alternate name: _links
sub property of: links
domain: Email Activity
range: HALLink

campaign id
type: Property
comment: Parent campaign this activity row belongs to.
alternate name: campaign_id
sub property of: campaign id
domain: Email Activity Recipient
range: Campaign

list id
type: Property
comment: Parent audience the recipient is subscribed to.
alternate name: list_id
sub property of: list id
sub property of: audience
domain: Email Activity Recipient
range: List

list is active
type: Property
comment: Whether the parent list is currently active.
alternate name: list_is_active
sub property of: list is active
domain: Email Activity Recipient
range: boolean

email id
type: Property
comment: Member subscriber-hash (MD5 of the lowercased email address) — same value as `Member.id`. Used to join activity back to the Member resource.
alternate name: email_id
sub property of: email id
domain: Email Activity Recipient
range: Member

email address
type: Property
comment: Recipient email address.
alternate name: email_address
sub property of: email address
sub property of: email
domain: Email Activity Recipient
range: string

activity
type: Property
comment: Chronological list of per-action events for this recipient. Capped at 1000 opens + 1000 clicks per recipient per campaign.
alternate name: activity
sub property of: activity
domain: Email Activity Recipient
range: Email Activity Entry

action
type: Property
comment: Which action this row records.
alternate name: action
sub property of: action
domain: Email Activity Entry
range: string
code list: EmailActivityAction

type
type: Property
comment: Bounce sub-classification. Set only when `action == bounce`.
alternate name: type
domain: Email Activity Entry
range: string
code list: EmailActivityBounceType

timestamp
type: Property
comment: Timestamp at which the action was recorded.
alternate name: timestamp
sub property of: timestamp
sub property of: startTime
domain: Email Activity Entry
range: dateTime

url
type: Property
comment: Destination URL of the click. Set only when `action == click`.
alternate name: url
sub property of: target
domain: Email Activity Entry
range: anyURI

ip
type: Property
comment: Originating IP address. Best-effort; may be empty for proxy opens.
alternate name: ip
sub property of: ip
domain: Email Activity Entry
range: string

id
type: Property
comment: Opaque webhook subscription ID assigned by Mailchimp on create.
alternate name: id
sub property of: identifier
domain: List Webhook
range: string

url
type: Property
comment: Callback URL Mailchimp POSTs form-encoded events to.
alternate name: url
sub property of: target
domain: List Webhook
range: anyURI

events
type: Property
comment: Event-type subscription mask (subscribe, unsubscribe, profile, upemail, cleaned, campaign).
alternate name: events
sub property of: events
domain: List Webhook
range: Webhook Events

sources
type: Property
comment: Origin-source filter mask (user, admin, api).
alternate name: sources
sub property of: sources
domain: List Webhook
range: Webhook Sources

list id
type: Property
comment: Parent audience the webhook is attached to.
alternate name: list_id
sub property of: list id
sub property of: audience
domain: List Webhook
range: List

links
type: Property
comment: HATEOAS link descriptors for this resource.
alternate name: _links
sub property of: links
domain: List Webhook
range: HALLink

subscribe
type: Property
comment: Deliver a callback when a subscriber opts in.
alternate name: subscribe
sub property of: subscribe
domain: Webhook Events
range: boolean

unsubscribe
type: Property
comment: Deliver a callback when a subscriber opts out.
alternate name: unsubscribe
sub property of: unsubscribe
domain: Webhook Events
range: boolean

profile
type: Property
comment: Deliver a callback when a subscriber's profile (merge fields) changes.
alternate name: profile
sub property of: profile
domain: Webhook Events
range: boolean

upemail
type: Property
comment: Deliver a callback when a subscriber changes their email address.
alternate name: upemail
sub property of: upemail
domain: Webhook Events
range: boolean

cleaned
type: Property
comment: Deliver a callback when an address is cleaned (bounced/removed).
alternate name: cleaned
sub property of: cleaned
domain: Webhook Events
range: boolean

campaign
type: Property
comment: Deliver a callback when a campaign send completes.
alternate name: campaign
sub property of: campaign
domain: Webhook Events
range: boolean

user
type: Property
comment: Deliver events triggered by the subscriber themselves.
alternate name: user
sub property of: user
domain: Webhook Sources
range: boolean

admin
type: Property
comment: Deliver events triggered by operators inside the Mailchimp UI.
alternate name: admin
sub property of: admin
domain: Webhook Sources
range: boolean

api
type: Property
comment: Deliver events triggered programmatically through the API.
alternate name: api
sub property of: api
domain: Webhook Sources
range: boolean

id
type: Property
comment: Opaque Interest ID. Appears as the key in `Member.interests`.
alternate name: id
sub property of: identifier
domain: Interest
range: string

name
type: Property
comment: Display name shown in subscribe forms and the admin UI.
alternate name: name
sub property of: name
domain: Interest
range: string

category id
type: Property
comment: Parent interest category that groups this interest.
alternate name: category_id
sub property of: category id
sub property of: isPartOf
domain: Interest
range: Interest Category

id
type: Property
comment: Opaque interest-category ID.
alternate name: id
sub property of: identifier
domain: Interest Category
range: string

list id
type: Property
comment: Parent list that owns the interest category.
alternate name: list_id
sub property of: list id
sub property of: audience
domain: Interest Category
range: List

title
type: Property
comment: Display title shown above the interest checkboxes.
alternate name: title
sub property of: title
sub property of: name
domain: Interest Category
range: string

type
type: Property
comment: Presentation style for the category on subscribe forms.
alternate name: type
domain: Interest Category
range: string
code list: InterestCategoryType

lists
type: Property
comment: Audiences in the current page.
alternate name: lists
sub property of: lists
domain: List List Response
range: List

total items
type: Property
comment: Total number of audiences on the account (across all pages).
alternate name: total_items
sub property of: total items
domain: List List Response
range: int

constraints
type: Property
comment: Per-account audience-count limits applied to this response.
alternate name: constraints
sub property of: constraints
domain: List List Response
range: Constraints Record

links
type: Property
comment: HATEOAS link descriptors for the collection.
alternate name: _links
sub property of: links
domain: List List Response
range: HALLink

members
type: Property
comment: Member descriptors to subscribe, update, or unsubscribe in bulk.
alternate name: members
domain: List Batch Members Input
range: Members Record

sync tags
type: Property
comment: Replace each member's tag set with the tags supplied in the payload.
alternate name: sync_tags
sub property of: sync tags
domain: List Batch Members Input
range: boolean

update existing
type: Property
comment: Update members already on the list instead of skipping duplicates.
alternate name: update_existing
sub property of: update existing
domain: List Batch Members Input
range: boolean

new members
type: Property
comment: Members created by this batch.
alternate name: new_members
sub property of: new members
domain: List Batch Members Response
range: New Members Record

updated members
type: Property
comment: Members updated by this batch.
alternate name: updated_members
sub property of: updated members
domain: List Batch Members Response
range: Updated Members Record

errors
type: Property
comment: Per-row error reports for rejected members.
alternate name: errors
domain: List Batch Members Response
range: Errors

total created
type: Property
comment: Number of members created in this batch.
alternate name: total_created
sub property of: total created
domain: List Batch Members Response
range: int

total updated
type: Property
comment: Number of members updated in this batch.
alternate name: total_updated
sub property of: total updated
domain: List Batch Members Response
range: int

error count
type: Property
comment: Number of members rejected by this batch.
alternate name: error_count
sub property of: error count
domain: List Batch Members Response
range: int

list id
type: Property
comment: Parent audience identifier.
alternate name: list_id
sub property of: list id
domain: List Batch Members Response
range: List

name
type: Property
comment: Human-readable audience name.
alternate name: name
sub property of: name
domain: List Input
range: string

contact
type: Property
comment: Audience postal contact information shown in campaign footers (CAN-SPAM).
alternate name: contact
sub property of: contact
domain: List Input
range: List Contact

permission reminder
type: Property
comment: Permission reminder displayed at the bottom of campaigns sent to this audience.
alternate name: permission_reminder
sub property of: permission reminder
domain: List Input
range: string

use archive bar
type: Property
comment: Show the Mailchimp archive bar in campaigns sent to this audience.
alternate name: use_archive_bar
sub property of: use archive bar
domain: List Input
range: boolean

campaign defaults
type: Property
comment: Default `from_name`, `from_email`, `subject`, and `language` for new campaigns.
alternate name: campaign_defaults
sub property of: campaign defaults
domain: List Input
range: List Campaign Defaults

notify on subscribe
type: Property
comment: Email address that receives notifications when someone subscribes.
alternate name: notify_on_subscribe
sub property of: notify on subscribe
domain: List Input
range: string

notify on unsubscribe
type: Property
comment: Email address that receives notifications when someone unsubscribes.
alternate name: notify_on_unsubscribe
sub property of: notify on unsubscribe
domain: List Input
range: string

email type option
type: Property
comment: Allow subscribers to choose between HTML and plain-text emails.
alternate name: email_type_option
sub property of: email type option
domain: List Input
range: boolean

double optin
type: Property
comment: Require subscribers to confirm via opt-in email.
alternate name: double_optin
sub property of: double optin
domain: List Input
range: boolean

marketing permissions
type: Property
comment: Surface GDPR-style marketing permissions on the signup form.
alternate name: marketing_permissions
domain: List Input
range: boolean

members
type: Property
comment: Members in the current page.
alternate name: members
domain: Member List Response
range: Member

list id
type: Property
comment: Parent audience identifier.
alternate name: list_id
sub property of: list id
domain: Member List Response
range: List

total items
type: Property
comment: Total number of members on the audience (unfiltered by pagination).
alternate name: total_items
sub property of: total items
domain: Member List Response
range: int

links
type: Property
comment: HATEOAS link descriptors for the collection.
alternate name: _links
sub property of: links
domain: Member List Response
range: HALLink

email address
type: Property
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.
alternate name: email_address
sub property of: email address
domain: Member Create Input
range: string

email type
type: Property
comment: Preferred email format.
alternate name: email_type
sub property of: email type
domain: Member Create Input
range: string
code list: MemberEmailType

status
type: Property
comment: Initial subscription status (`subscribed`, `pending`, `unsubscribed`, `cleaned`, `transactional`).
alternate name: status
domain: Member Create Input
range: string
code list: MemberStatus

merge fields
type: Property
comment: Map of merge-tag names to scalar values (e.g. `FNAME`, `LNAME`).
alternate name: merge_fields
domain: Member Create Input
range: Merge Fields Record

interests
type: Property
comment: Map of interest IDs to boolean subscription flags.
alternate name: interests
domain: Member Create Input
range: Interests Record

language
type: Property
comment: Subscriber language code (ISO 639-1).
alternate name: language
sub property of: language
domain: Member Create Input
range: string

vip
type: Property
comment: Designate the subscriber as VIP.
alternate name: vip
sub property of: vip
domain: Member Create Input
range: boolean

location
type: Property
comment: Subscriber geo location (`latitude`, `longitude`).
alternate name: location
domain: Member Create Input
range: Location Record

marketing permissions
type: Property
comment: Per-permission consent records (GDPR-style).
alternate name: marketing_permissions
domain: Member Create Input
range: Marketing Permissions Record

ip signup
type: Property
comment: Source IP recorded at signup.
alternate name: ip_signup
sub property of: ip signup
domain: Member Create Input
range: string

timestamp signup
type: Property
comment: Signup timestamp.
alternate name: timestamp_signup
sub property of: timestamp signup
domain: Member Create Input
range: dateTime

ip opt
type: Property
comment: Source IP recorded at confirmed opt-in.
alternate name: ip_opt
sub property of: ip opt
domain: Member Create Input
range: string

timestamp opt
type: Property
comment: Confirmed opt-in timestamp.
alternate name: timestamp_opt
sub property of: timestamp opt
domain: Member Create Input
range: dateTime

tags
type: Property
comment: Tag names to apply at create time. Mailchimp creates missing tags.
alternate name: tags
domain: Member Create Input
range: string

email address
type: Property
comment: Member email address. Required only when upserting a new member.
alternate name: email_address
sub property of: email address
domain: Member Upsert Input
range: string

status if new
type: Property
comment: Status to assign when the member does not yet exist on the audience.
alternate name: status_if_new
sub property of: status if new
domain: Member Upsert Input
range: string

email type
type: Property
comment: Preferred email format.
alternate name: email_type
sub property of: email type
domain: Member Upsert Input
range: string
code list: MemberEmailType

status
type: Property
comment: Current subscription status. Ignored when creating a new member (use `status_if_new`).
alternate name: status
domain: Member Upsert Input
range: string

merge fields
type: Property
comment: Map of merge-tag names to scalar values.
alternate name: merge_fields
domain: Member Upsert Input
range: Merge Fields Record

interests
type: Property
comment: Map of interest IDs to boolean subscription flags.
alternate name: interests
domain: Member Upsert Input
range: Interests Record

language
type: Property
comment: Subscriber language code (ISO 639-1).
alternate name: language
sub property of: language
domain: Member Upsert Input
range: string

vip
type: Property
comment: Designate the subscriber as VIP.
alternate name: vip
sub property of: vip
domain: Member Upsert Input
range: boolean

location
type: Property
comment: Subscriber geo location (`latitude`, `longitude`).
alternate name: location
domain: Member Upsert Input
range: Location Record

marketing permissions
type: Property
comment: Per-permission consent records (GDPR-style).
alternate name: marketing_permissions
domain: Member Upsert Input
range: Marketing Permissions Record

ip signup
type: Property
comment: Source IP recorded at signup.
alternate name: ip_signup
sub property of: ip signup
domain: Member Upsert Input
range: string

timestamp signup
type: Property
comment: Signup timestamp.
alternate name: timestamp_signup
sub property of: timestamp signup
domain: Member Upsert Input
range: dateTime

ip opt
type: Property
comment: Source IP recorded at confirmed opt-in.
alternate name: ip_opt
sub property of: ip opt
domain: Member Upsert Input
range: string

timestamp opt
type: Property
comment: Confirmed opt-in timestamp.
alternate name: timestamp_opt
sub property of: timestamp opt
domain: Member Upsert Input
range: dateTime

email address
type: Property
comment: New email address. Updates the subscriber identity.
alternate name: email_address
sub property of: email address
domain: Member Patch Input
range: string

email type
type: Property
alternate name: email_type
sub property of: email type
domain: Member Patch Input
range: string
code list: MemberEmailType

status
type: Property
comment: Current subscription status.
alternate name: status
domain: Member Patch Input
range: string

merge fields
type: Property
alternate name: merge_fields
domain: Member Patch Input
range: Merge Fields Record

interests
type: Property
alternate name: interests
domain: Member Patch Input
range: Interests Record

language
type: Property
alternate name: language
sub property of: language
domain: Member Patch Input
range: string

vip
type: Property
alternate name: vip
sub property of: vip
domain: Member Patch Input
range: boolean

location
type: Property
alternate name: location
domain: Member Patch Input
range: Location Record

marketing permissions
type: Property
alternate name: marketing_permissions
domain: Member Patch Input
range: Marketing Permissions Record

ip signup
type: Property
alternate name: ip_signup
sub property of: ip signup
domain: Member Patch Input
range: string

timestamp signup
type: Property
alternate name: timestamp_signup
sub property of: timestamp signup
domain: Member Patch Input
range: dateTime

ip opt
type: Property
alternate name: ip_opt
sub property of: ip opt
domain: Member Patch Input
range: string

timestamp opt
type: Property
alternate name: timestamp_opt
sub property of: timestamp opt
domain: Member Patch Input
range: dateTime

id
type: Property
comment: Numeric tag identifier scoped to the parent list.
alternate name: id
domain: Member Tag Assignment
range: int

name
type: Property
comment: Tag display name.
alternate name: name
sub property of: name
domain: Member Tag Assignment
range: string

date added
type: Property
comment: When this tag was applied to the member.
alternate name: date_added
sub property of: date added
domain: Member Tag Assignment
range: dateTime

tags
type: Property
comment: Tags currently applied to the member.
alternate name: tags
domain: Member Tags Response
range: Member Tag Assignment

total items
type: Property
comment: Total number of tags applied to the member.
alternate name: total_items
sub property of: total items
domain: Member Tags Response
range: int

tags
type: Property
comment: Tag mutations to apply. Each row names a tag and an action.
alternate name: tags
domain: Member Tags Mutate Input
range: Tags

is syncing
type: Property
comment: Treat the call as part of a background sync to suppress some side effects.
alternate name: is_syncing
sub property of: is syncing
domain: Member Tags Mutate Input
range: boolean

segments
type: Property
comment: Segments in the current page.
alternate name: segments
sub property of: segments
domain: Segment List Response
range: Segment

list id
type: Property
comment: Parent audience identifier.
alternate name: list_id
sub property of: list id
domain: Segment List Response
range: List

total items
type: Property
comment: Total number of segments defined on the audience.
alternate name: total_items
sub property of: total items
domain: Segment List Response
range: int

links
type: Property
comment: HATEOAS link descriptors for the collection.
alternate name: _links
sub property of: links
domain: Segment List Response
range: HALLink

name
type: Property
comment: Display name of the segment.
alternate name: name
sub property of: name
domain: Segment Input
range: string

static segment
type: Property
comment: Seed emails for a static segment. Unknown emails are created on the audience as transactional.
alternate name: static_segment
sub property of: static segment
domain: Segment Input
range: string

options
type: Property
comment: Saved-segment condition tree (`match` plus an array of `conditions`).
alternate name: options
domain: Segment Input
range: Options Record

members to add
type: Property
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.
alternate name: members_to_add
sub property of: members to add
domain: Segment Batch Members Input
range: string

members to remove
type: Property
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.
alternate name: members_to_remove
sub property of: members to remove
domain: Segment Batch Members Input
range: string

members added
type: Property
comment: Members successfully added by this batch.
alternate name: members_added
sub property of: members added
domain: Segment Batch Members Response
range: Members Added Record

members removed
type: Property
comment: Members successfully removed by this batch.
alternate name: members_removed
sub property of: members removed
domain: Segment Batch Members Response
range: Members Removed Record

errors
type: Property
comment: Per-row error reports for rejected emails.
alternate name: errors
domain: Segment Batch Members Response
range: Errors

total added
type: Property
alternate name: total_added
sub property of: total added
domain: Segment Batch Members Response
range: int

total removed
type: Property
alternate name: total_removed
sub property of: total removed
domain: Segment Batch Members Response
range: int

error count
type: Property
alternate name: error_count
sub property of: error count
domain: Segment Batch Members Response
range: int

tags
type: Property
comment: Tags matching the search query, ordered by relevance.
alternate name: tags
domain: Tag Search Response
range: Tag

total items
type: Property
comment: Total number of matching tags across all pages.
alternate name: total_items
sub property of: total items
domain: Tag Search Response
range: int

merge fields
type: Property
comment: Merge fields in the current page.
alternate name: merge_fields
domain: Merge Field List Response
range: Merge Field

list id
type: Property
comment: Parent audience identifier.
alternate name: list_id
sub property of: list id
domain: Merge Field List Response
range: List

total items
type: Property
comment: Total number of merge fields defined on the audience.
alternate name: total_items
sub property of: total items
domain: Merge Field List Response
range: int

links
type: Property
comment: HATEOAS link descriptors for the collection.
alternate name: _links
sub property of: links
domain: Merge Field List Response
range: HALLink

tag
type: Property
comment: Merge tag short code used inside campaigns (e.g. `FNAME`). Auto-generated when omitted.
alternate name: tag
sub property of: tag
domain: Merge Field Create Input
range: string

name
type: Property
comment: Human-readable merge field name.
alternate name: name
sub property of: name
domain: Merge Field Create Input
range: string

type
type: Property
comment: Merge field data type.
alternate name: type
domain: Merge Field Create Input
range: string
code list: MergeFieldType

required
type: Property
comment: Whether subscribers must supply a value for this field.
alternate name: required
sub property of: required
domain: Merge Field Create Input
range: boolean

default value
type: Property
comment: Default value substituted when the field is empty.
alternate name: default_value
sub property of: default value
domain: Merge Field Create Input
range: string

public
type: Property
comment: Surface the field on hosted signup forms.
alternate name: public
sub property of: public
domain: Merge Field Create Input
range: boolean

display order
type: Property
comment: Position of the field on hosted signup forms.
alternate name: display_order
sub property of: display order
domain: Merge Field Create Input
range: int

options
type: Property
comment: Type-specific options (e.g. `choices` for `dropdown`, `format` for `date`).
alternate name: options
domain: Merge Field Create Input
range: Options Record

help text
type: Property
comment: Helper text shown beside the field on signup forms.
alternate name: help_text
sub property of: help text
domain: Merge Field Create Input
range: string

tag
type: Property
comment: Merge tag short code (e.g. `FNAME`).
alternate name: tag
sub property of: tag
domain: Merge Field Update Input
range: string

name
type: Property
comment: Human-readable merge field name.
alternate name: name
sub property of: name
domain: Merge Field Update Input
range: string

required
type: Property
comment: Whether subscribers must supply a value for this field.
alternate name: required
sub property of: required
domain: Merge Field Update Input
range: boolean

default value
type: Property
comment: Default value substituted when the field is empty.
alternate name: default_value
sub property of: default value
domain: Merge Field Update Input
range: string

public
type: Property
comment: Surface the field on hosted signup forms.
alternate name: public
sub property of: public
domain: Merge Field Update Input
range: boolean

display order
type: Property
comment: Position of the field on hosted signup forms.
alternate name: display_order
sub property of: display order
domain: Merge Field Update Input
range: int

options
type: Property
comment: Type-specific options.
alternate name: options
domain: Merge Field Update Input
range: Options Record

help text
type: Property
comment: Helper text shown beside the field on signup forms.
alternate name: help_text
sub property of: help text
domain: Merge Field Update Input
range: string

campaigns
type: Property
comment: Campaigns in the current page.
alternate name: campaigns
sub property of: campaigns
domain: Campaign List Response
range: Campaign

total items
type: Property
comment: Total number of campaigns on the account.
alternate name: total_items
sub property of: total items
domain: Campaign List Response
range: int

links
type: Property
comment: HATEOAS link descriptors for the collection.
alternate name: _links
sub property of: links
domain: Campaign List Response
range: HALLink

type
type: Property
comment: Campaign type. One of `regular`, `plaintext`, `absplit`, `rss`, `variate`.
alternate name: type
domain: Campaign Create Input
range: string
code list: CampaignType

recipients
type: Property
comment: Recipient settings: `list_id` and optional segment options.
alternate name: recipients
domain: Campaign Create Input
range: Campaign Recipients

settings
type: Property
comment: Campaign settings: subject line, from name, from email, reply-to, etc.
alternate name: settings
domain: Campaign Create Input
range: Campaign Settings

variate settings
type: Property
comment: A/B variate settings. Only used when `type = variate`.
alternate name: variate_settings
sub property of: variate settings
domain: Campaign Create Input
range: Variate Settings

tracking
type: Property
comment: Engagement-tracking toggles (opens, clicks, GA, etc.).
alternate name: tracking
sub property of: tracking
domain: Campaign Create Input
range: Campaign Tracking

rss opts
type: Property
comment: RSS feed settings. Only used when `type = rss`.
alternate name: rss_opts
sub property of: rss opts
domain: Campaign Create Input
range: Rss Opts

social card
type: Property
comment: Social card metadata for archive previews.
alternate name: social_card
sub property of: social card
domain: Campaign Create Input
range: Social Card

content type
type: Property
comment: Editor used to compose the campaign (`template`, `html`, `url`, `multichannel`).
alternate name: content_type
sub property of: content type
domain: Campaign Create Input
range: string
code list: CampaignContentType

recipients
type: Property
comment: Recipient settings: `list_id` and optional segment options.
alternate name: recipients
domain: Campaign Update Input
range: Campaign Recipients

settings
type: Property
comment: Campaign settings: subject line, from name, from email, reply-to, etc.
alternate name: settings
domain: Campaign Update Input
range: Campaign Settings

variate settings
type: Property
alternate name: variate_settings
sub property of: variate settings
domain: Campaign Update Input
range: Variate Settings

tracking
type: Property
comment: Engagement-tracking toggles.
alternate name: tracking
sub property of: tracking
domain: Campaign Update Input
range: Campaign Tracking

rss opts
type: Property
alternate name: rss_opts
sub property of: rss opts
domain: Campaign Update Input
range: Rss Opts

social card
type: Property
alternate name: social_card
sub property of: social card
domain: Campaign Update Input
range: Social Card

test emails
type: Property
comment: Recipients of the test send. Must be a non-empty array of email addresses.
alternate name: test_emails
sub property of: test emails
domain: Campaign Test Input
range: string

send type
type: Property
comment: Whether to send the HTML or plain-text variant.
alternate name: send_type
sub property of: send type
domain: Campaign Test Input
range: string
code list: CampaignTestSendType

schedule time
type: Property
comment: UTC ISO 8601 timestamp to schedule the campaign for delivery.
alternate name: schedule_time
sub property of: schedule time
domain: Campaign Schedule Input
range: dateTime

timewarp
type: Property
comment: Send across multiple timezones to align with each recipient's local time of day.
alternate name: timewarp
domain: Campaign Schedule Input
range: boolean

batch delivery
type: Property
comment: Trickle-send settings (`batch_count`, `batch_delay`).
alternate name: batch_delivery
sub property of: batch delivery
domain: Campaign Schedule Input
range: Batch Delivery Record

shortcut type
type: Property
comment: Which resend shortcut to use. Defaults to `to_non_openers` server-side.
alternate name: shortcut_type
sub property of: shortcut type
domain: Campaign Create Resend Input
range: string
code list: CampaignResendShortcut

automations
type: Property
comment: Workflows in the current page.
alternate name: automations
sub property of: automations
domain: Automation List Response
range: Automation

total items
type: Property
comment: Total number of classic automation workflows on the account.
alternate name: total_items
sub property of: total items
domain: Automation List Response
range: int

links
type: Property
comment: HATEOAS link descriptors for the collection.
alternate name: _links
sub property of: links
domain: Automation List Response
range: HALLink

recipients
type: Property
comment: Recipient settings: `list_id` and optional segment options.
alternate name: recipients
domain: Automation Create Input
range: Automation Recipients

settings
type: Property
comment: Workflow-level settings (`from_name`, `reply_to`, etc.).
alternate name: settings
domain: Automation Create Input
range: Automation Settings

trigger settings
type: Property
comment: Trigger configuration that fires this workflow.
alternate name: trigger_settings
sub property of: trigger settings
domain: Automation Create Input
range: Trigger Settings

webhooks
type: Property
comment: Webhooks registered on the audience.
alternate name: webhooks
sub property of: webhooks
domain: List Webhook List Response
range: List Webhook

list id
type: Property
comment: Parent audience identifier.
alternate name: list_id
sub property of: list id
domain: List Webhook List Response
range: List

links
type: Property
comment: HATEOAS link descriptors for the collection.
alternate name: _links
sub property of: links
domain: List Webhook List Response
range: HALLink

url
type: Property
comment: HTTPS URL Mailchimp will POST events to. Embed any secret token in the URL itself.
alternate name: url
domain: List Webhook Input
range: string

events
type: Property
comment: Per-event-type subscription toggles.
alternate name: events
sub property of: events
domain: List Webhook Input
range: Webhook Events

sources
type: Property
comment: Per-source subscription toggles (user/admin/api).
alternate name: sources
sub property of: sources
domain: List Webhook Input
range: Webhook Sources

email address
type: Property
alternate name: email_address
sub property of: email address
domain: Errors
range: string

error
type: Property
alternate name: error
sub property of: error
domain: Errors
range: string

error code
type: Property
alternate name: error_code
sub property of: error code
domain: Errors
range: string

name
type: Property
comment: Tag name. Mailchimp creates the tag if it does not exist.
alternate name: name
sub property of: name
domain: Tags
range: string

status
type: Property
comment: `active` to attach, `inactive` to detach.
alternate name: status
domain: Tags
range: string

email addresses
type: Property
alternate name: email_addresses
sub property of: email addresses
domain: Errors
range: string

error
type: Property
alternate name: error
sub property of: error
domain: Errors
range: string

entry
type: Property
domain: Batch Delivery Record
range: Batch Delivery Entry

key
type: Property
domain: Batch Delivery Entry
range: string

value
type: Property
domain: Batch Delivery Entry
range: JSON

entry
type: Property
domain: Members Record
range: Members Entry

key
type: Property
domain: Members Entry
range: string

value
type: Property
domain: Members Entry
range: JSON

entry
type: Property
domain: New Members Record
range: New Members Entry

key
type: Property
domain: New Members Entry
range: string

value
type: Property
domain: New Members Entry
range: JSON

entry
type: Property
domain: Updated Members Record
range: Updated Members Entry

key
type: Property
domain: Updated Members Entry
range: string

value
type: Property
domain: Updated Members Entry
range: JSON

entry
type: Property
domain: Constraints Record
range: Constraints Entry

key
type: Property
domain: Constraints Entry
range: string

value
type: Property
domain: Constraints Entry
range: JSON

entry
type: Property
domain: Interests Record
range: Interests Entry

key
type: Property
domain: Interests Entry
range: string

value
type: Property
domain: Interests Entry
range: boolean

entry
type: Property
domain: Merge Fields Record
range: Merge Fields Entry

key
type: Property
domain: Merge Fields Entry
range: string

value
type: Property
domain: Merge Fields Entry
range: JSON

entry
type: Property
domain: Interests Record
range: Interests Entry

key
type: Property
domain: Interests Entry
range: string

value
type: Property
domain: Interests Entry
range: boolean

entry
type: Property
domain: Location Record
range: Location Entry

key
type: Property
domain: Location Entry
range: string

value
type: Property
domain: Location Entry
range: JSON

entry
type: Property
domain: Marketing Permissions Record
range: Marketing Permissions Entry

key
type: Property
domain: Marketing Permissions Entry
range: string

value
type: Property
domain: Marketing Permissions Entry
range: JSON

entry
type: Property
domain: Merge Fields Record
range: Merge Fields Entry

key
type: Property
domain: Merge Fields Entry
range: string

value
type: Property
domain: Merge Fields Entry
range: JSON

entry
type: Property
domain: Interests Record
range: Interests Entry

key
type: Property
domain: Interests Entry
range: string

value
type: Property
domain: Interests Entry
range: boolean

entry
type: Property
domain: Location Record
range: Location Entry

key
type: Property
domain: Location Entry
range: string

value
type: Property
domain: Location Entry
range: JSON

entry
type: Property
domain: Marketing Permissions Record
range: Marketing Permissions Entry

key
type: Property
domain: Marketing Permissions Entry
range: string

value
type: Property
domain: Marketing Permissions Entry
range: JSON

entry
type: Property
domain: Merge Fields Record
range: Merge Fields Entry

key
type: Property
domain: Merge Fields Entry
range: string

value
type: Property
domain: Merge Fields Entry
range: JSON

entry
type: Property
domain: Interests Record
range: Interests Entry

key
type: Property
domain: Interests Entry
range: string

value
type: Property
domain: Interests Entry
range: boolean

entry
type: Property
domain: Location Record
range: Location Entry

key
type: Property
domain: Location Entry
range: string

value
type: Property
domain: Location Entry
range: JSON

entry
type: Property
domain: Marketing Permissions Record
range: Marketing Permissions Entry

key
type: Property
domain: Marketing Permissions Entry
range: string

value
type: Property
domain: Marketing Permissions Entry
range: JSON

entry
type: Property
domain: Merge Fields Record
range: Merge Fields Entry

key
type: Property
domain: Merge Fields Entry
range: string

value
type: Property
domain: Merge Fields Entry
range: JSON

entry
type: Property
domain: Options Record
range: Options Entry

key
type: Property
domain: Options Entry
range: string

value
type: Property
domain: Options Entry
range: JSON

entry
type: Property
domain: Options Record
range: Options Entry

key
type: Property
domain: Options Entry
range: string

value
type: Property
domain: Options Entry
range: JSON

entry
type: Property
domain: Members Added Record
range: Members Added Entry

key
type: Property
domain: Members Added Entry
range: string

value
type: Property
domain: Members Added Entry
range: JSON

entry
type: Property
domain: Members Removed Record
range: Members Removed Entry

key
type: Property
domain: Members Removed Entry
range: string

value
type: Property
domain: Members Removed Entry
range: JSON

entry
type: Property
domain: Options Record
range: Options Entry

key
type: Property
domain: Options Entry
range: string

value
type: Property
domain: Options Entry
range: JSON