> ## Documentation Index
> Fetch the complete documentation index at: https://docs.modulex.dev/llms.txt
> Use this file to discover all available pages before exploring further.

# Mailchimp Integration for AI Agents & Workflows

> Mailchimp marketing platform: list/audience CRUD, subscriber upsert, campaign lifecycle, tags, notes, and segments.

{/* Self-hosted logo — build-time vendored from modulex.json / Iconify (see scripts/lib/logo.js). */}

<img src="https://mintcdn.com/modulexaillc/df8MOr-hXotYLTh5/logos/mailchimp.svg?fit=max&auto=format&n=df8MOr-hXotYLTh5&q=85&s=09f513a74b592a90f173675b0ae684bc" alt="Mailchimp logo" width="72" height="72" data-path="logos/mailchimp.svg" />

## Overview

Add **Mailchimp** to any ModuleX agent or workflow. Mailchimp marketing platform integration via the v3.0 REST API. Pure HTTP. 19 actions across lists, subscribers, campaigns, tags, notes, and segments.

<Info>
  **Categories**: Marketing & Advertising · Marketing & Email · Email Marketing · CRM · **Auth**: OAuth2, API Key · **Actions**: 19
</Info>

## Authentication

<Tabs>
  <Tab title="OAuth2">
    ### OAuth2 Authentication

    Connect using Mailchimp OAuth2 (recommended — avoids datacenter discovery and Basic Auth headaches).

    #### Required Credentials

    | Field         | Description                       | Required | Format |
    | ------------- | --------------------------------- | -------- | ------ |
    | Client ID     | Mailchimp OAuth App Client ID     | Yes      | `-`    |
    | Client Secret | Mailchimp OAuth App Client Secret | Yes      | `-`    |

    #### OAuth Configuration

    * **Authorization URL**: `https://login.mailchimp.com/oauth2/authorize`
    * **Token URL**: `https://login.mailchimp.com/oauth2/token`
  </Tab>

  <Tab title="API Key">
    ### API Key Authentication

    Authenticate using your Mailchimp API key. The key includes the datacenter suffix (e.g. xxx-us10).

    #### Required Credentials

    | Field             | Description                                                                                                                                                       | Required | Format                                  |
    | ----------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------- | --------------------------------------- |
    | Mailchimp API Key | Your Mailchimp API key (with datacenter suffix)                                                                                                                   | Yes      | `xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx-us10` |
    | Datacenter        | Datacenter portion of your API key (suffix after the dash, e.g. 'us10', 'us20', 'eu1'). Mailchimp routes API requests to the datacenter where your account lives. | Yes      | `us10`                                  |
  </Tab>
</Tabs>

## Available Actions

