Mailchimp

Mailchimp Metadata API

Manage custom metadata fields that can be attached to messages for tracking and filtering.

GitHub OpenAPI

Operations 4

Each operation below carries the questions people ask an LLM about it and the instructions they give an agent to run it. Generated by API Evangelist overlay

POST /metadata/list List custom message metadata fields · List metadata fields #
Ask an LLM
“Which custom metadata fields are indexed on my transactional messages?”
“Can I see the view templates set for each metadata field?”
Tell an agent
List my custom metadata fields using key {key}.
Show every indexed metadata field on the account, API key {key}.
POST /metadata/add Add a custom metadata field to index · Add metadata field #
Ask an LLM
“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?”
Tell an agent
Add a custom metadata field named {name} using key {key}.
Index new metadata field {name} with view template {view_template}, API key {key}.
POST /metadata/update Change a metadata field's view template · Update metadata field #
Ask an LLM
“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?”
Tell an agent
Set the view template of existing metadata field {name} to {view_template}, key {key}.
Update metadata field {name} to display as {view_template} using API key {key}.
POST /metadata/delete Delete a custom metadata field · Delete metadata field #
Ask an LLM
“Why does a metadata field I deleted still appear in my list for a while?”
“Can I stop indexing a custom metadata field?”
Tell an agent destructive · confirm first
Delete custom metadata field {name} using key {key}.
Stop indexing the metadata field {name}, API key {key}.

Documentation

📖
Documentation
https://mailchimp.com/developer/marketing/docs/fundamentals/
📖
APIReference
https://mailchimp.com/developer/marketing/api/
📖
GettingStarted
https://mailchimp.com/developer/marketing/guides/quick-start/
📖
Authentication
https://mailchimp.com/developer/marketing/guides/access-user-data-oauth-2/
📖
Documentation
https://mailchimp.com/developer/transactional/docs/fundamentals/
📖
GettingStarted
https://mailchimp.com/developer/transactional/guides/quick-start/
📖
Authentication
https://mailchimp.com/developer/transactional/docs/authentication-delivery/
📖
APIReference
https://mailchimp.com/developer/transactional/api/
📖
GettingStarted
https://mailchimp.com/developer/transactional/guides/send-first-email/

Specifications

⚙
OpenAPI
https://artifacts.apis.io/mailchimp/openapi/mailchimp-metadata-api-openapi.yml
⚙
AsyncAPI
https://artifacts.apis.io/mailchimp/asyncapi/mailchimp-marketing-webhooks-asyncapi.yml

Schemas & Data

📊
JSONSchema
https://artifacts.apis.io/mailchimp/json-schema/campaign.json
📊
JSONSchema
https://artifacts.apis.io/mailchimp/json-schema/audience.json
📊
JSONSchema
https://artifacts.apis.io/mailchimp/json-schema/member.json
📊
JSONSchema
https://artifacts.apis.io/mailchimp/json-schema/template.json

Other Resources

🔗
JSONLD
https://artifacts.apis.io/mailchimp/json-ld/context.jsonld
🔗
Integrations
https://mailchimp.com/developer/marketing/docs/integrations/
🔗
ErrorCodes
https://mailchimp.com/developer/marketing/docs/errors/
🔗
E-Commerce
https://mailchimp.com/developer/marketing/docs/e-commerce/
🔗
Methods and Parameters
https://mailchimp.com/developer/marketing/docs/methods-parameters/
🔗
Webhooks
https://mailchimp.com/developer/transactional/docs/webhooks/
🔗
Outbound Email
https://mailchimp.com/developer/transactional/docs/outbound-email/
🔗
Tags and Metadata
https://mailchimp.com/developer/transactional/docs/tags-metadata/

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/mailchimp:mailchimp-metadata-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

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.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

mailchimp-metadata-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  version: 1.4.1
  title: Mailchimp Transactional Metadata API
  contact:
    name: API Support
    email: apihelp@mailchimp.com
  x-permalink: https://github.com/mailchimp/mailchimp-client-lib-codegen/blob/main/spec/transactional.openapi.json
