Mailchimp Marketing Connector 1.0 Reference
Configurations
Config
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Name |
String |
Name for this configuration. Connectors reference the configuration with this name. |
x |
|
Connection |
Connection types for this configuration. |
x |
||
Response Timeout |
Number |
How long Mule waits for a response to complete before the request times out. |
60 |
|
Response Timeout Unit |
Enumeration, one of:
|
Time unit for the Response Timeout field. |
SECONDS |
|
Streaming Type |
Enumeration, one of:
|
How the connector streams request content to the remote service: * Connector automatically uses the best streaming strategy based on the request content. * Connector always streams the request content. * Connector does not stream the request content. |
AUTO |
|
Name |
String |
ID used to reference this configuration. |
x |
|
Expiration Policy |
Configures the minimum amount of time that a dynamic configuration instance can remain idle before Mule considers it eligible for expiration. |
Connection Types
Api Key Connection Provider
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Default Headers |
Array of Default Header. |
Default headers for this type. |
||
Query Parameters |
Array of Default Query Param. |
Query parameters for this type. |
||
Connection Timeout |
Number |
How long the connector waits before timing out when establishing a connection to the remote service. |
30 |
|
Connection Timeout Unit |
Enumeration, one of:
|
Time unit for the Connection Timeout field. |
SECONDS |
|
Use Persistent Connections |
Boolean |
Indicates whether to use persistent connections: * Mule uses persistent connections. * Mule closes the connection after the first request completes. |
true |
|
Max Connections |
Number |
Maximum number of connections to open to the backend. HTTP requests are sent in parallel over multiple connections. Setting this value too high can impact latency and consume additional resources without increasing throughput. |
-1 |
|
Connection Idle Timeout |
Number |
When persistent connections are enabled, how long a connection can remain idle before Mule closes it. |
30 |
|
Connection Idle Timeout Unit |
Enumeration, one of:
|
Time unit for the Connection Idle Timeout field. |
SECONDS |
|
Proxy Config |
Configures a proxy for outbound connections. |
|||
Stream Response |
Boolean |
If this value is |
false |
|
Response Buffer Size |
Number |
Size of the buffer that stores the HTTP response, in bytes. |
-1 |
|
Base Uri |
String |
Parameter base URI. Each instance or tenant gets its own parameter base URI. |
||
Authorization |
String |
Authorization. |
||
TLS Configuration |
Configures TLS. If using the HTTPS protocol, you must configure TLS. |
|||
Reconnection |
Configures a reconnection strategy to use when a connector operation fails to connect to an external server. |
OAuth Authorization Code Connection Provider
Use OAuth 2.0 to delegate user authentication to the service hosting the user account. For more information, refer to Configuring OAuth 2.0 for Connectors or Configuring OAuth 2.0 for Connectors on CloudHub.
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Default Headers |
Array of Default Header. |
Default headers for this type. |
||
Query Parameters |
Array of Default Query Param. |
Query parameters for this type. |
||
Connection Timeout |
Number |
How long the connector waits before timing out when establishing a connection to the remote service. |
30 |
|
Connection Timeout Unit |
Enumeration, one of:
|
Time unit for the Connection Timeout field. |
SECONDS |
|
Use Persistent Connections |
Boolean |
Indicates whether to use persistent connections: * Mule uses persistent connections. * Mule closes the connection after the first request completes. |
true |
|
Max Connections |
Number |
Maximum number of connections to open to the backend. HTTP requests are sent in parallel over multiple connections. Setting this value too high can impact latency and consume additional resources without increasing throughput. |
-1 |
|
Connection Idle Timeout |
Number |
When persistent connections are enabled, how long a connection can remain idle before Mule closes it. |
30 |
|
Connection Idle Timeout Unit |
Enumeration, one of:
|
Time unit for the Connection Idle Timeout field. |
SECONDS |
|
Proxy Config |
Configures a proxy for outbound connections. |
|||
Stream Response |
Boolean |
If this value is |
false |
|
Response Buffer Size |
Number |
Size of the buffer that stores the HTTP response, in bytes. |
-1 |
|
Base Uri |
String |
Parameter base URI. Each instance or tenant gets its own parameter base URI. |
||
TLS Configuration |
Configures TLS. If using the HTTPS protocol, you must configure TLS. |
|||
Reconnection |
Configures a reconnection strategy to use when a connector operation fails to connect to an external server. |
|||
Consumer Key |
String |
OAuth consumer key, as registered with the service provider. |
x |
|
Consumer Secret |
String |
OAuth consumer secret, as registered with the service provider. |
x |
|
Authorization Url |
String |
URL of the service provider’s authorization endpoint. |
||
Access Token Url |
String |
URL of the service provider’s access token endpoint. |
||
Scopes |
String |
OAuth scopes to request during the OAuth dance. This value defaults to the scopes in the annotation. |
||
Resource Owner Id |
String |
Resource owner ID to use with the authorization code grant type. |
||
Before |
String |
Name of the flow to execute immediately before starting the OAuth dance. |
||
After |
String |
Name of the flow to execute immediately after receiving an access token. |
||
Listener Config |
String |
Configuration for the HTTP listener that listens for requests on the access token callback endpoint. |
x |
|
Callback Path |
String |
Path of the access token callback endpoint. |
x |
|
Authorize Path |
String |
Path of the local HTTP endpoint that triggers the OAuth dance. |
x |
|
External Callback Url |
String |
URL that the OAuth provider uses to access the callback endpoint if the endpoint is behind a proxy or accessed through an indirect URL. |
||
Object Store |
String |
Configures the object store that stores data for each resource owner. If not configured, Mule uses the default object store. |
Search campaigns
<mailchimp-marketing-connector-mule-4:get-search-campaigns>
Searches all campaigns for the specified query terms. This operation makes an HTTP GET request to the /search-campaigns endpoint.
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
Name of the configuration to use. |
x |
|
fields |
Array of String |
Comma-separated list of fields to return. You must reference parameters of sub-objects with dot notation. |
||
Exclude fields |
Array of String |
Comma-separated list of fields to exclude. You must reference parameters of sub-objects with dot notation. |
||
query |
String |
Search query used to filter results. |
x |
|
Config Ref |
ConfigurationProvider |
Name of the configuration used to execute this component. |
||
Streaming Strategy |
|
Configures how Mule processes streams. The default is to use repeatable streams. |
||
Custom Query Parameters |
Object |
Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration. |
#[null] |
|
Custom Headers |
Object |
Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration. |
||
Response Timeout |
Number |
How long Mule waits for a response to complete before the request times out. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit for the Response Timeout field. |
||
Streaming Type |
Enumeration, one of:
|
How the connector streams request content to the remote service: * Connector automatically uses the best streaming strategy based on the request content. * Connector always streams the request content. * Connector does not stream the request content. |
AUTO |
|
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field. |
#[payload] |
|
Reconnection Strategy |
Retry strategy in case of connectivity errors. |
Throws
-
MAILCHIMP-MARKETING-CONNECTOR-MULE-4:BAD_REQUEST
-
MAILCHIMP-MARKETING-CONNECTOR-MULE-4:CLIENT_ERROR
-
MAILCHIMP-MARKETING-CONNECTOR-MULE-4:CONNECTIVITY
-
MAILCHIMP-MARKETING-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR
-
MAILCHIMP-MARKETING-CONNECTOR-MULE-4:NOT_ACCEPTABLE
-
MAILCHIMP-MARKETING-CONNECTOR-MULE-4:NOT_FOUND
-
MAILCHIMP-MARKETING-CONNECTOR-MULE-4:RETRY_EXHAUSTED
-
MAILCHIMP-MARKETING-CONNECTOR-MULE-4:SERVER_ERROR
-
MAILCHIMP-MARKETING-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE
-
MAILCHIMP-MARKETING-CONNECTOR-MULE-4:TIMEOUT
-
MAILCHIMP-MARKETING-CONNECTOR-MULE-4:TOO_MANY_REQUESTS
-
MAILCHIMP-MARKETING-CONNECTOR-MULE-4:UNAUTHORIZED
-
MAILCHIMP-MARKETING-CONNECTOR-MULE-4:UNSUPPORTED_MEDIA_TYPE
Search Members
<mailchimp-marketing-connector-mule-4:get-search-members>
Searches for list members. This search can be restricted to a specific list, or can be used to search across all lists in an account. This operation makes an HTTP GET request to the /search-members endpoint.
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
Name of the configuration to use. |
x |
|
fields |
Array of String |
Comma-separated list of fields to return. You must reference parameters of sub-objects with dot notation. |
||
Exclude fields |
Array of String |
Comma-separated list of fields to exclude. You must reference parameters of sub-objects with dot notation. |
||
query |
String |
Search query used to filter results. The query must be a valid email or a string representing a contact’s first or last name. |
x |
|
List ID |
String |
Unique ID for the list. |
||
Config Ref |
ConfigurationProvider |
Name of the configuration used to execute this component. |
||
Streaming Strategy |
|
Configures how Mule processes streams. The default is to use repeatable streams. |
||
Custom Query Parameters |
Object |
Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration. |
#[null] |
|
Custom Headers |
Object |
Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration. |
||
Response Timeout |
Number |
How long Mule waits for a response to complete before the request times out. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit for the Response Timeout field. |
||
Streaming Type |
Enumeration, one of:
|
How the connector streams request content to the remote service: * Connector automatically uses the best streaming strategy based on the request content. * Connector always streams the request content. * Connector does not stream the request content. |
AUTO |
|
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field. |
#[payload] |
|
Reconnection Strategy |
Retry strategy in case of connectivity errors. |
Throws
-
MAILCHIMP-MARKETING-CONNECTOR-MULE-4:BAD_REQUEST
-
MAILCHIMP-MARKETING-CONNECTOR-MULE-4:CLIENT_ERROR
-
MAILCHIMP-MARKETING-CONNECTOR-MULE-4:CONNECTIVITY
-
MAILCHIMP-MARKETING-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR
-
MAILCHIMP-MARKETING-CONNECTOR-MULE-4:NOT_ACCEPTABLE
-
MAILCHIMP-MARKETING-CONNECTOR-MULE-4:NOT_FOUND
-
MAILCHIMP-MARKETING-CONNECTOR-MULE-4:RETRY_EXHAUSTED
-
MAILCHIMP-MARKETING-CONNECTOR-MULE-4:SERVER_ERROR
-
MAILCHIMP-MARKETING-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE
-
MAILCHIMP-MARKETING-CONNECTOR-MULE-4:TIMEOUT
-
MAILCHIMP-MARKETING-CONNECTOR-MULE-4:TOO_MANY_REQUESTS
-
MAILCHIMP-MARKETING-CONNECTOR-MULE-4:UNAUTHORIZED
-
MAILCHIMP-MARKETING-CONNECTOR-MULE-4:UNSUPPORTED_MEDIA_TYPE
Add campaign
<mailchimp-marketing-connector-mule-4:post-campaigns>
Creates a new Mailchimp campaign. This operation makes an HTTP POST request to the /campaigns endpoint.
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
Name of the configuration to use. |
x |
|
Body |
Any |
Content to use. |
#[payload] |
|
Config Ref |
ConfigurationProvider |
Name of the configuration used to execute this component. |
||
Streaming Strategy |
|
Configures how Mule processes streams. The default is to use repeatable streams. |
||
Custom Query Parameters |
Object |
Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration. |
||
Custom Headers |
Object |
Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration. |
||
Response Timeout |
Number |
How long Mule waits for a response to complete before the request times out. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit for the Response Timeout field. |
||
Streaming Type |
Enumeration, one of:
|
How the connector streams request content to the remote service: * Connector automatically uses the best streaming strategy based on the request content. * Connector always streams the request content. * Connector does not stream the request content. |
AUTO |
|
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field. |
#[payload] |
|
Reconnection Strategy |
Retry strategy in case of connectivity errors. |
Throws
-
MAILCHIMP-MARKETING-CONNECTOR-MULE-4:BAD_REQUEST
-
MAILCHIMP-MARKETING-CONNECTOR-MULE-4:CLIENT_ERROR
-
MAILCHIMP-MARKETING-CONNECTOR-MULE-4:CONNECTIVITY
-
MAILCHIMP-MARKETING-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR
-
MAILCHIMP-MARKETING-CONNECTOR-MULE-4:NOT_ACCEPTABLE
-
MAILCHIMP-MARKETING-CONNECTOR-MULE-4:NOT_FOUND
-
MAILCHIMP-MARKETING-CONNECTOR-MULE-4:RETRY_EXHAUSTED
-
MAILCHIMP-MARKETING-CONNECTOR-MULE-4:SERVER_ERROR
-
MAILCHIMP-MARKETING-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE
-
MAILCHIMP-MARKETING-CONNECTOR-MULE-4:TIMEOUT
-
MAILCHIMP-MARKETING-CONNECTOR-MULE-4:TOO_MANY_REQUESTS
-
MAILCHIMP-MARKETING-CONNECTOR-MULE-4:UNAUTHORIZED
-
MAILCHIMP-MARKETING-CONNECTOR-MULE-4:UNSUPPORTED_MEDIA_TYPE
Send campaign
<mailchimp-marketing-connector-mule-4:post-campaigns-id-actions-send>
Sends a Mailchimp campaign. For RSS campaigns, the campaign is sent according to its schedule. All other campaigns are sent immediately. This operation makes an HTTP POST request to the /campaigns/{campaign_id}/actions/send endpoint.
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
Name of the configuration to use. |
x |
|
Campaign ID |
String |
Unique ID for the campaign. |
x |
|
Config Ref |
ConfigurationProvider |
Name of the configuration used to execute this component. |
||
Streaming Strategy |
|
Configures how Mule processes streams. The default is to use repeatable streams. |
||
Custom Query Parameters |
Object |
Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration. |
#[null] |
|
Custom Headers |
Object |
Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration. |
||
Response Timeout |
Number |
How long Mule waits for a response to complete before the request times out. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit for the Response Timeout field. |
||
Streaming Type |
Enumeration, one of:
|
How the connector streams request content to the remote service: * Connector automatically uses the best streaming strategy based on the request content. * Connector always streams the request content. * Connector does not stream the request content. |
AUTO |
|
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field. |
#[payload] |
|
Reconnection Strategy |
Retry strategy in case of connectivity errors. |
Throws
-
MAILCHIMP-MARKETING-CONNECTOR-MULE-4:BAD_REQUEST
-
MAILCHIMP-MARKETING-CONNECTOR-MULE-4:CLIENT_ERROR
-
MAILCHIMP-MARKETING-CONNECTOR-MULE-4:CONNECTIVITY
-
MAILCHIMP-MARKETING-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR
-
MAILCHIMP-MARKETING-CONNECTOR-MULE-4:NOT_ACCEPTABLE
-
MAILCHIMP-MARKETING-CONNECTOR-MULE-4:NOT_FOUND
-
MAILCHIMP-MARKETING-CONNECTOR-MULE-4:RETRY_EXHAUSTED
-
MAILCHIMP-MARKETING-CONNECTOR-MULE-4:SERVER_ERROR
-
MAILCHIMP-MARKETING-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE
-
MAILCHIMP-MARKETING-CONNECTOR-MULE-4:TIMEOUT
-
MAILCHIMP-MARKETING-CONNECTOR-MULE-4:TOO_MANY_REQUESTS
-
MAILCHIMP-MARKETING-CONNECTOR-MULE-4:UNAUTHORIZED
-
MAILCHIMP-MARKETING-CONNECTOR-MULE-4:UNSUPPORTED_MEDIA_TYPE
Add or remove member tags
<mailchimp-marketing-connector-mule-4:post-list-member-tags>
Adds a tag to a list member or removes a tag from a list member. If a tag that does not exist gets passed in and is set to active
, a new tag will be created. This operation makes an HTTP POST request to the /lists/{list_id}/members/{subscriber_hash}/tags endpoint.
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
Name of the configuration to use. |
x |
|
List ID |
String |
Unique ID for the list. |
x |
|
Subscriber hash |
String |
MD5 hash of the list member’s email address in lowercase. |
x |
|
Body |
Any |
Content to use. |
#[payload] |
|
Config Ref |
ConfigurationProvider |
Name of the configuration used to execute this component. |
||
Streaming Strategy |
|
Configures how Mule processes streams. The default is to use repeatable streams. |
||
Custom Query Parameters |
Object |
Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration. |
||
Custom Headers |
Object |
Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration. |
||
Response Timeout |
Number |
How long Mule waits for a response to complete before the request times out. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit for the Response Timeout field. |
||
Streaming Type |
Enumeration, one of:
|
How the connector streams request content to the remote service: * Connector automatically uses the best streaming strategy based on the request content. * Connector always streams the request content. * Connector does not stream the request content. |
AUTO |
|
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field. |
#[payload] |
|
Reconnection Strategy |
Retry strategy in case of connectivity errors. |
Throws
-
MAILCHIMP-MARKETING-CONNECTOR-MULE-4:BAD_REQUEST
-
MAILCHIMP-MARKETING-CONNECTOR-MULE-4:CLIENT_ERROR
-
MAILCHIMP-MARKETING-CONNECTOR-MULE-4:CONNECTIVITY
-
MAILCHIMP-MARKETING-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR
-
MAILCHIMP-MARKETING-CONNECTOR-MULE-4:NOT_ACCEPTABLE
-
MAILCHIMP-MARKETING-CONNECTOR-MULE-4:NOT_FOUND
-
MAILCHIMP-MARKETING-CONNECTOR-MULE-4:RETRY_EXHAUSTED
-
MAILCHIMP-MARKETING-CONNECTOR-MULE-4:SERVER_ERROR
-
MAILCHIMP-MARKETING-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE
-
MAILCHIMP-MARKETING-CONNECTOR-MULE-4:TIMEOUT
-
MAILCHIMP-MARKETING-CONNECTOR-MULE-4:TOO_MANY_REQUESTS
-
MAILCHIMP-MARKETING-CONNECTOR-MULE-4:UNAUTHORIZED
-
MAILCHIMP-MARKETING-CONNECTOR-MULE-4:UNSUPPORTED_MEDIA_TYPE
Add member to list
<mailchimp-marketing-connector-mule-4:post-lists-id-members>
Adds a new member to the list. This operation makes an HTTP POST request to the /lists/{list_id}/members endpoint.
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
Name of the configuration to use. |
x |
|
List ID |
String |
Unique ID for the list. |
x |
|
Skip merge validation |
Boolean |
Indicates whether to accept member data without merge field values: * Accepts member data without merge field values, even if merge field values are required. * Accepts only member data with merge field values. |
false |
|
Body |
Any |
Content to use. |
#[payload] |
|
Config Ref |
ConfigurationProvider |
Name of the configuration used to execute this component. |
||
Streaming Strategy |
|
Configures how Mule processes streams. The default is to use repeatable streams. |
||
Custom Query Parameters |
Object |
Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration. |
||
Custom Headers |
Object |
Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration. |
||
Response Timeout |
Number |
How long Mule waits for a response to complete before the request times out. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit for the Response Timeout field. |
||
Streaming Type |
Enumeration, one of:
|
How the connector streams request content to the remote service: * Connector automatically uses the best streaming strategy based on the request content. * Connector always streams the request content. * Connector does not stream the request content. |
AUTO |
|
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field. |
#[payload] |
|
Reconnection Strategy |
Retry strategy in case of connectivity errors. |
Throws
-
MAILCHIMP-MARKETING-CONNECTOR-MULE-4:BAD_REQUEST
-
MAILCHIMP-MARKETING-CONNECTOR-MULE-4:CLIENT_ERROR
-
MAILCHIMP-MARKETING-CONNECTOR-MULE-4:CONNECTIVITY
-
MAILCHIMP-MARKETING-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR
-
MAILCHIMP-MARKETING-CONNECTOR-MULE-4:NOT_ACCEPTABLE
-
MAILCHIMP-MARKETING-CONNECTOR-MULE-4:NOT_FOUND
-
MAILCHIMP-MARKETING-CONNECTOR-MULE-4:RETRY_EXHAUSTED
-
MAILCHIMP-MARKETING-CONNECTOR-MULE-4:SERVER_ERROR
-
MAILCHIMP-MARKETING-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE
-
MAILCHIMP-MARKETING-CONNECTOR-MULE-4:TIMEOUT
-
MAILCHIMP-MARKETING-CONNECTOR-MULE-4:TOO_MANY_REQUESTS
-
MAILCHIMP-MARKETING-CONNECTOR-MULE-4:UNAUTHORIZED
-
MAILCHIMP-MARKETING-CONNECTOR-MULE-4:UNSUPPORTED_MEDIA_TYPE
Delete list member
<mailchimp-marketing-connector-mule-4:post-lists-id-members-hash-actions-delete-permanent>
Deletes all information about a list member and removes them from the list. It is impossible to reimport the list member after deleting them. This operation makes an HTTP POST request to the /lists/{list_id}/members/{subscriber_hash}/actions/delete-permanent endpoint.
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
Name of the configuration to use. |
x |
|
List ID |
String |
Unique ID for the list. |
x |
|
Subscriber hash |
String |
MD5 hash of the list member’s email address in lowercase. |
x |
|
Config Ref |
ConfigurationProvider |
Name of the configuration used to execute this component. |
||
Streaming Strategy |
|
Configures how Mule processes streams. The default is to use repeatable streams. |
||
Custom Query Parameters |
Object |
Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration. |
#[null] |
|
Custom Headers |
Object |
Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration. |
||
Response Timeout |
Number |
How long Mule waits for a response to complete before the request times out. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit for the Response Timeout field. |
||
Streaming Type |
Enumeration, one of:
|
How the connector streams request content to the remote service: * Connector automatically uses the best streaming strategy based on the request content. * Connector always streams the request content. * Connector does not stream the request content. |
AUTO |
|
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field. |
#[payload] |
|
Reconnection Strategy |
Retry strategy in case of connectivity errors. |
Throws
-
MAILCHIMP-MARKETING-CONNECTOR-MULE-4:BAD_REQUEST
-
MAILCHIMP-MARKETING-CONNECTOR-MULE-4:CLIENT_ERROR
-
MAILCHIMP-MARKETING-CONNECTOR-MULE-4:CONNECTIVITY
-
MAILCHIMP-MARKETING-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR
-
MAILCHIMP-MARKETING-CONNECTOR-MULE-4:NOT_ACCEPTABLE
-
MAILCHIMP-MARKETING-CONNECTOR-MULE-4:NOT_FOUND
-
MAILCHIMP-MARKETING-CONNECTOR-MULE-4:RETRY_EXHAUSTED
-
MAILCHIMP-MARKETING-CONNECTOR-MULE-4:SERVER_ERROR
-
MAILCHIMP-MARKETING-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE
-
MAILCHIMP-MARKETING-CONNECTOR-MULE-4:TIMEOUT
-
MAILCHIMP-MARKETING-CONNECTOR-MULE-4:TOO_MANY_REQUESTS
-
MAILCHIMP-MARKETING-CONNECTOR-MULE-4:UNAUTHORIZED
-
MAILCHIMP-MARKETING-CONNECTOR-MULE-4:UNSUPPORTED_MEDIA_TYPE
Add member note
<mailchimp-marketing-connector-mule-4:post-lists-id-members-id-notes>
Adds a new note for a specific subscriber. This operation makes an HTTP POST request to the /lists/{list_id}/members/{subscriber_hash}/notes endpoint.
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
Name of the configuration to use. |
x |
|
List ID |
String |
Unique ID for the list. |
x |
|
Subscriber hash |
String |
MD5 hash of the list member’s email address in lowercase. |
x |
|
Body |
Any |
Content to use. |
#[payload] |
|
Config Ref |
ConfigurationProvider |
Name of the configuration used to execute this component. |
||
Streaming Strategy |
|
Configures how Mule processes streams. The default is to use repeatable streams. |
||
Custom Query Parameters |
Object |
Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration. |
||
Custom Headers |
Object |
Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration. |
||
Response Timeout |
Number |
How long Mule waits for a response to complete before the request times out. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit for the Response Timeout field. |
||
Streaming Type |
Enumeration, one of:
|
How the connector streams request content to the remote service: * Connector automatically uses the best streaming strategy based on the request content. * Connector always streams the request content. * Connector does not stream the request content. |
AUTO |
|
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field. |
#[payload] |
|
Reconnection Strategy |
Retry strategy in case of connectivity errors. |
Throws
-
MAILCHIMP-MARKETING-CONNECTOR-MULE-4:BAD_REQUEST
-
MAILCHIMP-MARKETING-CONNECTOR-MULE-4:CLIENT_ERROR
-
MAILCHIMP-MARKETING-CONNECTOR-MULE-4:CONNECTIVITY
-
MAILCHIMP-MARKETING-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR
-
MAILCHIMP-MARKETING-CONNECTOR-MULE-4:NOT_ACCEPTABLE
-
MAILCHIMP-MARKETING-CONNECTOR-MULE-4:NOT_FOUND
-
MAILCHIMP-MARKETING-CONNECTOR-MULE-4:RETRY_EXHAUSTED
-
MAILCHIMP-MARKETING-CONNECTOR-MULE-4:SERVER_ERROR
-
MAILCHIMP-MARKETING-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE
-
MAILCHIMP-MARKETING-CONNECTOR-MULE-4:TIMEOUT
-
MAILCHIMP-MARKETING-CONNECTOR-MULE-4:TOO_MANY_REQUESTS
-
MAILCHIMP-MARKETING-CONNECTOR-MULE-4:UNAUTHORIZED
-
MAILCHIMP-MARKETING-CONNECTOR-MULE-4:UNSUPPORTED_MEDIA_TYPE
Update list member
<mailchimp-marketing-connector-mule-4:put-lists-id-members-id>
Adds or updates a list member. This operation makes an HTTP PUT request to the /lists/{list_id}/members/{subscriber_hash} endpoint.
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
Name of the configuration to use. |
x |
|
List ID |
String |
Unique ID for the list. |
x |
|
Subscriber hash |
String |
MD5 hash of the list member’s email address in lowercase. |
x |
|
Skip merge validation |
Boolean |
Indicates whether to accept member data without merge field values: * Accepts member data without merge field values, even if merge field values are required. * Accepts only member data with merge field values. |
false |
|
Body |
Any |
Content to use. |
#[payload] |
|
Config Ref |
ConfigurationProvider |
Name of the configuration used to execute this component. |
||
Streaming Strategy |
|
Configures how Mule processes streams. The default is to use repeatable streams. |
||
Custom Query Parameters |
Object |
Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration. |
||
Custom Headers |
Object |
Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration. |
||
Response Timeout |
Number |
How long Mule waits for a response to complete before the request times out. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit for the Response Timeout field. |
||
Streaming Type |
Enumeration, one of:
|
How the connector streams request content to the remote service: * Connector automatically uses the best streaming strategy based on the request content. * Connector always streams the request content. * Connector does not stream the request content. |
AUTO |
|
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field. |
#[payload] |
|
Reconnection Strategy |
Retry strategy in case of connectivity errors. |
Throws
-
MAILCHIMP-MARKETING-CONNECTOR-MULE-4:BAD_REQUEST
-
MAILCHIMP-MARKETING-CONNECTOR-MULE-4:CLIENT_ERROR
-
MAILCHIMP-MARKETING-CONNECTOR-MULE-4:CONNECTIVITY
-
MAILCHIMP-MARKETING-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR
-
MAILCHIMP-MARKETING-CONNECTOR-MULE-4:NOT_ACCEPTABLE
-
MAILCHIMP-MARKETING-CONNECTOR-MULE-4:NOT_FOUND
-
MAILCHIMP-MARKETING-CONNECTOR-MULE-4:RETRY_EXHAUSTED
-
MAILCHIMP-MARKETING-CONNECTOR-MULE-4:SERVER_ERROR
-
MAILCHIMP-MARKETING-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE
-
MAILCHIMP-MARKETING-CONNECTOR-MULE-4:TIMEOUT
-
MAILCHIMP-MARKETING-CONNECTOR-MULE-4:TOO_MANY_REQUESTS
-
MAILCHIMP-MARKETING-CONNECTOR-MULE-4:UNAUTHORIZED
-
MAILCHIMP-MARKETING-CONNECTOR-MULE-4:UNSUPPORTED_MEDIA_TYPE
Unauthorize
<mailchimp-marketing-connector-mule-4:unauthorize>
Deletes all the access token information of a given resource owner ID so that it’s impossible to execute any operation for that user without first repeating the authorization dance.
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
Name of the configuration to use. |
x |
|
Resource Owner Id |
String |
ID of the resource owner for whom to invalidate access. |
||
Config Ref |
ConfigurationProvider |
Name of the configuration used to execute this component. |
On Email Opened Trigger
<mailchimp-marketing-connector-mule-4:on-email-opened-trigger>
Initiates a flow when an email is created.
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
Name of the configuration to use. |
x |
|
Campaign Id |
String |
Unique ID of the campaign. |
x |
|
Since Date |
String |
Date that a member opened the campaign email. |
x |
|
Config Ref |
ConfigurationProvider |
Name of the configuration used to execute this component. |
||
Primary Node Only |
Boolean |
Determines whether to execute this source on only the primary node when running Mule instances in a cluster. |
||
Scheduling Strategy |
scheduling-strategy |
Configures the scheduler that triggers the polling. |
x |
|
Streaming Strategy |
|
Configures how Mule processes streams. The default is to use repeatable streams. |
||
Redelivery Policy |
Defines a policy for processing the redelivery of the same message. |
|||
Reconnection Strategy |
Retry strategy in case of connectivity errors. |
On New Or Updated Member Trigger
<mailchimp-marketing-connector-mule-4:on-new-or-updated-member-trigger>
Initiates a flow when a member is created or updated.
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
Name of the configuration to use. |
x |
|
List Id |
String |
Unique ID of the list. |
x |
|
Since Date |
String |
Date that a member is created or updated. |
x |
|
Config Ref |
ConfigurationProvider |
Name of the configuration used to execute this component. |
||
Primary Node Only |
Boolean |
Determines whether to execute this source on only the primary node when running Mule instances in a cluster. |
||
Scheduling Strategy |
scheduling-strategy |
Configures the scheduler that triggers the polling. |
x |
|
Streaming Strategy |
|
Configures how Mule processes streams. The default is to use repeatable streams. |
||
Redelivery Policy |
Defines a policy for processing the redelivery of the same message. |
|||
Reconnection Strategy |
Retry strategy in case of connectivity errors. |
On Unsubscribed Member Trigger
<mailchimp-marketing-connector-mule-4:on-unsubscribed-member-trigger>
Initiates a flow when a member unsubscribes from the list.
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
Name of the configuration to use. |
x |
|
List Id |
String |
Unique ID of the list. |
x |
|
Since Date |
String |
Date that a member unsubscribes from the list. |
x |
|
Config Ref |
ConfigurationProvider |
Name of the configuration used to execute this component. |
||
Primary Node Only |
Boolean |
Determines whether to execute this source on only the primary node when running Mule instances in a cluster. |
||
Scheduling Strategy |
scheduling-strategy |
Configures the scheduler that triggers the polling. |
x |
|
Streaming Strategy |
|
Configures how Mule processes streams. The default is to use repeatable streams. |
||
Redelivery Policy |
Defines a policy for processing the redelivery of the same message. |
|||
Reconnection Strategy |
Retry strategy in case of connectivity errors. |
Types
Default Header
Headers automatically added to every outbound request.
Field | Type | Description | Default Value | Required |
---|---|---|---|---|
Key |
String |
Key for this type. |
x |
|
Value |
String |
Value for this type. |
x |
Default Query Param
Query parameters automatically added to every outbound request.
Field | Type | Description | Default Value | Required |
---|---|---|---|---|
Key |
String |
Key for this type. |
x |
|
Value |
String |
Value for this type. |
x |
Proxy
Configures a proxy for outbound connections.
Field | Type | Description | Default Value | Required |
---|---|---|---|---|
Host |
String |
Hostname or IP address of the proxy server. |
x |
|
Port |
Number |
Port of the proxy server. |
x |
|
Username |
String |
Username to authenticate against the proxy server. |
||
Password |
String |
Password to authenticate against the proxy server. |
||
Non Proxy Hosts |
String |
Comma-separated list of hosts that the proxy must not be used against. |
TLS
Configures TLS to provide secure communications for the Mule app.
Field | Type | Description | Default Value | Required |
---|---|---|---|---|
Enabled Protocols |
String |
Comma-separated list of protocols enabled for this context. |
||
Enabled Cipher Suites |
String |
Comma-separated list of cipher suites enabled for this context. |
||
Trust Store |
Configures the TLS truststore. |
|||
Key Store |
Configures the TLS keystore. |
|||
Revocation Check |
Configures a revocation checking mechanism. |
Truststore
Configures the truststore for TLS.
Field | Type | Description | Default Value | Required |
---|---|---|---|---|
Path |
String |
Path to the truststore. Mule resolves the path relative to the current classpath and file system, if possible. |
||
Password |
String |
Password used to protect the truststore. |
||
Type |
String |
Type of truststore. |
||
Algorithm |
String |
Encryption algorithm that the truststore uses. |
||
Insecure |
Boolean |
If |
Keystore
Configures the keystore for the TLS protocol. The keystore you generate contains a private key and a public certificate.
Field | Type | Description | Default Value | Required |
---|---|---|---|---|
Path |
String |
Path to the keystore. Mule resolves the path relative to the current classpath and file system, if possible. |
||
Type |
String |
Type of store used. |
||
Alias |
String |
Alias of the key to use when the keystore contains multiple private keys. By default, Mule uses the first key in the file. |
||
Key Password |
String |
Password used to protect the private key. |
||
Password |
String |
Password used to protect the keystore. |
||
Algorithm |
String |
Encryption algorithm that the keystore uses. |
Standard Revocation Check
Configures standard revocation checks for TLS certificates.
Field | Type | Description | Default Value | Required |
---|---|---|---|---|
Only End Entities |
Boolean |
Which elements to verify in the certificate chain:
|
||
Prefer Crls |
Boolean |
How to check certificate validity:
|
||
No Fallback |
Boolean |
Whether to use the secondary method to check certificate validity:
|
||
Soft Fail |
Boolean |
What to do if the revocation server can’t be reached or is busy:
|
Custom OCSP Responder
Configures a custom OCSP responder for certification revocation checks.
Field | Type | Description | Default Value | Required |
---|---|---|---|---|
Url |
String |
URL of the OCSP responder. |
||
Cert Alias |
String |
Alias of the signing certificate for the OCSP response. If specified, the alias must be in the truststore. |
CRL File
Specifies the location of the certification revocation list (CRL) file.
Field | Type | Description | Default Value | Required |
---|---|---|---|---|
Path |
String |
Path to the CRL file. |
Reconnection
Configures a reconnection strategy for an operation.
Field | Type | Description | Default Value | Required |
---|---|---|---|---|
Fails Deployment |
Boolean |
What to do if, when an app is deployed, a connectivity test does not pass after exhausting the associated reconnection strategy:
|
||
Reconnection Strategy |
Reconnection strategy to use. |
Reconnect
Configures a standard reconnection strategy, which specifies how often to reconnect and how many reconnection attempts the connector source or operation can make.
Field | Type | Description | Default Value | Required |
---|---|---|---|---|
Frequency |
Number |
How often to attempt to reconnect, in milliseconds. |
||
Blocking |
Boolean |
If |
||
Count |
Number |
How many reconnection attempts the Mule app can make. |
Reconnect Forever
Configures a forever reconnection strategy by which the connector source or operation attempts to reconnect at a specified frequency for as long as the Mule app runs.
Field | Type | Description | Default Value | Required |
---|---|---|---|---|
Frequency |
Number |
How often to attempt to reconnect, in milliseconds. |
||
Blocking |
Boolean |
If |
Expiration Policy
Configures an expiration policy for the configuration.
Field | Type | Description | Default Value | Required |
---|---|---|---|---|
Max Idle Time |
Number |
Configures the maximum amount of time that a dynamic configuration instance can remain idle before Mule considers it eligible for expiration. |
||
Time Unit |
Enumeration, one of:
|
Time unit for the Max Idle Time field. |
HTTP Response Attributes
Configures HTTP response attributes for the configuration.
Field | Type | Description | Default Value | Required |
---|---|---|---|---|
Status Code |
Number |
HTTP status code of the response. |
x |
|
Headers |
Object |
Map of HTTP headers in the message. |
x |
|
Reason Phrase |
String |
HTTP reason phrase of the response. |
x |
Repeatable In Memory Stream
Configures the in-memory streaming strategy by which the request fails if the data exceeds the MAX buffer size. Always run performance tests to find the optimal buffer size for your specific use case.
Field | Type | Description | Default Value | Required |
---|---|---|---|---|
Initial Buffer Size |
Number |
Initial amount of memory to allocate to the data stream. If the streamed data exceeds this value, the buffer expands by Buffer Size Increment, with an upper limit of Max In Memory Size value. |
||
Buffer Size Increment |
Number |
Amount by which the buffer size expands if it exceeds its initial size. Setting a value of |
||
Max Buffer Size |
Number |
Maximum size of the buffer. If the buffer size exceeds this value, Mule raises a |
||
Buffer Unit |
Enumeration, one of:
|
Unit for the Initial Buffer Size, Buffer Size Increment, and Buffer Unit fields. |
Repeatable File Store Stream
Configures the repeatable file-store streaming strategy by which Mule keeps a portion of the stream content in memory. If the stream content is larger than the configured buffer size, Mule backs up the buffer’s content to disk and then clears the memory.
Field | Type | Description | Default Value | Required |
---|---|---|---|---|
In Memory Size |
Number |
Maximum amount of memory that the stream can use for data. If the amount of memory exceeds this value, Mule buffers the content to disk. To optimize performance:
|
||
Buffer Unit |
Enumeration, one of:
|
Unit for the In Memory Size field. |
Redelivery Policy
Configures the redelivery policy for executing requests that generate errors. You can add a redelivery policy to any source in a flow.
Field | Type | Description | Default Value | Required |
---|---|---|---|---|
Max Redelivery Count |
Number |
Maximum number of times that a redelivered request can be processed unsuccessfully before returning a REDELIVERY_EXHAUSTED error. |
||
Message Digest Algorithm |
String |
Secure hashing algorithm to use if the Use Secure Hash field is |
||
Message Identifier |
Defines which strategy to use to identify the messages. |
|||
Object Store |
ObjectStore |
Configures the object store that stores the redelivery counter for each message. |
Redelivery Policy Message Identifier
Configures how to identify a redelivered message and how to find out when the message was redelivered.
Field | Type | Description | Default Value | Required |
---|---|---|---|---|
Use Secure Hash |
Boolean |
If |
||
Id Expression |
String |
One or more expressions that determine when a message was redelivered. You can set this property only if the Use Secure Hash field is |