/mailchimp-audiences | Type: Application | PCID required: Yes
Tools
mailchimp_audiences_create_audience_contact
Add Contact Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
audience_id | string | Yes | — | The unique ID for the audience. |
merge_field_validation_mode | string | No | — | Defines how merge field validation is handled. When set to ignore_required_checks, the API does not raise an error if required merge fields are missing from the request. When set to strict, the API enforces validation and returns an error if any required merge field is not provided. If this setting is omitted, strict is applied by default. |
data_mode | string | No | — | Indicates the data processing mode. In historical mode, contact data changes do not trigger automations or webhooks. In live mode, such changes do trigger them. |
email_channel | object | No | — | Email Channel |
language | string | No | — | The subscribers detected language. |
merge_fields | object | No | — | A dictionary of merge fields where the keys are the merge tags. See the Merge Fields documentation for more about the structure. |
sms_channel | object | No | — | Sms Channel |
tags | string[] | No | — | An array of tag names to add to the contact. This operation is append-only; existing tags will be preserved, and only new tags from this array will be added. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"audience_id": {
"type": "string",
"description": "The unique ID for the audience."
},
"merge_field_validation_mode": {
"type": "string",
"description": "Defines how merge field validation is handled. When set to `ignore_required_checks`, the API does not raise an error if required merge fields are missing from the request. When set to `strict`, the API enforces validation and returns an error if any required merge field is not provided. If this setting is omitted, `strict` is applied by default.",
"enum": [
"ignore_required_checks",
"strict"
]
},
"data_mode": {
"type": "string",
"description": "Indicates the data processing mode. In `historical` mode, contact data changes do not trigger automations or webhooks. In `live mode`, such changes do trigger them.",
"enum": [
"historical",
"live"
]
},
"email_channel": {
"type": "object",
"description": "Email Channel",
"properties": {
"email": {
"type": "string",
"description": "Email address"
},
"marketing_consent": {
"type": "object",
"description": "A contact's current consent status for email marketing communications. See the [Audiences (BETA) documentation](https://mailchimp.com/developer/marketing/docs/audiences-introduction) to learn about supported values."
}
}
},
"language": {
"type": "string",
"description": "The subscribers detected language."
},
"merge_fields": {
"type": "object",
"description": "A dictionary of merge fields where the keys are the merge tags. See the [Merge Fields documentation](https://mailchimp.com/developer/marketing/docs/merge-fields/#structure) for more about the structure."
},
"sms_channel": {
"type": "object",
"description": "Sms Channel",
"properties": {
"sms_phone": {
"type": "string",
"description": "SMS Phone Number"
},
"marketing_consent": {
"type": "object",
"description": "A contact's current consent status for SMS marketing communications. See the [Audiences (BETA) documentation](https://mailchimp.com/developer/marketing/docs/audiences-introduction) to learn about supported values."
}
}
},
"tags": {
"type": "array",
"items": {
"type": "string"
},
"description": "An array of tag names to add to the contact. This operation is append-only; existing tags will be preserved, and only new tags from this array will be added."
}
},
"required": [
"PCID",
"audience_id"
]
}
mailchimp_audiences_delete_lists_id
Delete list Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
list_id | string | Yes | — | The unique ID for the list. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"list_id": {
"type": "string",
"description": "The unique ID for the list."
}
},
"required": [
"PCID",
"list_id"
]
}
mailchimp_audiences_delete_lists_id_members_id
Archive list member Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
list_id | string | Yes | — | The unique ID for the list. |
subscriber_hash | string | Yes | — | The MD5 hash of the lowercase version of the list member’s email address. This endpoint also accepts a list member’s email address or contact_id. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"list_id": {
"type": "string",
"description": "The unique ID for the list."
},
"subscriber_hash": {
"type": "string",
"description": "The MD5 hash of the lowercase version of the list member's email address. This endpoint also accepts a list member's email address or contact_id."
}
},
"required": [
"PCID",
"list_id",
"subscriber_hash"
]
}
mailchimp_audiences_delete_lists_id_merge_fields_id
Delete merge field Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
list_id | string | Yes | — | The unique ID for the list. |
merge_id | string | Yes | — | The id for the merge field. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"list_id": {
"type": "string",
"description": "The unique ID for the list."
},
"merge_id": {
"type": "string",
"description": "The id for the merge field."
}
},
"required": [
"PCID",
"list_id",
"merge_id"
]
}
mailchimp_audiences_delete_lists_id_segments_id
Delete segment Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
list_id | string | Yes | — | The unique ID for the list. |
segment_id | string | Yes | — | The unique id for the segment. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"list_id": {
"type": "string",
"description": "The unique ID for the list."
},
"segment_id": {
"type": "string",
"description": "The unique id for the segment."
}
},
"required": [
"PCID",
"list_id",
"segment_id"
]
}
mailchimp_audiences_delete_lists_id_segments_id_members_id
Remove list member from segment Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
list_id | string | Yes | — | The unique ID for the list. |
segment_id | string | Yes | — | The unique id for the segment. |
subscriber_hash | string | Yes | — | The MD5 hash of the lowercase version of the list member’s email address. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"list_id": {
"type": "string",
"description": "The unique ID for the list."
},
"segment_id": {
"type": "string",
"description": "The unique id for the segment."
},
"subscriber_hash": {
"type": "string",
"description": "The MD5 hash of the lowercase version of the list member's email address."
}
},
"required": [
"PCID",
"list_id",
"segment_id",
"subscriber_hash"
]
}
mailchimp_audiences_get_audience_contact
Get Contact Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
fields | string[] | No | — | A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation. |
exclude_fields | string[] | No | — | A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation. |
audience_id | string | Yes | — | The unique ID for the audience. |
contact_id | string | Yes | — | A unique identifier for the contact, which can be a Mailchimp contact ID or a channel hash. A channel hash must follow the format email:[md5_hash] (where the hash is the MD5 of the lowercased email address) or sms:[sha256_hash] (where the hash is the SHA256 of the E.164-formatted phone number). |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"fields": {
"type": "array",
"items": {
"type": "string"
},
"description": "A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation."
},
"exclude_fields": {
"type": "array",
"items": {
"type": "string"
},
"description": "A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation."
},
"audience_id": {
"type": "string",
"description": "The unique ID for the audience."
},
"contact_id": {
"type": "string",
"description": "A unique identifier for the contact, which can be a Mailchimp contact ID or a channel hash. A channel hash must follow the format email:[md5_hash] (where the hash is the MD5 of the lowercased email address) or sms:[sha256_hash] (where the hash is the SHA256 of the E.164-formatted phone number)."
}
},
"required": [
"PCID",
"audience_id",
"contact_id"
]
}
mailchimp_audiences_get_audience_contact_list
Get Contacts Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
fields | string[] | No | — | A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation. |
exclude_fields | string[] | No | — | A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation. |
count | integer | No | — | The number of records to return. Default value is 10. Maximum value is 1000 |
cursor | string | No | — | Paginate through a collection of records by setting the cursor parameter to a next_cursor attribute returned by a previous request. Default value fetches the first “page” of results. |
created_before | string | No | — | Restricts the response to contacts created at or before the specified time (inclusive). Uses ISO 8601 format: 2025-04-23T15:41:36+00:00. |
created_since | string | No | — | Restricts the response to contacts created after the specified time (exclusive). Uses ISO 8601 format: 2025-04-23T15:41:36+00:00. |
updated_before | string | No | — | Restricts the response to contacts updated at or before the specified time (inclusive). Uses ISO 8601 format: 2025-04-23T15:41:36+00:00. |
updated_since | string | No | — | Restricts the response to contacts updated after the specified time (exclusive). Uses ISO 8601 format: 2025-04-23T15:41:36+00:00. |
audience_id | string | Yes | — | The unique ID for the audience. |
sort_field | string | No | — | Specifies the field to sort the returned contacts by. |
sort_dir | string | No | — | Determines the order direction for sorted results. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"fields": {
"type": "array",
"items": {
"type": "string"
},
"description": "A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation."
},
"exclude_fields": {
"type": "array",
"items": {
"type": "string"
},
"description": "A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation."
},
"count": {
"type": "integer",
"description": "The number of records to return. Default value is 10. Maximum value is 1000"
},
"cursor": {
"type": "string",
"description": "Paginate through a collection of records by setting the `cursor` parameter to a `next_cursor` attribute returned by a previous request. Default value fetches the first \"page\" of results."
},
"created_before": {
"type": "string",
"description": "Restricts the response to contacts created at or before the specified time (inclusive). Uses ISO 8601 format: 2025-04-23T15:41:36+00:00."
},
"created_since": {
"type": "string",
"description": "Restricts the response to contacts created after the specified time (exclusive). Uses ISO 8601 format: 2025-04-23T15:41:36+00:00."
},
"updated_before": {
"type": "string",
"description": "Restricts the response to contacts updated at or before the specified time (inclusive). Uses ISO 8601 format: 2025-04-23T15:41:36+00:00."
},
"updated_since": {
"type": "string",
"description": "Restricts the response to contacts updated after the specified time (exclusive). Uses ISO 8601 format: 2025-04-23T15:41:36+00:00."
},
"audience_id": {
"type": "string",
"description": "The unique ID for the audience."
},
"sort_field": {
"type": "string",
"description": "Specifies the field to sort the returned contacts by.",
"enum": [
"created_at",
"updated_at"
]
},
"sort_dir": {
"type": "string",
"description": "Determines the order direction for sorted results.",
"enum": [
"ASC",
"DESC"
]
}
},
"required": [
"PCID",
"audience_id"
]
}
mailchimp_audiences_get_audience_contacts
Get a list of audiences Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
fields | string[] | No | — | A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation. |
exclude_fields | string[] | No | — | A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation. |
count | integer | No | — | The number of records to return. Default value is 10. Maximum value is 1000 |
offset | integer | No | — | Used for pagination, this is the number of records from a collection to skip. Default value is 0. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"fields": {
"type": "array",
"items": {
"type": "string"
},
"description": "A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation."
},
"exclude_fields": {
"type": "array",
"items": {
"type": "string"
},
"description": "A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation."
},
"count": {
"type": "integer",
"description": "The number of records to return. Default value is 10. Maximum value is 1000"
},
"offset": {
"type": "integer",
"description": "Used for [pagination](https://mailchimp.com/developer/marketing/docs/methods-parameters/#pagination), this is the number of records from a collection to skip. Default value is 0."
}
},
"required": [
"PCID"
]
}
mailchimp_audiences_get_audience_id
Get audience info Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
fields | string[] | No | — | A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation. |
exclude_fields | string[] | No | — | A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation. |
audience_id | string | Yes | — | The unique ID for the audience. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"fields": {
"type": "array",
"items": {
"type": "string"
},
"description": "A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation."
},
"exclude_fields": {
"type": "array",
"items": {
"type": "string"
},
"description": "A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation."
},
"audience_id": {
"type": "string",
"description": "The unique ID for the audience."
}
},
"required": [
"PCID",
"audience_id"
]
}
mailchimp_audiences_get_list_member_tags
List member tags Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
list_id | string | Yes | — | The unique ID for the list. |
subscriber_hash | string | Yes | — | The MD5 hash of the lowercase version of the list member’s email address. This endpoint also accepts a list member’s email address or contact_id. |
fields | string[] | No | — | A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation. |
exclude_fields | string[] | No | — | A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation. |
count | integer | No | — | The number of records to return. Default value is 10. Maximum value is 1000 |
offset | integer | No | — | Used for pagination, this is the number of records from a collection to skip. Default value is 0. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"list_id": {
"type": "string",
"description": "The unique ID for the list."
},
"subscriber_hash": {
"type": "string",
"description": "The MD5 hash of the lowercase version of the list member's email address. This endpoint also accepts a list member's email address or contact_id."
},
"fields": {
"type": "array",
"items": {
"type": "string"
},
"description": "A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation."
},
"exclude_fields": {
"type": "array",
"items": {
"type": "string"
},
"description": "A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation."
},
"count": {
"type": "integer",
"description": "The number of records to return. Default value is 10. Maximum value is 1000"
},
"offset": {
"type": "integer",
"description": "Used for [pagination](https://mailchimp.com/developer/marketing/docs/methods-parameters/#pagination), this is the number of records from a collection to skip. Default value is 0."
}
},
"required": [
"PCID",
"list_id",
"subscriber_hash"
]
}
mailchimp_audiences_get_lists
Get lists info Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
fields | string[] | No | — | A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation. |
exclude_fields | string[] | No | — | A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation. |
count | integer | No | — | The number of records to return. Default value is 10. Maximum value is 1000 |
offset | integer | No | — | Used for pagination, this is the number of records from a collection to skip. Default value is 0. |
before_date_created | string | No | — | Restrict response to lists created before the set date. Uses ISO 8601 time format: 2015-10-21T15:41:36+00:00. |
since_date_created | string | No | — | Restrict results to lists created after the set date. Uses ISO 8601 time format: 2015-10-21T15:41:36+00:00. |
before_campaign_last_sent | string | No | — | Restrict results to lists created before the last campaign send date. Uses ISO 8601 time format: 2015-10-21T15:41:36+00:00. |
since_campaign_last_sent | string | No | — | Restrict results to lists created after the last campaign send date. Uses ISO 8601 time format: 2015-10-21T15:41:36+00:00. |
email | string | No | — | Restrict results to lists that include a specific subscriber’s email address. |
sort_field | string | No | — | Returns files sorted by the specified field. |
sort_dir | string | No | — | Determines the order direction for sorted results. |
has_ecommerce_store | boolean | No | — | Restrict results to lists that contain an active, connected, undeleted ecommerce store. |
include_total_contacts | boolean | No | — | Return the total_contacts field in the stats response, which contains an approximate count of all contacts in any state. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"fields": {
"type": "array",
"items": {
"type": "string"
},
"description": "A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation."
},
"exclude_fields": {
"type": "array",
"items": {
"type": "string"
},
"description": "A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation."
},
"count": {
"type": "integer",
"description": "The number of records to return. Default value is 10. Maximum value is 1000"
},
"offset": {
"type": "integer",
"description": "Used for [pagination](https://mailchimp.com/developer/marketing/docs/methods-parameters/#pagination), this is the number of records from a collection to skip. Default value is 0."
},
"before_date_created": {
"type": "string",
"description": "Restrict response to lists created before the set date. Uses ISO 8601 time format: 2015-10-21T15:41:36+00:00."
},
"since_date_created": {
"type": "string",
"description": "Restrict results to lists created after the set date. Uses ISO 8601 time format: 2015-10-21T15:41:36+00:00."
},
"before_campaign_last_sent": {
"type": "string",
"description": "Restrict results to lists created before the last campaign send date. Uses ISO 8601 time format: 2015-10-21T15:41:36+00:00."
},
"since_campaign_last_sent": {
"type": "string",
"description": "Restrict results to lists created after the last campaign send date. Uses ISO 8601 time format: 2015-10-21T15:41:36+00:00."
},
"email": {
"type": "string",
"description": "Restrict results to lists that include a specific subscriber's email address."
},
"sort_field": {
"type": "string",
"description": "Returns files sorted by the specified field.",
"enum": [
"date_created"
]
},
"sort_dir": {
"type": "string",
"description": "Determines the order direction for sorted results.",
"enum": [
"ASC",
"DESC"
]
},
"has_ecommerce_store": {
"type": "boolean",
"description": "Restrict results to lists that contain an active, connected, undeleted ecommerce store."
},
"include_total_contacts": {
"type": "boolean",
"description": "Return the total_contacts field in the stats response, which contains an approximate count of all contacts in any state."
}
},
"required": [
"PCID"
]
}
mailchimp_audiences_get_lists_id
Get list info Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
fields | string[] | No | — | A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation. |
exclude_fields | string[] | No | — | A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation. |
list_id | string | Yes | — | The unique ID for the list. |
include_total_contacts | boolean | No | — | Return the total_contacts field in the stats response, which contains an approximate count of all contacts in any state. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"fields": {
"type": "array",
"items": {
"type": "string"
},
"description": "A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation."
},
"exclude_fields": {
"type": "array",
"items": {
"type": "string"
},
"description": "A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation."
},
"list_id": {
"type": "string",
"description": "The unique ID for the list."
},
"include_total_contacts": {
"type": "boolean",
"description": "Return the total_contacts field in the stats response, which contains an approximate count of all contacts in any state."
}
},
"required": [
"PCID",
"list_id"
]
}
mailchimp_audiences_get_lists_id_activity
List recent activity Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
count | integer | No | — | The number of records to return. Default value is 10. Maximum value is 1000 |
offset | integer | No | — | Used for pagination, this is the number of records from a collection to skip. Default value is 0. |
fields | string[] | No | — | A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation. |
exclude_fields | string[] | No | — | A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation. |
list_id | string | Yes | — | The unique ID for the list. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"count": {
"type": "integer",
"description": "The number of records to return. Default value is 10. Maximum value is 1000"
},
"offset": {
"type": "integer",
"description": "Used for [pagination](https://mailchimp.com/developer/marketing/docs/methods-parameters/#pagination), this is the number of records from a collection to skip. Default value is 0."
},
"fields": {
"type": "array",
"items": {
"type": "string"
},
"description": "A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation."
},
"exclude_fields": {
"type": "array",
"items": {
"type": "string"
},
"description": "A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation."
},
"list_id": {
"type": "string",
"description": "The unique ID for the list."
}
},
"required": [
"PCID",
"list_id"
]
}
mailchimp_audiences_get_lists_id_members
List members info Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
fields | string[] | No | — | A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation. |
exclude_fields | string[] | No | — | A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation. |
count | integer | No | — | The number of records to return. Default value is 10. Maximum value is 1000 |
offset | integer | No | — | Used for pagination, this is the number of records from a collection to skip. Default value is 0. |
list_id | string | Yes | — | The unique ID for the list. |
email_type | string | No | — | The email type. |
status | string | No | — | The subscriber’s status. |
since_timestamp_opt | string | No | — | Restrict results to subscribers who opted-in after the set timeframe. Uses ISO 8601 time format: 2015-10-21T15:41:36+00:00. |
before_timestamp_opt | string | No | — | Restrict results to subscribers who opted-in before the set timeframe. Uses ISO 8601 time format: 2015-10-21T15:41:36+00:00. |
since_last_changed | string | No | — | Restrict results to subscribers whose information changed after the set timeframe. Uses ISO 8601 time format: 2015-10-21T15:41:36+00:00. |
before_last_changed | string | No | — | Restrict results to subscribers whose information changed before the set timeframe. Uses ISO 8601 time format: 2015-10-21T15:41:36+00:00. |
unique_email_id | string | No | — | A unique identifier for the email address across all Mailchimp lists. |
vip_only | boolean | No | — | A filter to return only the list’s VIP members. Passing true will restrict results to VIP list members, passing false will return all list members. |
interest_category_id | string | No | — | The unique id for the interest category. |
interest_ids | string | No | — | Used to filter list members by interests. Must be accompanied by interest_category_id and interest_match. The value must be a comma separated list of interest ids present for any supplied interest categories. |
interest_match | string | No | — | Used to filter list members by interests. Must be accompanied by interest_category_id and interest_ids. “any” will match a member with any of the interest supplied, “all” will only match members with every interest supplied, and “none” will match members without any of the interest supplied. |
sort_field | string | No | — | Returns files sorted by the specified field. |
sort_dir | string | No | — | Determines the order direction for sorted results. |
since_last_campaign | boolean | No | — | Filter subscribers by those subscribed/unsubscribed/pending/cleaned since last email campaign send. Member status is required to use this filter. |
unsubscribed_since | string | No | — | Filter subscribers by those unsubscribed since a specific date. Using any status other than unsubscribed with this filter will result in an error. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"fields": {
"type": "array",
"items": {
"type": "string"
},
"description": "A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation."
},
"exclude_fields": {
"type": "array",
"items": {
"type": "string"
},
"description": "A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation."
},
"count": {
"type": "integer",
"description": "The number of records to return. Default value is 10. Maximum value is 1000"
},
"offset": {
"type": "integer",
"description": "Used for [pagination](https://mailchimp.com/developer/marketing/docs/methods-parameters/#pagination), this is the number of records from a collection to skip. Default value is 0."
},
"list_id": {
"type": "string",
"description": "The unique ID for the list."
},
"email_type": {
"type": "string",
"description": "The email type."
},
"status": {
"type": "string",
"description": "The subscriber's status.",
"enum": [
"subscribed",
"unsubscribed",
"cleaned",
"pending",
"transactional",
"archived"
]
},
"since_timestamp_opt": {
"type": "string",
"description": "Restrict results to subscribers who opted-in after the set timeframe. Uses ISO 8601 time format: 2015-10-21T15:41:36+00:00."
},
"before_timestamp_opt": {
"type": "string",
"description": "Restrict results to subscribers who opted-in before the set timeframe. Uses ISO 8601 time format: 2015-10-21T15:41:36+00:00."
},
"since_last_changed": {
"type": "string",
"description": "Restrict results to subscribers whose information changed after the set timeframe. Uses ISO 8601 time format: 2015-10-21T15:41:36+00:00."
},
"before_last_changed": {
"type": "string",
"description": "Restrict results to subscribers whose information changed before the set timeframe. Uses ISO 8601 time format: 2015-10-21T15:41:36+00:00."
},
"unique_email_id": {
"type": "string",
"description": "A unique identifier for the email address across all Mailchimp lists."
},
"vip_only": {
"type": "boolean",
"description": "A filter to return only the list's VIP members. Passing `true` will restrict results to VIP list members, passing `false` will return all list members."
},
"interest_category_id": {
"type": "string",
"description": "The unique id for the interest category."
},
"interest_ids": {
"type": "string",
"description": "Used to filter list members by interests. Must be accompanied by interest_category_id and interest_match. The value must be a comma separated list of interest ids present for any supplied interest categories."
},
"interest_match": {
"type": "string",
"description": "Used to filter list members by interests. Must be accompanied by interest_category_id and interest_ids. \"any\" will match a member with any of the interest supplied, \"all\" will only match members with every interest supplied, and \"none\" will match members without any of the interest supplied.",
"enum": [
"any",
"all",
"none"
]
},
"sort_field": {
"type": "string",
"description": "Returns files sorted by the specified field.",
"enum": [
"timestamp_opt",
"timestamp_signup",
"last_changed"
]
},
"sort_dir": {
"type": "string",
"description": "Determines the order direction for sorted results.",
"enum": [
"ASC",
"DESC"
]
},
"since_last_campaign": {
"type": "boolean",
"description": "Filter subscribers by those subscribed/unsubscribed/pending/cleaned since last email campaign send. Member status is required to use this filter."
},
"unsubscribed_since": {
"type": "string",
"description": "Filter subscribers by those unsubscribed since a specific date. Using any status other than unsubscribed with this filter will result in an error."
}
},
"required": [
"PCID",
"list_id"
]
}
mailchimp_audiences_get_lists_id_members_id
Get member info Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
fields | string[] | No | — | A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation. |
exclude_fields | string[] | No | — | A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation. |
list_id | string | Yes | — | The unique ID for the list. |
subscriber_hash | string | Yes | — | The MD5 hash of the lowercase version of the list member’s email address. This endpoint also accepts a list member’s email address or contact_id. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"fields": {
"type": "array",
"items": {
"type": "string"
},
"description": "A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation."
},
"exclude_fields": {
"type": "array",
"items": {
"type": "string"
},
"description": "A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation."
},
"list_id": {
"type": "string",
"description": "The unique ID for the list."
},
"subscriber_hash": {
"type": "string",
"description": "The MD5 hash of the lowercase version of the list member's email address. This endpoint also accepts a list member's email address or contact_id."
}
},
"required": [
"PCID",
"list_id",
"subscriber_hash"
]
}
mailchimp_audiences_get_lists_id_members_id_events
List member events Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
list_id | string | Yes | — | The unique ID for the list. |
subscriber_hash | string | Yes | — | The MD5 hash of the lowercase version of the list member’s email address. This endpoint also accepts a list member’s email address or contact_id. |
count | integer | No | — | The number of records to return. Default value is 10. Maximum value is 1000 |
offset | integer | No | — | Used for pagination, this is the number of records from a collection to skip. Default value is 0. |
fields | string[] | No | — | A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation. |
exclude_fields | string[] | No | — | A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"list_id": {
"type": "string",
"description": "The unique ID for the list."
},
"subscriber_hash": {
"type": "string",
"description": "The MD5 hash of the lowercase version of the list member's email address. This endpoint also accepts a list member's email address or contact_id."
},
"count": {
"type": "integer",
"description": "The number of records to return. Default value is 10. Maximum value is 1000"
},
"offset": {
"type": "integer",
"description": "Used for [pagination](https://mailchimp.com/developer/marketing/docs/methods-parameters/#pagination), this is the number of records from a collection to skip. Default value is 0."
},
"fields": {
"type": "array",
"items": {
"type": "string"
},
"description": "A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation."
},
"exclude_fields": {
"type": "array",
"items": {
"type": "string"
},
"description": "A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation."
}
},
"required": [
"PCID",
"list_id",
"subscriber_hash"
]
}
mailchimp_audiences_get_lists_id_merge_fields
List merge fields Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
list_id | string | Yes | — | The unique ID for the list. |
fields | string[] | No | — | A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation. |
exclude_fields | string[] | No | — | A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation. |
count | integer | No | — | The number of records to return. Default value is 10. Maximum value is 1000 |
offset | integer | No | — | Used for pagination, this is the number of records from a collection to skip. Default value is 0. |
type | string | No | — | The merge field type. |
required | boolean | No | — | Whether it’s a required merge field. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"list_id": {
"type": "string",
"description": "The unique ID for the list."
},
"fields": {
"type": "array",
"items": {
"type": "string"
},
"description": "A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation."
},
"exclude_fields": {
"type": "array",
"items": {
"type": "string"
},
"description": "A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation."
},
"count": {
"type": "integer",
"description": "The number of records to return. Default value is 10. Maximum value is 1000"
},
"offset": {
"type": "integer",
"description": "Used for [pagination](https://mailchimp.com/developer/marketing/docs/methods-parameters/#pagination), this is the number of records from a collection to skip. Default value is 0."
},
"type": {
"type": "string",
"description": "The merge field type."
},
"required": {
"type": "boolean",
"description": "Whether it's a required merge field."
}
},
"required": [
"PCID",
"list_id"
]
}
mailchimp_audiences_get_lists_id_merge_fields_id
Get merge field Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
list_id | string | Yes | — | The unique ID for the list. |
merge_id | string | Yes | — | The id for the merge field. |
exclude_fields | string[] | No | — | A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation. |
fields | string[] | No | — | A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"list_id": {
"type": "string",
"description": "The unique ID for the list."
},
"merge_id": {
"type": "string",
"description": "The id for the merge field."
},
"exclude_fields": {
"type": "array",
"items": {
"type": "string"
},
"description": "A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation."
},
"fields": {
"type": "array",
"items": {
"type": "string"
},
"description": "A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation."
}
},
"required": [
"PCID",
"list_id",
"merge_id"
]
}
mailchimp_audiences_get_lists_id_segments_id
Get segment info Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
fields | string[] | No | — | A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation. |
exclude_fields | string[] | No | — | A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation. |
list_id | string | Yes | — | The unique ID for the list. |
segment_id | string | Yes | — | The unique id for the segment. |
include_cleaned | boolean | No | — | Include cleaned members in response |
include_transactional | boolean | No | — | Include transactional members in response |
include_unsubscribed | boolean | No | — | Include unsubscribed members in response |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"fields": {
"type": "array",
"items": {
"type": "string"
},
"description": "A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation."
},
"exclude_fields": {
"type": "array",
"items": {
"type": "string"
},
"description": "A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation."
},
"list_id": {
"type": "string",
"description": "The unique ID for the list."
},
"segment_id": {
"type": "string",
"description": "The unique id for the segment."
},
"include_cleaned": {
"type": "boolean",
"description": "Include cleaned members in response"
},
"include_transactional": {
"type": "boolean",
"description": "Include transactional members in response"
},
"include_unsubscribed": {
"type": "boolean",
"description": "Include unsubscribed members in response"
}
},
"required": [
"PCID",
"list_id",
"segment_id"
]
}
mailchimp_audiences_get_lists_id_segments_id_members
List members in segment Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
fields | string[] | No | — | A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation. |
exclude_fields | string[] | No | — | A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation. |
count | integer | No | — | The number of records to return. Default value is 10. Maximum value is 1000 |
offset | integer | No | — | Used for pagination, this is the number of records from a collection to skip. Default value is 0. |
list_id | string | Yes | — | The unique ID for the list. |
segment_id | string | Yes | — | The unique id for the segment. |
include_cleaned | boolean | No | — | Include cleaned members in response |
include_transactional | boolean | No | — | Include transactional members in response |
include_unsubscribed | boolean | No | — | Include unsubscribed members in response |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"fields": {
"type": "array",
"items": {
"type": "string"
},
"description": "A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation."
},
"exclude_fields": {
"type": "array",
"items": {
"type": "string"
},
"description": "A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation."
},
"count": {
"type": "integer",
"description": "The number of records to return. Default value is 10. Maximum value is 1000"
},
"offset": {
"type": "integer",
"description": "Used for [pagination](https://mailchimp.com/developer/marketing/docs/methods-parameters/#pagination), this is the number of records from a collection to skip. Default value is 0."
},
"list_id": {
"type": "string",
"description": "The unique ID for the list."
},
"segment_id": {
"type": "string",
"description": "The unique id for the segment."
},
"include_cleaned": {
"type": "boolean",
"description": "Include cleaned members in response"
},
"include_transactional": {
"type": "boolean",
"description": "Include transactional members in response"
},
"include_unsubscribed": {
"type": "boolean",
"description": "Include unsubscribed members in response"
}
},
"required": [
"PCID",
"list_id",
"segment_id"
]
}
mailchimp_audiences_get_search_members
Search members Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
fields | string[] | No | — | A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation. |
exclude_fields | string[] | No | — | A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation. |
query | string | Yes | — | The search query used to filter results. Query should be a valid email, or a string representing a contact’s first or last name. |
list_id | string | No | — | The unique id for the list. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"fields": {
"type": "array",
"items": {
"type": "string"
},
"description": "A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation."
},
"exclude_fields": {
"type": "array",
"items": {
"type": "string"
},
"description": "A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation."
},
"query": {
"type": "string",
"description": "The search query used to filter results. Query should be a valid email, or a string representing a contact's first or last name."
},
"list_id": {
"type": "string",
"description": "The unique id for the list."
}
},
"required": [
"PCID",
"query"
]
}
mailchimp_audiences_patch_audience_contact
Update Contact Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
audience_id | string | Yes | — | The unique ID for the audience. |
contact_id | string | Yes | — | The unique id for the contact. |
merge_field_validation_mode | string | No | — | Defines how merge field validation is handled. When set to ignore_required_checks, the API does not raise an error if required merge fields are missing from the request. When set to strict, the API enforces validation and returns an error if any required merge field is not provided. If this setting is omitted, strict is applied by default. |
data_mode | string | No | — | Indicates the data processing mode. In historical mode, contact data changes do not trigger automations or webhooks. In live mode, such changes do trigger them. |
email_channel | object | No | — | Email Channel |
language | string | No | — | The subscribers detected language. |
merge_fields | object | No | — | A dictionary of merge fields where the keys are the merge tags. See the Merge Fields documentation for more about the structure. |
sms_channel | object | No | — | Sms Channel |
tags | string[] | No | — | An array of tag names to add to the contact. This operation is append-only; existing tags will be preserved, and only new tags from this array will be added. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"audience_id": {
"type": "string",
"description": "The unique ID for the audience."
},
"contact_id": {
"type": "string",
"description": "The unique id for the contact."
},
"merge_field_validation_mode": {
"type": "string",
"description": "Defines how merge field validation is handled. When set to `ignore_required_checks`, the API does not raise an error if required merge fields are missing from the request. When set to `strict`, the API enforces validation and returns an error if any required merge field is not provided. If this setting is omitted, `strict` is applied by default.",
"enum": [
"ignore_required_checks",
"strict"
]
},
"data_mode": {
"type": "string",
"description": "Indicates the data processing mode. In `historical` mode, contact data changes do not trigger automations or webhooks. In `live mode`, such changes do trigger them.",
"enum": [
"historical",
"live"
]
},
"email_channel": {
"type": "object",
"description": "Email Channel",
"properties": {
"email": {
"type": "string",
"description": "Email address"
},
"marketing_consent": {
"type": "object",
"description": "A contact's current consent status for email marketing communications. See the [Audiences (BETA) documentation](https://mailchimp.com/developer/marketing/docs/audiences-introduction) to learn about supported values."
}
}
},
"language": {
"type": "string",
"description": "The subscribers detected language."
},
"merge_fields": {
"type": "object",
"description": "A dictionary of merge fields where the keys are the merge tags. See the [Merge Fields documentation](https://mailchimp.com/developer/marketing/docs/merge-fields/#structure) for more about the structure."
},
"sms_channel": {
"type": "object",
"description": "Sms Channel",
"properties": {
"sms_phone": {
"type": "string",
"description": "SMS Phone Number"
},
"marketing_consent": {
"type": "object",
"description": "A contact's current consent status for SMS marketing communications. See the [Audiences (BETA) documentation](https://mailchimp.com/developer/marketing/docs/audiences-introduction) to learn about supported values."
}
}
},
"tags": {
"type": "array",
"items": {
"type": "string"
},
"description": "An array of tag names to add to the contact. This operation is append-only; existing tags will be preserved, and only new tags from this array will be added."
}
},
"required": [
"PCID",
"audience_id",
"contact_id"
]
}
mailchimp_audiences_patch_lists_id
Update lists Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
list_id | string | Yes | — | The unique ID for the list. |
campaign_defaults | object | No | — | Default values for campaigns created for this list. |
contact | object | No | — | Contact information displayed in campaign footers to comply with international spam laws. |
double_optin | boolean | No | — | Whether or not to require the subscriber to confirm subscription via email. |
email_type_option | boolean | No | — | Whether the list supports multiple formats for emails. When set to true, subscribers can choose whether they want to receive HTML or plain-text emails. When set to false, subscribers will receive HTML emails, with a plain-text alternative backup. |
marketing_permissions | boolean | No | — | Whether or not the list has marketing permissions (eg. GDPR) enabled. |
name | string | No | — | The name of the list. |
notify_on_subscribe | string | No | — | The email address to send subscribe notifications to. |
notify_on_unsubscribe | string | No | — | The email address to send unsubscribe notifications to. |
permission_reminder | string | No | — | The permission reminder for the list. |
use_archive_bar | boolean | No | — | Whether campaigns for this list use the Archive Bar in archives by default. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"list_id": {
"type": "string",
"description": "The unique ID for the list."
},
"campaign_defaults": {
"type": "object",
"description": "[Default values for campaigns](https://mailchimp.com/help/edit-your-emails-subject-preview-text-from-name-or-from-email-address/) created for this list.",
"properties": {
"from_name": {
"type": "string",
"description": "The default from name for campaigns sent to this list."
},
"from_email": {
"type": "string",
"description": "The default from email for campaigns sent to this list."
},
"subject": {
"type": "string",
"description": "The default subject line for campaigns sent to this list."
},
"language": {
"type": "string",
"description": "The default language for this lists's forms."
}
},
"required": [
"from_name",
"from_email",
"subject",
"language"
]
},
"contact": {
"type": "object",
"description": "[Contact information displayed in campaign footers](https://mailchimp.com/help/about-campaign-footers/) to comply with international spam laws.",
"properties": {
"company": {
"type": "string",
"description": "The company name for the list."
},
"address1": {
"type": "string",
"description": "The street address for the list contact."
},
"address2": {
"type": "string",
"description": "The street address for the list contact."
},
"city": {
"type": "string",
"description": "The city for the list contact."
},
"state": {
"type": "string",
"description": "The state for the list contact."
},
"zip": {
"type": "string",
"description": "The postal or zip code for the list contact."
},
"country": {
"type": "string",
"description": "A two-character ISO3166 country code. Defaults to US if invalid."
},
"phone": {
"type": "string",
"description": "The phone number for the list contact."
}
},
"required": [
"company",
"address1",
"city",
"state",
"zip",
"country"
]
},
"double_optin": {
"type": "boolean",
"description": "Whether or not to require the subscriber to confirm subscription via email."
},
"email_type_option": {
"type": "boolean",
"description": "Whether the list supports [multiple formats for emails](https://mailchimp.com/help/change-audience-name-defaults/). When set to `true`, subscribers can choose whether they want to receive HTML or plain-text emails. When set to `false`, subscribers will receive HTML emails, with a plain-text alternative backup."
},
"marketing_permissions": {
"type": "boolean",
"description": "Whether or not the list has marketing permissions (eg. GDPR) enabled."
},
"name": {
"type": "string",
"description": "The name of the list."
},
"notify_on_subscribe": {
"type": "string",
"description": "The email address to send [subscribe notifications](https://mailchimp.com/help/change-subscribe-and-unsubscribe-notifications/) to."
},
"notify_on_unsubscribe": {
"type": "string",
"description": "The email address to send [unsubscribe notifications](https://mailchimp.com/help/change-subscribe-and-unsubscribe-notifications/) to."
},
"permission_reminder": {
"type": "string",
"description": "The [permission reminder](https://mailchimp.com/help/edit-the-permission-reminder/) for the list."
},
"use_archive_bar": {
"type": "boolean",
"description": "Whether campaigns for this list use the [Archive Bar](https://mailchimp.com/help/about-email-campaign-archives-and-pages/) in archives by default."
}
},
"required": [
"PCID",
"list_id"
]
}
mailchimp_audiences_patch_lists_id_members_id
Update list member Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
list_id | string | Yes | — | The unique ID for the list. |
subscriber_hash | string | Yes | — | The MD5 hash of the lowercase version of the list member’s email address. This endpoint also accepts a list member’s email address or contact_id. |
skip_merge_validation | boolean | No | — | If skip_merge_validation is true, member data will be accepted without merge field values, even if the merge field is usually required. This defaults to false. |
email_address | string | No | — | Email address for a subscriber. |
email_type | string | No | — | Type of email this member asked to get (‘html’ or ‘text’). |
interests | object | No | — | The key of this object’s properties is the ID of the interest in question. |
ip_opt | string | No | — | The IP address the subscriber used to confirm their opt-in status. |
ip_signup | string | No | — | IP address the subscriber signed up from. |
language | string | No | — | If set/detected, the subscriber’s language. |
location | object | No | — | Subscriber location information. |
marketing_permissions | object[] | No | — | The marketing permissions for the subscriber. |
merge_fields | object | No | — | A dictionary of merge fields where the keys are the merge tags. See the Merge Fields documentation for more about the structure. |
status | string | No | — | Subscriber’s current status. |
timestamp_opt | string | No | — | The date and time the subscriber confirmed their opt-in status in ISO 8601 format. |
timestamp_signup | string | No | — | The date and time the subscriber signed up for the list in ISO 8601 format. |
vip | boolean | No | — | VIP status for subscriber. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"list_id": {
"type": "string",
"description": "The unique ID for the list."
},
"subscriber_hash": {
"type": "string",
"description": "The MD5 hash of the lowercase version of the list member's email address. This endpoint also accepts a list member's email address or contact_id."
},
"skip_merge_validation": {
"type": "boolean",
"description": "If skip_merge_validation is true, member data will be accepted without merge field values, even if the merge field is usually required. This defaults to false."
},
"email_address": {
"type": "string",
"description": "Email address for a subscriber."
},
"email_type": {
"type": "string",
"description": "Type of email this member asked to get ('html' or 'text')."
},
"interests": {
"type": "object",
"description": "The key of this object's properties is the ID of the interest in question."
},
"ip_opt": {
"type": "string",
"description": "The IP address the subscriber used to confirm their opt-in status."
},
"ip_signup": {
"type": "string",
"description": "IP address the subscriber signed up from."
},
"language": {
"type": "string",
"description": "If set/detected, the [subscriber's language](https://mailchimp.com/help/view-and-edit-contact-languages/)."
},
"location": {
"type": "object",
"description": "Subscriber location information.",
"properties": {
"latitude": {
"type": "number",
"description": "The location latitude."
},
"longitude": {
"type": "number",
"description": "The location longitude."
}
}
},
"marketing_permissions": {
"type": "array",
"items": {
"type": "object",
"properties": {
"marketing_permission_id": {
"type": "string",
"description": "The id for the marketing permission on the list"
},
"enabled": {
"type": "boolean",
"description": "If the subscriber has opted-in to the marketing permission."
}
}
},
"description": "The marketing permissions for the subscriber."
},
"merge_fields": {
"type": "object",
"description": "A dictionary of merge fields where the keys are the merge tags. See the [Merge Fields documentation](https://mailchimp.com/developer/marketing/docs/merge-fields/#structure) for more about the structure."
},
"status": {
"type": "string",
"description": "Subscriber's current status.",
"enum": [
"subscribed",
"unsubscribed",
"cleaned",
"pending"
]
},
"timestamp_opt": {
"type": "string",
"description": "The date and time the subscriber confirmed their opt-in status in ISO 8601 format."
},
"timestamp_signup": {
"type": "string",
"description": "The date and time the subscriber signed up for the list in ISO 8601 format."
},
"vip": {
"type": "boolean",
"description": "[VIP status](https://mailchimp.com/help/designate-and-send-to-vip-contacts/) for subscriber."
}
},
"required": [
"PCID",
"list_id",
"subscriber_hash"
]
}
mailchimp_audiences_patch_lists_id_merge_fields_id
Update merge field Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
list_id | string | Yes | — | The unique ID for the list. |
merge_id | string | Yes | — | The id for the merge field. |
default_value | string | No | — | The default value for the merge field if null. |
display_order | integer | No | — | The order that the merge field displays on the list signup form. |
help_text | string | No | — | Extra text to help the subscriber fill out the form. |
name | string | No | — | The name of the merge field (audience field). |
options | object | No | — | Extra options for some merge field types. |
public | boolean | No | — | Whether the merge field is displayed on the signup form. |
required | boolean | No | — | Whether the merge field is required to import a contact. |
tag | string | No | — | The merge tag used for Mailchimp campaigns and adding contact information. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"list_id": {
"type": "string",
"description": "The unique ID for the list."
},
"merge_id": {
"type": "string",
"description": "The id for the merge field."
},
"default_value": {
"type": "string",
"description": "The default value for the merge field if `null`."
},
"display_order": {
"type": "integer",
"description": "The order that the merge field displays on the list signup form."
},
"help_text": {
"type": "string",
"description": "Extra text to help the subscriber fill out the form."
},
"name": {
"type": "string",
"description": "The name of the merge field (audience field)."
},
"options": {
"type": "object",
"description": "Extra options for some merge field types.",
"properties": {
"default_country": {
"type": "integer",
"description": "In an address field, the default country code if none supplied."
},
"phone_format": {
"type": "string",
"description": "In a phone field, the phone number type: US or International."
},
"date_format": {
"type": "string",
"description": "In a date or birthday field, the format of the date."
},
"choices": {
"type": "array",
"items": {
"type": "string"
},
"description": "In a radio or dropdown non-group field, the available options for members to pick from."
}
}
},
"public": {
"type": "boolean",
"description": "Whether the merge field is displayed on the signup form."
},
"required": {
"type": "boolean",
"description": "Whether the merge field is required to import a contact."
},
"tag": {
"type": "string",
"description": "The merge tag used for Mailchimp campaigns and [adding contact information](https://mailchimp.com/developer/marketing/docs/merge-fields/#add-merge-data-to-contacts)."
}
},
"required": [
"PCID",
"list_id",
"merge_id"
]
}
mailchimp_audiences_patch_lists_id_segments_id
Update segment Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
list_id | string | Yes | — | The unique ID for the list. |
segment_id | string | Yes | — | The unique id for the segment. |
name | string | No | — | The name of the segment. |
options | object | No | — | The conditions of the segment. Static and fuzzy segments don’t have conditions. |
static_segment | string[] | No | — | An array of emails to be used for a static segment. Any emails provided that are not present on the list will be ignored. Passing an empty array for an existing static segment will reset that segment and remove all members. This field cannot be provided with the options field. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"list_id": {
"type": "string",
"description": "The unique ID for the list."
},
"segment_id": {
"type": "string",
"description": "The unique id for the segment."
},
"name": {
"type": "string",
"description": "The name of the segment."
},
"options": {
"type": "object",
"description": "The [conditions of the segment](https://mailchimp.com/help/save-and-manage-segments/). Static and fuzzy segments don't have conditions.",
"properties": {
"match": {
"type": "string",
"description": "Match type.",
"enum": [
"any",
"all"
]
},
"conditions": {
"type": "array",
"items": {
"type": "object"
},
"description": "An array of segment conditions."
}
}
},
"static_segment": {
"type": "array",
"items": {
"type": "string"
},
"description": "An array of emails to be used for a static segment. Any emails provided that are not present on the list will be ignored. Passing an empty array for an existing static segment will reset that segment and remove all members. This field cannot be provided with the `options` field."
}
},
"required": [
"PCID",
"list_id",
"segment_id"
]
}
mailchimp_audiences_post_contacts_actions_archive
Archive Contact Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
audience_id | string | Yes | — | The unique ID for the audience. |
contact_id | string | Yes | — | The unique id for the contact. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"audience_id": {
"type": "string",
"description": "The unique ID for the audience."
},
"contact_id": {
"type": "string",
"description": "The unique id for the contact."
}
},
"required": [
"PCID",
"audience_id",
"contact_id"
]
}
mailchimp_audiences_post_contacts_actions_forget
Forget Contact Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
audience_id | string | Yes | — | The unique ID for the audience. |
contact_id | string | Yes | — | The unique id for the contact. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"audience_id": {
"type": "string",
"description": "The unique ID for the audience."
},
"contact_id": {
"type": "string",
"description": "The unique id for the contact."
}
},
"required": [
"PCID",
"audience_id",
"contact_id"
]
}
mailchimp_audiences_post_list_member_events
Add event Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
list_id | string | Yes | — | The unique ID for the list. |
subscriber_hash | string | Yes | — | The MD5 hash of the lowercase version of the list member’s email address. This endpoint also accepts a list member’s email address or contact_id. |
is_syncing | boolean | No | — | Events created with the is_syncing value set to true will not trigger automations. |
name | string | Yes | — | The name for this type of event (‘purchased’, ‘visited’, etc). Must be 2-30 characters in length |
occurred_at | string | No | — | The date and time the event occurred in ISO 8601 format. |
properties | object | No | — | An optional list of properties |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"list_id": {
"type": "string",
"description": "The unique ID for the list."
},
"subscriber_hash": {
"type": "string",
"description": "The MD5 hash of the lowercase version of the list member's email address. This endpoint also accepts a list member's email address or contact_id."
},
"is_syncing": {
"type": "boolean",
"description": "Events created with the is_syncing value set to `true` will not trigger automations."
},
"name": {
"type": "string",
"description": "The name for this type of event ('purchased', 'visited', etc). Must be 2-30 characters in length"
},
"occurred_at": {
"type": "string",
"description": "The date and time the event occurred in ISO 8601 format."
},
"properties": {
"type": "object",
"description": "An optional list of properties"
}
},
"required": [
"PCID",
"list_id",
"subscriber_hash",
"name"
]
}
mailchimp_audiences_post_list_member_tags
Add or remove member tags Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
list_id | string | Yes | — | The unique ID for the list. |
subscriber_hash | string | Yes | — | The MD5 hash of the lowercase version of the list member’s email address. |
is_syncing | boolean | No | — | When is_syncing is true, automations based on the tags in the request will not fire |
tags | object[] | Yes | — | A list of tags assigned to the list member. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"list_id": {
"type": "string",
"description": "The unique ID for the list."
},
"subscriber_hash": {
"type": "string",
"description": "The MD5 hash of the lowercase version of the list member's email address."
},
"is_syncing": {
"type": "boolean",
"description": "When is_syncing is true, automations based on the tags in the request will not fire"
},
"tags": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "The name of the tag."
},
"status": {
"type": "string",
"enum": [
"inactive",
"active"
],
"description": "The status for the tag on the member, pass in active to add a tag or inactive to remove it."
}
},
"required": [
"name",
"status"
]
},
"description": "A list of tags assigned to the list member."
}
},
"required": [
"PCID",
"list_id",
"subscriber_hash",
"tags"
]
}
mailchimp_audiences_post_lists
Add list Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
campaign_defaults | object | Yes | — | Default values for campaigns created for this list. |
contact | object | Yes | — | Contact information displayed in campaign footers to comply with international spam laws. |
double_optin | boolean | No | — | Whether or not to require the subscriber to confirm subscription via email. |
email_type_option | boolean | Yes | — | Whether the list supports multiple formats for emails. When set to true, subscribers can choose whether they want to receive HTML or plain-text emails. When set to false, subscribers will receive HTML emails, with a plain-text alternative backup. |
marketing_permissions | boolean | No | — | Whether or not the list has marketing permissions (eg. GDPR) enabled. |
name | string | Yes | — | The name of the list. |
notify_on_subscribe | string | No | — | The email address to send subscribe notifications to. |
notify_on_unsubscribe | string | No | — | The email address to send unsubscribe notifications to. |
permission_reminder | string | Yes | — | The permission reminder for the list. |
use_archive_bar | boolean | No | — | Whether campaigns for this list use the Archive Bar in archives by default. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"campaign_defaults": {
"type": "object",
"description": "[Default values for campaigns](https://mailchimp.com/help/edit-your-emails-subject-preview-text-from-name-or-from-email-address/) created for this list.",
"properties": {
"from_name": {
"type": "string",
"description": "The default from name for campaigns sent to this list."
},
"from_email": {
"type": "string",
"description": "The default from email for campaigns sent to this list."
},
"subject": {
"type": "string",
"description": "The default subject line for campaigns sent to this list."
},
"language": {
"type": "string",
"description": "The default language for this lists's forms."
}
},
"required": [
"from_name",
"from_email",
"subject",
"language"
]
},
"contact": {
"type": "object",
"description": "[Contact information displayed in campaign footers](https://mailchimp.com/help/about-campaign-footers/) to comply with international spam laws.",
"properties": {
"company": {
"type": "string",
"description": "The company name for the list."
},
"address1": {
"type": "string",
"description": "The street address for the list contact."
},
"address2": {
"type": "string",
"description": "The street address for the list contact."
},
"city": {
"type": "string",
"description": "The city for the list contact."
},
"state": {
"type": "string",
"description": "The state for the list contact."
},
"zip": {
"type": "string",
"description": "The postal or zip code for the list contact."
},
"country": {
"type": "string",
"description": "A two-character ISO3166 country code. Defaults to US if invalid."
},
"phone": {
"type": "string",
"description": "The phone number for the list contact."
}
},
"required": [
"company",
"address1",
"city",
"country"
]
},
"double_optin": {
"type": "boolean",
"description": "Whether or not to require the subscriber to confirm subscription via email."
},
"email_type_option": {
"type": "boolean",
"description": "Whether the list supports [multiple formats for emails](https://mailchimp.com/help/change-audience-name-defaults/). When set to `true`, subscribers can choose whether they want to receive HTML or plain-text emails. When set to `false`, subscribers will receive HTML emails, with a plain-text alternative backup."
},
"marketing_permissions": {
"type": "boolean",
"description": "Whether or not the list has marketing permissions (eg. GDPR) enabled."
},
"name": {
"type": "string",
"description": "The name of the list."
},
"notify_on_subscribe": {
"type": "string",
"description": "The email address to send [subscribe notifications](https://mailchimp.com/help/change-subscribe-and-unsubscribe-notifications/) to."
},
"notify_on_unsubscribe": {
"type": "string",
"description": "The email address to send [unsubscribe notifications](https://mailchimp.com/help/change-subscribe-and-unsubscribe-notifications/) to."
},
"permission_reminder": {
"type": "string",
"description": "The [permission reminder](https://mailchimp.com/help/edit-the-permission-reminder/) for the list."
},
"use_archive_bar": {
"type": "boolean",
"description": "Whether campaigns for this list use the [Archive Bar](https://mailchimp.com/help/about-email-campaign-archives-and-pages/) in archives by default."
}
},
"required": [
"PCID",
"campaign_defaults",
"contact",
"email_type_option",
"name",
"permission_reminder"
]
}
mailchimp_audiences_post_lists_id
Batch subscribe or unsubscribe Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
list_id | string | Yes | — | The unique ID for the list. |
skip_merge_validation | boolean | No | — | If skip_merge_validation is true, member data will be accepted without merge field values, even if the merge field is usually required. This defaults to false. |
skip_duplicate_check | boolean | No | — | If skip_duplicate_check is true, we will ignore duplicates sent in the request when using the batch sub/unsub on the lists endpoint. The status of the first appearance in the request will be saved. This defaults to false. |
members | object[] | Yes | — | An array of objects, each representing an email address and the subscription status for a specific list. Up to 500 members may be added or updated with each API call. |
sync_tags | boolean | No | — | Whether this batch operation will replace all existing tags with tags in request. |
update_existing | boolean | No | — | Whether this batch operation will change existing members’ subscription status. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"list_id": {
"type": "string",
"description": "The unique ID for the list."
},
"skip_merge_validation": {
"type": "boolean",
"description": "If skip_merge_validation is true, member data will be accepted without merge field values, even if the merge field is usually required. This defaults to false."
},
"skip_duplicate_check": {
"type": "boolean",
"description": "If skip_duplicate_check is true, we will ignore duplicates sent in the request when using the batch sub/unsub on the lists endpoint. The status of the first appearance in the request will be saved. This defaults to false."
},
"members": {
"type": "array",
"items": {
"type": "object",
"properties": {
"email_address": {
"type": "string",
"description": "Email address for a subscriber."
},
"email_type": {
"type": "string",
"description": "Type of email this member asked to get ('html' or 'text')."
},
"status": {
"type": "string",
"enum": [
"subscribed",
"unsubscribed",
"cleaned",
"pending",
"transactional"
],
"description": "Subscriber's current status."
},
"merge_fields": {
"type": "object",
"description": "A dictionary of merge fields where the keys are the merge tags. See the [Merge Fields documentation](https://mailchimp.com/developer/marketing/docs/merge-fields/#structure) for more about the structure."
},
"interests": {
"type": "object",
"description": "The key of this object's properties is the ID of the interest in question."
},
"language": {
"type": "string",
"description": "If set/detected, the [subscriber's language](https://mailchimp.com/help/view-and-edit-contact-languages/)."
},
"vip": {
"type": "boolean",
"description": "[VIP status](https://mailchimp.com/help/designate-and-send-to-vip-contacts/) for subscriber."
},
"location": {
"type": "object",
"description": "Subscriber location information."
},
"ip_signup": {
"type": "string",
"description": "IP address the subscriber signed up from."
},
"timestamp_signup": {
"type": "string",
"format": "date-time",
"description": "The date and time the subscriber signed up for the list in ISO 8601 format."
},
"ip_opt": {
"type": "string",
"description": "The IP address the subscriber used to confirm their opt-in status."
},
"timestamp_opt": {
"type": "string",
"format": "date-time",
"description": "The date and time the subscriber confirmed their opt-in status in ISO 8601 format."
}
}
},
"description": "An array of objects, each representing an email address and the subscription status for a specific list. Up to 500 members may be added or updated with each API call."
},
"sync_tags": {
"type": "boolean",
"description": "Whether this batch operation will replace all existing tags with tags in request."
},
"update_existing": {
"type": "boolean",
"description": "Whether this batch operation will change existing members' subscription status."
}
},
"required": [
"PCID",
"list_id",
"members"
]
}
mailchimp_audiences_post_lists_id_members
Add member to list Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
list_id | string | Yes | — | The unique ID for the list. |
skip_merge_validation | boolean | No | — | If skip_merge_validation is true, member data will be accepted without merge field values, even if the merge field is usually required. This defaults to false. |
email_address | string | Yes | — | Email address for a subscriber. |
email_type | string | No | — | Type of email this member asked to get (‘html’ or ‘text’). |
interests | object | No | — | The key of this object’s properties is the ID of the interest in question. |
ip_opt | string | No | — | The IP address the subscriber used to confirm their opt-in status. |
ip_signup | string | No | — | IP address the subscriber signed up from. |
language | string | No | — | If set/detected, the subscriber’s language. |
location | object | No | — | Subscriber location information. |
marketing_permissions | object[] | No | — | The marketing permissions for the subscriber. |
merge_fields | object | No | — | A dictionary of merge fields where the keys are the merge tags. See the Merge Fields documentation for more about the structure. |
status | string | Yes | — | Subscriber’s current status. |
tags | string[] | No | — | The tags that are associated with a member. |
timestamp_opt | string | No | — | The date and time the subscriber confirmed their opt-in status in ISO 8601 format. |
timestamp_signup | string | No | — | The date and time the subscriber signed up for the list in ISO 8601 format. |
vip | boolean | No | — | VIP status for subscriber. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"list_id": {
"type": "string",
"description": "The unique ID for the list."
},
"skip_merge_validation": {
"type": "boolean",
"description": "If skip_merge_validation is true, member data will be accepted without merge field values, even if the merge field is usually required. This defaults to false."
},
"email_address": {
"type": "string",
"description": "Email address for a subscriber."
},
"email_type": {
"type": "string",
"description": "Type of email this member asked to get ('html' or 'text')."
},
"interests": {
"type": "object",
"description": "The key of this object's properties is the ID of the interest in question."
},
"ip_opt": {
"type": "string",
"description": "The IP address the subscriber used to confirm their opt-in status."
},
"ip_signup": {
"type": "string",
"description": "IP address the subscriber signed up from."
},
"language": {
"type": "string",
"description": "If set/detected, the [subscriber's language](https://mailchimp.com/help/view-and-edit-contact-languages/)."
},
"location": {
"type": "object",
"description": "Subscriber location information.",
"properties": {
"latitude": {
"type": "number",
"description": "The location latitude."
},
"longitude": {
"type": "number",
"description": "The location longitude."
}
}
},
"marketing_permissions": {
"type": "array",
"items": {
"type": "object",
"properties": {
"marketing_permission_id": {
"type": "string",
"description": "The id for the marketing permission on the list"
},
"enabled": {
"type": "boolean",
"description": "If the subscriber has opted-in to the marketing permission."
}
}
},
"description": "The marketing permissions for the subscriber."
},
"merge_fields": {
"type": "object",
"description": "A dictionary of merge fields where the keys are the merge tags. See the [Merge Fields documentation](https://mailchimp.com/developer/marketing/docs/merge-fields/#structure) for more about the structure."
},
"status": {
"type": "string",
"description": "Subscriber's current status.",
"enum": [
"subscribed",
"unsubscribed",
"cleaned",
"pending",
"transactional"
]
},
"tags": {
"type": "array",
"items": {
"type": "string"
},
"description": "The tags that are associated with a member."
},
"timestamp_opt": {
"type": "string",
"description": "The date and time the subscriber confirmed their opt-in status in ISO 8601 format."
},
"timestamp_signup": {
"type": "string",
"description": "The date and time the subscriber signed up for the list in ISO 8601 format."
},
"vip": {
"type": "boolean",
"description": "[VIP status](https://mailchimp.com/help/designate-and-send-to-vip-contacts/) for subscriber."
}
},
"required": [
"PCID",
"list_id",
"email_address",
"status"
]
}
mailchimp_audiences_post_lists_id_members_hash_actions_delete_permanent
Delete list member Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
list_id | string | Yes | — | The unique ID for the list. |
subscriber_hash | string | Yes | — | The MD5 hash of the lowercase version of the list member’s email address. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"list_id": {
"type": "string",
"description": "The unique ID for the list."
},
"subscriber_hash": {
"type": "string",
"description": "The MD5 hash of the lowercase version of the list member's email address."
}
},
"required": [
"PCID",
"list_id",
"subscriber_hash"
]
}
mailchimp_audiences_post_lists_id_merge_fields
Add merge field Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
list_id | string | Yes | — | The unique ID for the list. |
default_value | string | No | — | The default value for the merge field if null. |
display_order | integer | No | — | The order that the merge field displays on the list signup form. |
help_text | string | No | — | Extra text to help the subscriber fill out the form. |
name | string | Yes | — | The name of the merge field (audience field). |
options | object | No | — | Extra options for some merge field types. |
public | boolean | No | — | Whether the merge field is displayed on the signup form. |
required | boolean | No | — | Whether the merge field is required to import a contact. |
tag | string | No | — | The merge tag used for Mailchimp campaigns and adding contact information. |
type | string | Yes | — | The type for the merge field. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"list_id": {
"type": "string",
"description": "The unique ID for the list."
},
"default_value": {
"type": "string",
"description": "The default value for the merge field if `null`."
},
"display_order": {
"type": "integer",
"description": "The order that the merge field displays on the list signup form."
},
"help_text": {
"type": "string",
"description": "Extra text to help the subscriber fill out the form."
},
"name": {
"type": "string",
"description": "The name of the merge field (audience field)."
},
"options": {
"type": "object",
"description": "Extra options for some merge field types.",
"properties": {
"default_country": {
"type": "integer",
"description": "In an address field, the default country code if none supplied."
},
"phone_format": {
"type": "string",
"description": "In a phone field, the phone number type: US or International."
},
"date_format": {
"type": "string",
"description": "In a date or birthday field, the format of the date."
},
"choices": {
"type": "array",
"items": {
"type": "string"
},
"description": "In a radio or dropdown non-group field, the available options for contacts to pick from."
},
"size": {
"type": "integer",
"description": "In a text field, the default length of the text field."
}
}
},
"public": {
"type": "boolean",
"description": "Whether the merge field is displayed on the signup form."
},
"required": {
"type": "boolean",
"description": "Whether the merge field is required to import a contact."
},
"tag": {
"type": "string",
"description": "The merge tag used for Mailchimp campaigns and [adding contact information](https://mailchimp.com/developer/marketing/docs/merge-fields/#add-merge-data-to-contacts)."
},
"type": {
"type": "string",
"description": "The [type](https://mailchimp.com/developer/marketing/docs/merge-fields/#structure) for the merge field.",
"enum": [
"text",
"number",
"address",
"phone",
"date",
"url",
"imageurl",
"radio",
"dropdown",
"birthday",
"zip"
]
}
},
"required": [
"PCID",
"list_id",
"name",
"type"
]
}
mailchimp_audiences_post_lists_id_segments
Add segment Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
list_id | string | Yes | — | The unique ID for the list. |
name | string | Yes | — | The name of the segment. |
options | object | No | — | The conditions of the segment. Static and fuzzy segments don’t have conditions. |
static_segment | string[] | No | — | An array of emails to be used for a static segment. Any emails provided that are not present on the list will be ignored. Passing an empty array will create a static segment without any subscribers. This field cannot be provided with the options field. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"list_id": {
"type": "string",
"description": "The unique ID for the list."
},
"name": {
"type": "string",
"description": "The name of the segment."
},
"options": {
"type": "object",
"description": "The [conditions of the segment](https://mailchimp.com/help/save-and-manage-segments/). Static and fuzzy segments don't have conditions.",
"properties": {
"match": {
"type": "string",
"description": "Match type.",
"enum": [
"any",
"all"
]
},
"conditions": {
"type": "array",
"items": {
"type": "object"
},
"description": "Segment match conditions. There are multiple possible types, see the [condition types documentation](https://mailchimp.com/developer/marketing/docs/alternative-schemas/#segment-condition-schemas)."
}
}
},
"static_segment": {
"type": "array",
"items": {
"type": "string"
},
"description": "An array of emails to be used for a static segment. Any emails provided that are not present on the list will be ignored. Passing an empty array will create a static segment without any subscribers. This field cannot be provided with the options field."
}
},
"required": [
"PCID",
"list_id",
"name"
]
}
mailchimp_audiences_post_lists_id_segments_id
Batch add or remove members Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
list_id | string | Yes | — | The unique ID for the list. |
segment_id | string | Yes | — | The unique id for the segment. |
members_to_add | string[] | No | — | An array of emails to be used for a static segment. Any emails provided that are not present on the list will be ignored. A maximum of 500 members can be sent. |
members_to_remove | string[] | No | — | An array of emails to be used for a static segment. Any emails provided that are not present on the list will be ignored. A maximum of 500 members can be sent. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"list_id": {
"type": "string",
"description": "The unique ID for the list."
},
"segment_id": {
"type": "string",
"description": "The unique id for the segment."
},
"members_to_add": {
"type": "array",
"items": {
"type": "string"
},
"description": "An array of emails to be used for a static segment. Any emails provided that are not present on the list will be ignored. A maximum of 500 members can be sent."
},
"members_to_remove": {
"type": "array",
"items": {
"type": "string"
},
"description": "An array of emails to be used for a static segment. Any emails provided that are not present on the list will be ignored. A maximum of 500 members can be sent."
}
},
"required": [
"PCID",
"list_id",
"segment_id"
]
}
mailchimp_audiences_post_lists_id_segments_id_members
Add member to segment Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
list_id | string | Yes | — | The unique ID for the list. |
segment_id | string | Yes | — | The unique id for the segment. |
email_address | string | Yes | — | Email address for a subscriber. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"list_id": {
"type": "string",
"description": "The unique ID for the list."
},
"segment_id": {
"type": "string",
"description": "The unique id for the segment."
},
"email_address": {
"type": "string",
"description": "Email address for a subscriber."
}
},
"required": [
"PCID",
"list_id",
"segment_id",
"email_address"
]
}
mailchimp_audiences_post_lists_id_surveys_id_actions_create_email
Create a Survey Campaign Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
list_id | string | Yes | — | The unique ID for the list. |
survey_id | string | Yes | — | The ID of the survey. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"list_id": {
"type": "string",
"description": "The unique ID for the list."
},
"survey_id": {
"type": "string",
"description": "The ID of the survey."
}
},
"required": [
"PCID",
"list_id",
"survey_id"
]
}
mailchimp_audiences_post_lists_id_surveys_id_actions_publish
Publish a Survey Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
list_id | string | Yes | — | The unique ID for the list. |
survey_id | string | Yes | — | The ID of the survey. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"list_id": {
"type": "string",
"description": "The unique ID for the list."
},
"survey_id": {
"type": "string",
"description": "The ID of the survey."
}
},
"required": [
"PCID",
"list_id",
"survey_id"
]
}
mailchimp_audiences_post_lists_id_surveys_id_actions_unpublish
Unpublish a Survey Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
list_id | string | Yes | — | The unique ID for the list. |
survey_id | string | Yes | — | The ID of the survey. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"list_id": {
"type": "string",
"description": "The unique ID for the list."
},
"survey_id": {
"type": "string",
"description": "The ID of the survey."
}
},
"required": [
"PCID",
"list_id",
"survey_id"
]
}
mailchimp_audiences_preview_asegment
List segments Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
fields | string[] | No | — | A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation. |
exclude_fields | string[] | No | — | A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation. |
count | integer | No | — | The number of records to return. Default value is 10. Maximum value is 1000 |
offset | integer | No | — | Used for pagination, this is the number of records from a collection to skip. Default value is 0. |
list_id | string | Yes | — | The unique ID for the list. |
type | string | No | — | Limit results based on segment type. |
since_created_at | string | No | — | Restrict results to segments created after the set time. Uses ISO 8601 time format: 2015-10-21T15:41:36+00:00. |
before_created_at | string | No | — | Restrict results to segments created before the set time. Uses ISO 8601 time format: 2015-10-21T15:41:36+00:00. |
include_cleaned | boolean | No | — | Include cleaned members in response |
include_transactional | boolean | No | — | Include transactional members in response |
include_unsubscribed | boolean | No | — | Include unsubscribed members in response |
since_updated_at | string | No | — | Restrict results to segments update after the set time. Uses ISO 8601 time format: 2015-10-21T15:41:36+00:00. |
before_updated_at | string | No | — | Restrict results to segments update before the set time. Uses ISO 8601 time format: 2015-10-21T15:41:36+00:00. |
exclude_type | string | No | — | Exclude results based on segment type. For example, use exclude_type=static to exclude tags from the response. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"fields": {
"type": "array",
"items": {
"type": "string"
},
"description": "A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation."
},
"exclude_fields": {
"type": "array",
"items": {
"type": "string"
},
"description": "A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation."
},
"count": {
"type": "integer",
"description": "The number of records to return. Default value is 10. Maximum value is 1000"
},
"offset": {
"type": "integer",
"description": "Used for [pagination](https://mailchimp.com/developer/marketing/docs/methods-parameters/#pagination), this is the number of records from a collection to skip. Default value is 0."
},
"list_id": {
"type": "string",
"description": "The unique ID for the list."
},
"type": {
"type": "string",
"description": "Limit results based on segment type."
},
"since_created_at": {
"type": "string",
"description": "Restrict results to segments created after the set time. Uses ISO 8601 time format: 2015-10-21T15:41:36+00:00."
},
"before_created_at": {
"type": "string",
"description": "Restrict results to segments created before the set time. Uses ISO 8601 time format: 2015-10-21T15:41:36+00:00."
},
"include_cleaned": {
"type": "boolean",
"description": "Include cleaned members in response"
},
"include_transactional": {
"type": "boolean",
"description": "Include transactional members in response"
},
"include_unsubscribed": {
"type": "boolean",
"description": "Include unsubscribed members in response"
},
"since_updated_at": {
"type": "string",
"description": "Restrict results to segments update after the set time. Uses ISO 8601 time format: 2015-10-21T15:41:36+00:00."
},
"before_updated_at": {
"type": "string",
"description": "Restrict results to segments update before the set time. Uses ISO 8601 time format: 2015-10-21T15:41:36+00:00."
},
"exclude_type": {
"type": "string",
"description": "Exclude results based on segment type. For example, use `exclude_type=static` to exclude tags from the response.",
"enum": [
"saved",
"static",
"fuzzy"
]
}
},
"required": [
"PCID",
"list_id"
]
}
mailchimp_audiences_put_lists_id_members_id
Add or update list member Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
list_id | string | Yes | — | The unique ID for the list. |
subscriber_hash | string | Yes | — | The MD5 hash of the lowercase version of the list member’s email address. This endpoint also accepts a list member’s email address or contact_id. |
skip_merge_validation | boolean | No | — | If skip_merge_validation is true, member data will be accepted without merge field values, even if the merge field is usually required. This defaults to false. |
email_address | string | Yes | — | Email address for a subscriber. This value is required only if the email address is not already present on the list. |
email_type | string | No | — | Type of email this member asked to get (‘html’ or ‘text’). |
interests | object | No | — | The key of this object’s properties is the ID of the interest in question. |
ip_opt | string | No | — | The IP address the subscriber used to confirm their opt-in status. |
ip_signup | string | No | — | IP address the subscriber signed up from. |
language | string | No | — | If set/detected, the subscriber’s language. |
location | object | No | — | Subscriber location information. |
marketing_permissions | object[] | No | — | The marketing permissions for the subscriber. |
merge_fields | object | No | — | A dictionary of merge fields where the keys are the merge tags. See the Merge Fields documentation for more about the structure. |
status | string | No | — | Subscriber’s current status. |
status_if_new | string | Yes | — | Subscriber’s status. This value is required only if the email address is not already present on the list. |
timestamp_opt | string | No | — | The date and time the subscriber confirmed their opt-in status in ISO 8601 format. |
timestamp_signup | string | No | — | The date and time the subscriber signed up for the list in ISO 8601 format. |
vip | boolean | No | — | VIP status for subscriber. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"list_id": {
"type": "string",
"description": "The unique ID for the list."
},
"subscriber_hash": {
"type": "string",
"description": "The MD5 hash of the lowercase version of the list member's email address. This endpoint also accepts a list member's email address or contact_id."
},
"skip_merge_validation": {
"type": "boolean",
"description": "If skip_merge_validation is true, member data will be accepted without merge field values, even if the merge field is usually required. This defaults to false."
},
"email_address": {
"type": "string",
"description": "Email address for a subscriber. This value is required only if the email address is not already present on the list."
},
"email_type": {
"type": "string",
"description": "Type of email this member asked to get ('html' or 'text')."
},
"interests": {
"type": "object",
"description": "The key of this object's properties is the ID of the interest in question."
},
"ip_opt": {
"type": "string",
"description": "The IP address the subscriber used to confirm their opt-in status."
},
"ip_signup": {
"type": "string",
"description": "IP address the subscriber signed up from."
},
"language": {
"type": "string",
"description": "If set/detected, the [subscriber's language](https://mailchimp.com/help/view-and-edit-contact-languages/)."
},
"location": {
"type": "object",
"description": "Subscriber location information.",
"properties": {
"latitude": {
"type": "number",
"description": "The location latitude."
},
"longitude": {
"type": "number",
"description": "The location longitude."
}
}
},
"marketing_permissions": {
"type": "array",
"items": {
"type": "object",
"properties": {
"marketing_permission_id": {
"type": "string",
"description": "The id for the marketing permission on the list"
},
"enabled": {
"type": "boolean",
"description": "If the subscriber has opted-in to the marketing permission."
}
}
},
"description": "The marketing permissions for the subscriber."
},
"merge_fields": {
"type": "object",
"description": "A dictionary of merge fields where the keys are the merge tags. See the [Merge Fields documentation](https://mailchimp.com/developer/marketing/docs/merge-fields/#structure) for more about the structure."
},
"status": {
"type": "string",
"description": "Subscriber's current status.",
"enum": [
"subscribed",
"unsubscribed",
"cleaned",
"pending",
"transactional"
]
},
"status_if_new": {
"type": "string",
"description": "Subscriber's status. This value is required only if the email address is not already present on the list.",
"enum": [
"subscribed",
"unsubscribed",
"cleaned",
"pending",
"transactional"
]
},
"timestamp_opt": {
"type": "string",
"description": "The date and time the subscriber confirmed their opt-in status in ISO 8601 format."
},
"timestamp_signup": {
"type": "string",
"description": "The date and time the subscriber signed up for the list in ISO 8601 format."
},
"vip": {
"type": "boolean",
"description": "[VIP status](https://mailchimp.com/help/designate-and-send-to-vip-contacts/) for subscriber."
}
},
"required": [
"PCID",
"list_id",
"subscriber_hash",
"email_address",
"status_if_new"
]
}
mailchimp_audiences_search_tags_by_name
Search for tags on a list by name. Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
list_id | string | Yes | — | The unique ID for the list. |
name | string | No | — | The search query used to filter tags. The search query will be compared to each tag as a prefix, so all tags that have a name starting with this field will be returned. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"list_id": {
"type": "string",
"description": "The unique ID for the list."
},
"name": {
"type": "string",
"description": "The search query used to filter tags. The search query will be compared to each tag as a prefix, so all tags that have a name starting with this field will be returned."
}
},
"required": [
"PCID",
"list_id"
]
}