<AccordionGroup>
  <Accordion title="get_lists — List all audiences">
    ### Parameters

    <ResponseField name="count" type="integer">
      Results (max 1000) (Default: `10`)
    </ResponseField>

    <ResponseField name="offset" type="integer">
      Results to skip (Default: `0`)
    </ResponseField>

    ### Response

    ```json theme={null}
    {
      "additionalProperties": false,
      "properties": {
        "success": {
          "title": "Success",
          "type": "boolean"
        },
        "error": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Error"
        },
        "lists": {
          "items": {
            "additionalProperties": true,
            "type": "object"
          },
          "title": "Lists",
          "type": "array"
        },
        "total_items": {
          "default": 0,
          "title": "Total Items",
          "type": "integer"
        }
      },
      "required": [
        "success"
      ],
      "title": "GetListsOutput",
      "type": "object"
    }
    ```
  </Accordion>

  <Accordion title="get_list — Get details for a specific list/audience">
    ### Parameters

    <ResponseField name="list_id" type="string" required>
      The unique list/audience ID
    </ResponseField>

    ### Response

    ```json theme={null}
    {
      "additionalProperties": false,
      "properties": {
        "success": {
          "title": "Success",
          "type": "boolean"
        },
        "error": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Error"
        },
        "id": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Id"
        },
        "name": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Name"
        },
        "permission_reminder": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Permission Reminder"
        },
        "contact": {
          "anyOf": [
            {
              "additionalProperties": true,
              "type": "object"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Contact"
        },
        "campaign_defaults": {
          "anyOf": [
            {
              "additionalProperties": true,
              "type": "object"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Campaign Defaults"
        },
        "stats": {
          "anyOf": [
            {
              "additionalProperties": true,
              "type": "object"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Stats"
        },
        "date_created": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Date Created"
        }
      },
      "required": [
        "success"
      ],
      "title": "GetListOutput",
      "type": "object"
    }
    ```
  </Accordion>

  <Accordion title="create_list — Create a new audience">
    ### Parameters

    <ResponseField name="name" type="string" required>
      List name
    </ResponseField>

    <ResponseField name="contact_company" type="string" required>
      Company name
    </ResponseField>

    <ResponseField name="contact_address1" type="string" required>
      Street address
    </ResponseField>

    <ResponseField name="contact_city" type="string" required>
      City
    </ResponseField>

    <ResponseField name="contact_state" type="string" required>
      State/province
    </ResponseField>

    <ResponseField name="contact_zip" type="string" required>
      Postal code
    </ResponseField>

    <ResponseField name="contact_country" type="string" required>
      ISO3166 country code (e.g. 'US')
    </ResponseField>

    <ResponseField name="permission_reminder" type="string" required>
      Permission reminder text
    </ResponseField>

    <ResponseField name="from_name" type="string" required>
      Default from name
    </ResponseField>

    <ResponseField name="from_email" type="string" required>
      Default from email
    </ResponseField>

    <ResponseField name="subject" type="string" required>
      Default subject line
    </ResponseField>

    <ResponseField name="language" type="string">
      Default language (Default: `en`)
    </ResponseField>

    <ResponseField name="email_type_option" type="boolean">
      Allow subscribers to choose HTML or text (Default: `false`)
    </ResponseField>

    ### Response

    ```json theme={null}
    {
      "additionalProperties": false,
      "properties": {
        "success": {
          "title": "Success",
          "type": "boolean"
        },
        "error": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Error"
        },
        "id": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Id"
        },
        "name": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Name"
        },
        "date_created": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Date Created"
        },
        "message": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Message"
        }
      },
      "required": [
        "success"
      ],
      "title": "CreateListOutput",
      "type": "object"
    }
    ```
  </Accordion>

  <Accordion title="delete_list — Delete an audience (permanent)">
    ### Parameters

    <ResponseField name="list_id" type="string" required>
      The unique list/audience ID
    </ResponseField>

    ### Response

    ```json theme={null}
    {
      "additionalProperties": false,
      "properties": {
        "success": {
          "title": "Success",
          "type": "boolean"
        },
        "error": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Error"
        },
        "message": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Message"
        },
        "list_id": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "List Id"
        }
      },
      "required": [
        "success"
      ],
      "title": "DeleteListOutput",
      "type": "object"
    }
    ```
  </Accordion>

  <Accordion title="get_list_members — List members in an audience (optional status filter)">
    ### Parameters

    <ResponseField name="list_id" type="string" required>
      The unique list/audience ID
    </ResponseField>

    <ResponseField name="count" type="integer">
      Results (max 1000) (Default: `10`)
    </ResponseField>

    <ResponseField name="offset" type="integer">
      Results to skip (Default: `0`)
    </ResponseField>

    <ResponseField name="status" type="string">
      subscribed/unsubscribed/cleaned/pending/transactional/archived
    </ResponseField>

    ### Response

    ```json theme={null}
    {
      "additionalProperties": false,
      "properties": {
        "success": {
          "title": "Success",
          "type": "boolean"
        },
        "error": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Error"
        },
        "members": {
          "items": {
            "additionalProperties": true,
            "type": "object"
          },
          "title": "Members",
          "type": "array"
        },
        "total_items": {
          "default": 0,
          "title": "Total Items",
          "type": "integer"
        }
      },
      "required": [
        "success"
      ],
      "title": "GetListMembersOutput",
      "type": "object"
    }
    ```
  </Accordion>

  <Accordion title="get_subscriber — Get a subscriber by email (MD5 hash lookup)">
    ### Parameters

    <ResponseField name="list_id" type="string" required>
      The unique list/audience ID
    </ResponseField>

    <ResponseField name="email" type="string" required>
      Subscriber email address
    </ResponseField>

    ### Response

    ```json theme={null}
    {
      "additionalProperties": false,
      "properties": {
        "success": {
          "title": "Success",
          "type": "boolean"
        },
        "error": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Error"
        },
        "id": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Id"
        },
        "email_address": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Email Address"
        },
        "status": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Status"
        },
        "merge_fields": {
          "additionalProperties": true,
          "title": "Merge Fields",
          "type": "object"
        },
        "tags": {
          "items": {
            "type": "string"
          },
          "title": "Tags",
          "type": "array"
        },
        "vip": {
          "default": false,
          "title": "Vip",
          "type": "boolean"
        },
        "language": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Language"
        },
        "timestamp_signup": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Timestamp Signup"
        },
        "last_changed": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Last Changed"
        }
      },
      "required": [
        "success"
      ],
      "title": "GetSubscriberOutput",
      "type": "object"
    }
    ```
  </Accordion>

  <Accordion title="add_or_update_subscriber — Upsert a subscriber via PUT (members/{md5_hash}); if tags are provided, POST them in a follow-up call">
    ### Parameters

    <ResponseField name="list_id" type="string" required>
      The unique list/audience ID
    </ResponseField>

    <ResponseField name="email" type="string" required>
      Subscriber email address
    </ResponseField>

    <ResponseField name="status_if_new" type="string">
      Status if new (default 'subscribed') (Default: `subscribed`)
    </ResponseField>

    <ResponseField name="status" type="string">
      Current status
    </ResponseField>

    <ResponseField name="email_type" type="string">
      'html' or 'text'
    </ResponseField>

    <ResponseField name="merge_fields" type="object">
      Merge fields (e.g. \{'FNAME': 'John'})
    </ResponseField>

    <ResponseField name="language" type="string">
      Subscriber language
    </ResponseField>

    <ResponseField name="vip" type="boolean">
      VIP status
    </ResponseField>

    <ResponseField name="tags" type="array">
      Tags to add (active)
    </ResponseField>

    ### Response

    ```json theme={null}
    {
      "additionalProperties": false,
      "properties": {
        "success": {
          "title": "Success",
          "type": "boolean"
        },
        "error": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Error"
        },
        "id": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Id"
        },
        "email_address": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Email Address"
        },
        "status": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Status"
        },
        "merge_fields": {
          "additionalProperties": true,
          "title": "Merge Fields",
          "type": "object"
        },
        "message": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Message"
        }
      },
      "required": [
        "success"
      ],
      "title": "AddOrUpdateSubscriberOutput",
      "type": "object"
    }
    ```
  </Accordion>

  <Accordion title="delete_subscriber — Permanently delete a subscriber via DELETE /members/{md5_hash}/actions/delete-permanent">
    ### Parameters

    <ResponseField name="list_id" type="string" required>
      The unique list/audience ID
    </ResponseField>

    <ResponseField name="email" type="string" required>
      Subscriber email address
    </ResponseField>

    ### Response

    ```json theme={null}
    {
      "additionalProperties": false,
      "properties": {
        "success": {
          "title": "Success",
          "type": "boolean"
        },
        "error": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Error"
        },
        "message": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Message"
        },
        "email": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Email"
        },
        "list_id": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "List Id"
        }
      },
      "required": [
        "success"
      ],
      "title": "DeleteSubscriberOutput",
      "type": "object"
    }
    ```
  </Accordion>

  <Accordion title="get_campaigns — List campaigns (optional type/status filters)">
    ### Parameters

    <ResponseField name="count" type="integer">
      Results (max 1000) (Default: `10`)
    </ResponseField>

    <ResponseField name="offset" type="integer">
      Results to skip (Default: `0`)
    </ResponseField>

    <ResponseField name="type" type="string">
      regular/plaintext/absplit/rss/variate
    </ResponseField>

    <ResponseField name="status" type="string">
      save/paused/schedule/sending/sent
    </ResponseField>

    ### Response

    ```json theme={null}
    {
      "additionalProperties": false,
      "properties": {
        "success": {
          "title": "Success",
          "type": "boolean"
        },
        "error": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Error"
        },
        "campaigns": {
          "items": {
            "additionalProperties": true,
            "type": "object"
          },
          "title": "Campaigns",
          "type": "array"
        },
        "total_items": {
          "default": 0,
          "title": "Total Items",
          "type": "integer"
        }
      },
      "required": [
        "success"
      ],
      "title": "GetCampaignsOutput",
      "type": "object"
    }
    ```
  </Accordion>

  <Accordion title="get_campaign — Get a specific campaign">
    ### Parameters

    <ResponseField name="campaign_id" type="string" required>
      Campaign ID
    </ResponseField>

    ### Response

    ```json theme={null}
    {
      "additionalProperties": false,
      "properties": {
        "success": {
          "title": "Success",
          "type": "boolean"
        },
        "error": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Error"
        },
        "result": {
          "anyOf": [
            {
              "additionalProperties": true,
              "type": "object"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Result"
        }
      },
      "required": [
        "success"
      ],
      "title": "GetCampaignOutput",
      "type": "object"
    }
    ```
  </Accordion>

  <Accordion title="create_campaign — Create a campaign (settings flattened from kwargs)">
    ### Parameters

    <ResponseField name="type" type="string">
      Campaign type (Default: `regular`)
    </ResponseField>

    <ResponseField name="list_id" type="string" required>
      The unique list/audience ID
    </ResponseField>

    <ResponseField name="subject_line" type="string" required>
      Subject line
    </ResponseField>

    <ResponseField name="from_name" type="string" required>
      From name
    </ResponseField>

    <ResponseField name="reply_to" type="string" required>
      Reply-to email
    </ResponseField>

    <ResponseField name="title" type="string">
      Campaign title
    </ResponseField>

    <ResponseField name="preview_text" type="string">
      Preview text
    </ResponseField>

    ### Response

    ```json theme={null}
    {
      "additionalProperties": false,
      "properties": {
        "success": {
          "title": "Success",
          "type": "boolean"
        },
        "error": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Error"
        },
        "id": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Id"
        },
        "type": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Type"
        },
        "status": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Status"
        },
        "message": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Message"
        }
      },
      "required": [
        "success"
      ],
      "title": "CreateCampaignOutput",
      "type": "object"
    }
    ```
  </Accordion>

  <Accordion title="delete_campaign — Delete a campaign">
    ### Parameters

    <ResponseField name="campaign_id" type="string" required>
      Campaign ID
    </ResponseField>

    ### Response

    ```json theme={null}
    {
      "additionalProperties": false,
      "properties": {
        "success": {
          "title": "Success",
          "type": "boolean"
        },
        "error": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Error"
        },
        "message": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Message"
        },
        "campaign_id": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Campaign Id"
        }
      },
      "required": [
        "success"
      ],
      "title": "DeleteCampaignOutput",
      "type": "object"
    }
    ```
  </Accordion>

  <Accordion title="send_campaign — Send a campaign (POST /actions/send)">
    ### Parameters

    <ResponseField name="campaign_id" type="string" required>
      Campaign ID
    </ResponseField>

    ### Response

    ```json theme={null}
    {
      "additionalProperties": false,
      "properties": {
        "success": {
          "title": "Success",
          "type": "boolean"
        },
        "error": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Error"
        },
        "message": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Message"
        },
        "campaign_id": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Campaign Id"
        }
      },
      "required": [
        "success"
      ],
      "title": "SendCampaignOutput",
      "type": "object"
    }
    ```
  </Accordion>

  <Accordion title="get_campaign_report — Get a campaign's send/open/click report">
    ### Parameters

    <ResponseField name="campaign_id" type="string" required>
      Campaign ID
    </ResponseField>

    ### Response

    ```json theme={null}
    {
      "additionalProperties": false,
      "properties": {
        "success": {
          "title": "Success",
          "type": "boolean"
        },
        "error": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Error"
        },
        "result": {
          "anyOf": [
            {
              "additionalProperties": true,
              "type": "object"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Result"
        }
      },
      "required": [
        "success"
      ],
      "title": "GetCampaignReportOutput",
      "type": "object"
    }
    ```
  </Accordion>

  <Accordion title="get_member_tags — Get tags attached to a subscriber">
    ### Parameters

    <ResponseField name="list_id" type="string" required>
      The unique list/audience ID
    </ResponseField>

    <ResponseField name="email" type="string" required>
      Subscriber email address
    </ResponseField>

    ### Response

    ```json theme={null}
    {
      "additionalProperties": false,
      "properties": {
        "success": {
          "title": "Success",
          "type": "boolean"
        },
        "error": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Error"
        },
        "tags": {
          "items": {
            "additionalProperties": true,
            "type": "object"
          },
          "title": "Tags",
          "type": "array"
        },
        "total_items": {
          "default": 0,
          "title": "Total Items",
          "type": "integer"
        }
      },
      "required": [
        "success"
      ],
      "title": "GetMemberTagsOutput",
      "type": "object"
    }
    ```
  </Accordion>

  <Accordion title="update_member_tags — Update tags on a subscriber (active/inactive list)">
    ### Parameters

    <ResponseField name="list_id" type="string" required>
      The unique list/audience ID
    </ResponseField>

    <ResponseField name="email" type="string" required>
      Subscriber email address
    </ResponseField>

    <ResponseField name="tags" type="array" required>
      List of \{name, status} where status is 'active' or 'inactive'
    </ResponseField>

    ### Response

    ```json theme={null}
    {
      "additionalProperties": false,
      "properties": {
        "success": {
          "title": "Success",
          "type": "boolean"
        },
        "error": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Error"
        },
        "message": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Message"
        },
        "email": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Email"
        }
      },
      "required": [
        "success"
      ],
      "title": "UpdateMemberTagsOutput",
      "type": "object"
    }
    ```
  </Accordion>

  <Accordion title="add_note_to_subscriber — Add an internal note to a subscriber (max 1000 chars)">
    ### Parameters

    <ResponseField name="list_id" type="string" required>
      The unique list/audience ID
    </ResponseField>

    <ResponseField name="email" type="string" required>
      Subscriber email address
    </ResponseField>

    <ResponseField name="note" type="string" required>
      Note content
    </ResponseField>

    ### Response

    ```json theme={null}
    {
      "additionalProperties": false,
      "properties": {
        "success": {
          "title": "Success",
          "type": "boolean"
        },
        "error": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Error"
        },
        "id": {
          "anyOf": [
            {
              "type": "integer"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Id"
        },
        "note": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Note"
        },
        "email": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Email"
        },
        "created_at": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Created At"
        }
      },
      "required": [
        "success"
      ],
      "title": "AddNoteToSubscriberOutput",
      "type": "object"
    }
    ```
  </Accordion>

  <Accordion title="get_segments — List segments in an audience">
    ### Parameters

    <ResponseField name="list_id" type="string" required>
      The unique list/audience ID
    </ResponseField>

    <ResponseField name="count" type="integer">
      Results (max 1000) (Default: `10`)
    </ResponseField>

    <ResponseField name="offset" type="integer">
      Results to skip (Default: `0`)
    </ResponseField>

    ### Response

    ```json theme={null}
    {
      "additionalProperties": false,
      "properties": {
        "success": {
          "title": "Success",
          "type": "boolean"
        },
        "error": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Error"
        },
        "segments": {
          "items": {
            "additionalProperties": true,
            "type": "object"
          },
          "title": "Segments",
          "type": "array"
        },
        "total_items": {
          "default": 0,
          "title": "Total Items",
          "type": "integer"
        }
      },
      "required": [
        "success"
      ],
      "title": "GetSegmentsOutput",
      "type": "object"
    }
    ```
  </Accordion>

  <Accordion title="add_member_to_segment — Add a subscriber email to a static segment">
    ### Parameters

    <ResponseField name="list_id" type="string" required>
      The unique list/audience ID
    </ResponseField>

    <ResponseField name="segment_id" type="string" required>
      Segment ID
    </ResponseField>

    <ResponseField name="email" type="string" required>
      Subscriber email address
    </ResponseField>

    ### Response

    ```json theme={null}
    {
      "additionalProperties": false,
      "properties": {
        "success": {
          "title": "Success",
          "type": "boolean"
        },
        "error": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Error"
        },
        "message": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Message"
        },
        "email": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Email"
        },
        "segment_id": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Segment Id"
        }
      },
      "required": [
        "success"
      ],
      "title": "AddMemberToSegmentOutput",
      "type": "object"
    }
    ```
  </Accordion>
</AccordionGroup>

## Related integrations

<CardGroup cols={3}>
  <Card title="Customer.io" href="/integrations/tools/customerio" />

  <Card title="Klaviyo" href="/integrations/tools/klaviyo" />

  <Card title="SendGrid" href="/integrations/tools/sendgrid" />
</CardGroup>

## Links

* [Mailchimp](https://mailchimp.com)