servers:
- url: https://mandrillapp.com/api/1.3
tags:
- name: Metadata
paths:
  /metadata/list:
    post:
      x-custom-config:
        methodNameCamel: list
        methodNameSnake: list
      summary: List metadata fields
      description: Get the list of custom metadata fields indexed for the account.
      operationId: postMetadataList
      tags:
      - Metadata
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                type: array
                description: the custom metadata fields for the account
                items:
                  type: object
                  description: the individual custom metadata field info
                  properties:
                    name:
                      type: string
                      description: the unique identifier of the metadata field to update
                      example: product_id
                    state:
                      type: string
                      description: the current state of the metadata field
                      enum:
                      - active
                      - delete
                      - index
                      example: active
                    view_template:
                      type: string
                      description: Mustache template to control how the metadata is rendered in your activity log
                      example: 'Product: *|product_id|*'
            application/x-php:
              schema:
                type: array
                description: the custom metadata fields for the account
                items:
                  type: object
                  description: the individual custom metadata field info
                  properties:
                    name:
                      type: string
                      description: the unique identifier of the metadata field to update
                      example: product_id
                    state:
                      type: string
                      description: the current state of the metadata field
                      enum:
                      - active
                      - delete
                      - index
                      example: active
                    view_template:
                      type: string
                      description: Mustache template to control how the metadata is rendered in your activity log
                      example: 'Product: *|product_id|*'
            application/x-yaml; charset=utf-8:
              schema:
                type: array
                description: the custom metadata fields for the account
                items:
                  type: object
                  description: the individual custom metadata field info
                  properties:
                    name:
                      type: string
                      description: the unique identifier of the metadata field to update
                      example: product_id
                    state:
                      type: string
                      description: the current state of the metadata field
                      enum:
                      - active
                      - delete
                      - index
                      example: active
                    view_template:
                      type: string
                      description: Mustache template to control how the metadata is rendered in your activity log
                      example: 'Product: *|product_id|*'
      deprecated: false
      requestBody:
        content:
          application/json:
            schema:
              type: object
              required:
              - key
              properties:
                key:
                  type: string
                  description: a valid api key
        required: true
  /metadata/add:
    post:
      x-custom-config:
        methodNameCamel: add
        methodNameSnake: add
      summary: Add metadata field
      description: Add a new custom metadata field to be indexed for the account.
      operationId: postMetadataAdd
      tags:
      - Metadata
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                type: object
                description: the information saved about the new metadata field
                properties:
                  name:
                    type: string
                    description: the unique identifier of the metadata field to update
                    example: product_id
                  state:
                    type: string
                    description: the current state of the metadata field
                    enum:
                    - active
                    - delete
                    - index
                    example: active
                  view_template:
                    type: string
                    description: Mustache template to control how the metadata is rendered in your activity log
                    example: 'Product: *|product_id|*'
            application/x-php:
              schema:
                type: object
                description: the information saved about the new metadata field
                properties:
                  name:
                    type: string
                    description: the unique identifier of the metadata field to update
                    example: product_id
                  state:
                    type: string
                    description: the current state of the metadata field
                    enum:
                    - active
                    - delete
                    - index
                    example: active
                  view_template:
                    type: string
                    description: Mustache template to control how the metadata is rendered in your activity log
                    example: 'Product: *|product_id|*'
            application/x-yaml; charset=utf-8:
              schema:
                type: object
                description: the information saved about the new metadata field
                properties:
                  name:
                    type: string
                    description: the unique identifier of the metadata field to update
                    example: product_id
                  state:
                    type: string
                    description: the current state of the metadata field
                    enum:
                    - active
                    - delete
                    - index
                    example: active
                  view_template:
                    type: string
                    description: Mustache template to control how the metadata is rendered in your activity log
                    example: 'Product: *|product_id|*'
      deprecated: false
      requestBody:
        content:
          application/json:
            schema:
              type: object
              required:
              - key
              - name
              properties:
                key:
                  type: string
                  description: a valid api key
                name:
                  type: string
                  description: a unique identifier for the metadata field
                  maxLength: 64
                view_template:
                  type: string
                  description: Mustache template to control how the metadata is rendered in your activity log
                  maxLength: 1024
        required: true
  /metadata/update:
    post:
      x-custom-config:
        methodNameCamel: update
        methodNameSnake: update
      summary: Update metadata field
      description: Update an existing custom metadata field.
      operationId: postMetadataUpdate
      tags:
      - Metadata
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                type: object
                description: the information for the updated metadata field
                properties:
                  name:
                    type: string
                    description: the unique identifier of the metadata field to update
                    example: product_id
                  state:
                    type: string
                    description: the current state of the metadata field
                    enum:
                    - active
                    - delete
                    - index
                    example: active
                  view_template:
                    type: string
                    description: Mustache template to control how the metadata is rendered in your activity log
                    example: 'Product: *|product_id|*'
            application/x-php:
              schema:
                type: object
                description: the information for the updated metadata field
                properties:
                  name:
                    type: string
                    description: the unique identifier of the metadata field to update
                    example: product_id
                  state:
                    type: string
                    description: the current state of the metadata field
                    enum:
                    - active
                    - delete
                    - index
                    example: active
                  view_template:
                    type: string
                    description: Mustache template to control how the metadata is rendered in your activity log
                    example: 'Product: *|product_id|*'
            application/x-yaml; charset=utf-8:
              schema:
                type: object
                description: the information for the updated metadata field
                properties:
                  name:
                    type: string
                    description: the unique identifier of the metadata field to update
                    example: product_id
                  state:
                    type: string
                    description: the current state of the metadata field
                    enum:
                    - active
                    - delete
                    - index
                    example: active
                  view_template:
                    type: string
                    description: Mustache template to control how the metadata is rendered in your activity log
                    example: 'Product: *|product_id|*'
      deprecated: false
      requestBody:
        content:
          application/json:
            schema:
              type: object
              required:
              - key
              - name
              - view_template
              properties:
                key:
                  type: string
                  description: a valid api key
                name:
                  type: string
                  description: the unique identifier of the metadata field to update
                view_template:
                  type: string
                  description: Mustache template to control how the metadata is rendered in your activity log
                  maxLength: 1024
        required: true
  /metadata/delete:
    post:
      x-custom-config:
        methodNameCamel: delete
        methodNameSnake: delete
      summary: Delete metadata field
      description: Delete an existing custom metadata field. Deletion isn't instataneous, and /metadata/list will continue to return the field until the asynchronous deletion process is complete.
      operationId: postMetadataDelete
      tags:
      - Metadata
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                type: object
                description: the information for the deleted metadata field
                properties:
                  name:
                    type: string
                    description: the unique identifier of the metadata field to update
                    example: product_id
                  state:
                    type: string
                    description: the current state of the metadata field
                    enum:
                    - active
                    - delete
                    - index
                    example: active
                  view_template:
                    type: string
                    description: Mustache template to control how the metadata is rendered in your activity log
                    example: 'Product: *|product_id|*'
            application/x-php:
              schema:
                type: object
                description: the information for the deleted metadata field
                properties:
                  name:
                    type: string
                    description: the unique identifier of the metadata field to update
                    example: product_id
                  state:
                    type: string
                    description: the current state of the metadata field
                    enum:
                    - active
                    - delete
                    - index
                    example: active
                  view_template:
                    type: string
                    description: Mustache template to control how the metadata is rendered in your activity log
                    example: 'Product: *|product_id|*'
            application/x-yaml; charset=utf-8:
              schema:
                type: object
                description: the information for the deleted metadata field
                properties:
                  name:
                    type: string
                    description: the unique identifier of the metadata field to update
                    example: product_id
                  state:
                    type: string
                    description: the current state of the metadata field
                    enum:
                    - active
                    - delete
                    - index
                    example: active
                  view_template:
                    type: string
                    description: Mustache template to control how the metadata is rendered in your activity log
                    example: 'Product: *|product_id|*'
      deprecated: false
      requestBody:
        content:
          application/json:
            schema:
              type: object
              required:
              - key
              - name
              properties:
                key:
                  type: string
                  description: a valid api key
                name:
                  type: string
                  description: the unique identifier of the metadata field to update
        required: true
