V2NodesMailchimp Marketing
Mailchimp Marketing
V2

Mailchimp Marketing

Provides integration with Mailchimp Marketing to manage audiences, members, campaigns, templates, reports, and search operations through the Marketing API.

Revision History

0.0.0.3 - Initial release.

Connection

Use this Connection to store the OAuth or API-key credentials and Mailchimp data-center prefix used by all Node methods.

Property Type Description
Authentication Type MailchimpAuthenticationType Authentication method. Select OAuth or ApiKey. Defaults to OAuth.
API Key Masked Mailchimp API key, including its data-center suffix, used when Authentication Type is ApiKey.
Client ID String Mailchimp OAuth client identifier used when Authentication Type is OAuth.
Client Secret Masked Mailchimp OAuth client secret used when Authentication Type is OAuth.
Access Token Masked Non-expiring Mailchimp OAuth access token. Reconnect the Connection if Mailchimp revokes it.
Server Prefix String Mailchimp data-center prefix, e.g. us8. The Node derives it from the API-key suffix or OAuth metadata.

Setup Notes

Create the credentials for your preferred authentication method before configuring the Connection.

OAuth

  1. In Mailchimp, open the Registered Apps page and click Register An App.
  2. Complete the form, enter https://app.flowgear.net/r/auth as the redirect URI, and click Create.
  3. Copy the generated client ID and client secret. Mailchimp displays the client secret only when it is generated, so store it securely.
  4. In Flowgear, select OAuth in Authentication Type, enter the values in Client ID and Client Secret, and complete the authorization flow. The Node stores the returned Access Token and discovers the account's Server Prefix.

API key

  1. In Mailchimp, click your profile icon and select Profile.
  2. Open Extras and select API keys. Under Your API Keys, click Create A Key.
  3. Name the key, click Generate Key, and copy it immediately. Mailchimp does not display the full key again after you finish creating it.
  4. In Flowgear, select ApiKey in Authentication Type and enter the key in API Key. The key includes a data-center suffix, e.g. -us8, which the Node uses to derive Server Prefix.

After configuring either authentication method, test the Connection. The test calls Mailchimp's read-only ping endpoint.

Methods

The Node groups its curated Mailchimp Marketing operations into query, create, update, and delete Methods.

Query

Queries Mailchimp Marketing resources and pages collection responses automatically.

Parameter Type Description
Connection Connection Mailchimp Marketing Connection profile.
OperationId String Query operation selected from the template list.
Options Object Route, filter, and projection values for the selected operation.
Return Type Description
Response Array Provider-shaped business rows. Collection wrappers and paging metadata are removed, and an empty collection returns no rows.

Create

Creates Mailchimp Marketing resources one input item at a time.

Parameter Type Description
Connection Connection Mailchimp Marketing Connection profile.
OperationId String Create operation selected from the template list.
Options Object Route and query values for the selected operation.
Items Array JSON request objects sent one item at a time.
Return Type Description
Response Array One result row per input item. Each row contains the provider payload and nested Flowgear result metadata.

Update

Updates Mailchimp Marketing resources one input item at a time, including member tag changes.

Parameter Type Description
Connection Connection Mailchimp Marketing Connection profile.
OperationId String Update operation selected from the template list.
Options Object Route and query values for the selected operation.
Items Array JSON request objects sent one item at a time.
Return Type Description
Response Array One result row per input item. Each row contains the provider payload and nested Flowgear result metadata.

Delete

Deletes or archives the resource identified by the selected operation and route values.

Parameter Type Description
Connection Connection Mailchimp Marketing Connection profile.
OperationId String Delete operation selected from the template list.
Options Object Route values that identify the resource.
Items Array Unused for the bodyless delete operations.
Return Type Description
Response Array One normalized result row containing nested Flowgear result metadata.

Usage Notes

  • Select a template before configuring Options or Items. The selected template supplies the request and response structure for its operation.
  • The Node manages the count and offset values used to page query operations.
  • Enter string-list query values such as fields and exclude_fields as comma-separated text, e.g. id,name,description,location.
  • Query executes the first page before the Node invoke completes. Additional pages are fetched as the Workflow consumes the response stream.
  • Create and Update execute the first non-null Items value before the Node invoke completes, then process later items as the Workflow consumes the response stream. An empty input makes no provider call.
  • Read operations retry throttling and transient server failures up to three total attempts. Mutations are not replayed automatically.
  • Record-level 400, 404, 409, and 422 mutation responses return failed result rows. Authentication, upgrade, throttling, and server failures stop the Node with an error.
  • The curated surface excludes whole-list deletion, permanent member deletion, campaign send and schedule actions, batch and bulk endpoints, automations, ecommerce, and account administration and security endpoints.

See also