Generated by API Evangelist
Written by API Evangelist tooling for Mailchimp's API. It is a proposal applied on top of the contract, not a document Mailchimp publishes.
# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
title: API Evangelist conversational phrasing for Mailchimp Transactional Metadata API
version: 1.0.0
extends: openapi/mailchimp-metadata-api-openapi.yml
actions:
- target: $.info
update:
x-apievangelist-phrasing:
method: generated
generated: '2026-09-26'
generator: build-phrasing.py
label: Generated by API Evangelist
operations: 4
- target: $.paths['/metadata/list'].post
update:
x-apievangelist-phrasing:
intent: List custom message metadata fields
effect: read
questions:
- Which custom metadata fields are indexed on my transactional messages?
- Can I see the view templates set for each metadata field?
instructions:
- text: List my custom metadata fields using key {key}.
slots:
key: requestBody.key
- text: Show every indexed metadata field on the account, API key {key}.
slots:
key: requestBody.key
method: generated
generated: '2026-09-26'
- target: $.paths['/metadata/add'].post
update:
x-apievangelist-phrasing:
intent: Add a custom metadata field to index
effect: write
questions:
- How do I start indexing a custom field like order_id on my transactional emails?
- Can I control how a new metadata field is displayed in the activity view?
instructions:
- text: Add a custom metadata field named {name} using key {key}.
slots:
name: requestBody.name
key: requestBody.key
- text: Index new metadata field {name} with view template {view_template}, API key {key}.
slots:
name: requestBody.name
view_template: requestBody.view_template
key: requestBody.key
method: generated
generated: '2026-09-26'
- target: $.paths['/metadata/update'].post
update:
x-apievangelist-phrasing:
intent: Change a metadata field's view template
effect: write
questions:
- Can I change how an existing metadata field renders in my activity log?
- What's the way to edit the display template of a metadata field I already added?
instructions:
- text: Set the view template of existing metadata field {name} to {view_template}, key {key}.
slots:
name: requestBody.name
view_template: requestBody.view_template
key: requestBody.key
- text: Update metadata field {name} to display as {view_template} using API key {key}.
slots:
name: requestBody.name
view_template: requestBody.view_template
key: requestBody.key
method: generated
generated: '2026-09-26'
- target: $.paths['/metadata/delete'].post
update:
x-apievangelist-phrasing:
intent: Delete a custom metadata field
effect: destructive
questions:
- Why does a metadata field I deleted still appear in my list for a while?
- Can I stop indexing a custom metadata field?
instructions:
- text: Delete custom metadata field {name} using key {key}.
slots:
name: requestBody.name
key: requestBody.key
- text: Stop indexing the metadata field {name}, API key {key}.
slots:
name: requestBody.name
key: requestBody.key
method: generated
generated: '2026-09-26'
Discovery needs no key. Ratings and market analysis are Pro.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we
store it to create your key and to recognise you if you sign in with another
provider. See our Privacy Policy and
Terms.