x-doc-structure:
  resources:
    allowlists:
      title: Allowlists
      description: Add, list, or delete from your Rejection Allowlist.
      paths:
      - /allowlists/add
      - /allowlists/list
      - /allowlists/delete
    exports:
      title: Exports
      description: Start an export, or get information on export jobs in progress.
      paths:
      - /exports/info
      - /exports/list
      - /exports/rejects
      - /exports/whitelist
      - /exports/allowlist
      - /exports/activity
    inbound:
      title: Inbound
      description: Manage your inbound domains and routes.
      paths:
      - /inbound/domains
      - /inbound/add-domain
      - /inbound/check-domain
      - /inbound/delete-domain
      - /inbound/routes
      - /inbound/add-route
      - /inbound/update-route
      - /inbound/delete-route
      - /inbound/send-raw
    ips:
      title: IPs
      description: Request and manage Dedicated IPs for your account, and set up reverse DNS.
      paths:
      - /ips/list
      - /ips/info
      - /ips/provision
      - /ips/start-warmup
      - /ips/cancel-warmup
      - /ips/set-pool
      - /ips/delete
      - /ips/list-pools
      - /ips/pool-info
      - /ips/create-pool
      - /ips/delete-pool
      - /ips/check-custom-dns
      - /ips/set-custom-dns
    messages:
      title: Messages
      description: Send, schedule, or get information on your emails.
      paths:
      - /messages/send
      - /messages/send-sms
      - /messages/send-template
      - /messages/send-mc-template
      - /messages/search
      - /messages/search-time-series
      - /messages/info
      - /messages/content
      - /messages/parse
      - /messages/send-raw
      - /messages/list-scheduled
      - /messages/cancel-scheduled
      - /messages/reschedule
    metadata:
      title: Metadata
      description: Manage your custom metadata fields in your account.
      paths:
      - /metadata/list
      - /metadata/add
      - /metadata/update
      - /metadata/delete
    rejects:
      title: Rejects
      description: Add, list, or delete from your Rejection Denylist.
      paths:
      - /rejects/add
      - /rejects/add-sms
      - /rejects/delete
      - /rejects/delete-sms
      - /rejects/list
      - /rejects/list-sms
    senders:
      title: Senders
      description: Manage or get information about your sending domains.
      paths:
      - /senders/list
      - /senders/domains
      - /senders/add-domain
      - /senders/delete-domain
      - /senders/check-domain
      - /senders/verify-domain
      - /senders/info
      - /senders/time-series
    subaccounts:
      title: Subaccounts
      description: Manage your subaccounts, including the abilitiy to pause and resume sending.
      paths:
      - /subaccounts/list
      - /subaccounts/add
      - /subaccounts/info
      - /subaccounts/update
      - /subaccounts/delete
      - /subaccounts/pause
      - /subaccounts/resume
    tags:
      title: Tags
      description: List, delete, or get information on your Tags and their sending statistics.
      paths:
      - /tags/list
      - /tags/delete
      - /tags/info
      - /tags/time-series
      - /tags/all-time-series
    templates:
      title: Templates
      description: Manage templates created via the Mandrill UI or through the /templates endpoint.
      paths:
      - /templates/add
      - /templates/info
      - /templates/update
      - /templates/publish
      - /templates/delete
      - /templates/list
      - /templates/time-series
      - /templates/render
    mctemplates:
      title: Templates (MC)
      description: Manage templates created via the Mailchimp UI.
      paths:
      - /mctemplates/info
      - /mctemplates/list
      - /mctemplates/time-series
      - /mctemplates/render
    urls:
      title: URLs
      description: Manage your tracking domains.
      paths:
      - /urls/add-tracking-domain
      - /urls/check-tracking-domain
      - /urls/delete-tracking-domain
      - /urls/tracking-domains
    users:
      title: Users
      description: Get information about your account, or ping Transactional.
      paths:
      - /users/info
      - /users/ping
      - /users/ping2
      - /users/senders
    webhooks:
      title: Webhooks
      description: Manage the webhooks in your account.
      paths:
      - /webhooks/list
      - /webhooks/add
      - /webhooks/info
      - /webhooks/update
      - /webhooks/delete