Get Contacts activity

An activity that retrieves information about one or more contacts from Mailchimp.


Get Contacts activity

Configure the Get Contacts activity

Prerequisites

Good to Know

How to Start

  1. Open Process Builder.

    For information about how to open this screen, refer to Process Builder.


    Open Process Builder
  2. In Process Builder, in the Activity Library, open the Mailchimp tab.

    Open Mailchimp tab
  3. On the Mailchimp tab, drag the Get Contacts activity onto your process.

    Drag Get Contacts activity

General Configuration

Specifies the basic settings for the Get Contacts activity.

Figure: General Configuration screen

General Configuration screen

Good to Know

  • Documentation for this screen is provided for completeness. The fields are mostly self-explanatory.

Fields

Field NameDefinition

Display Name

Description:
Specifies the activity name that shows in your process.
Allowed Values:
One line of text (a string).

Accepted:

  • Letters
  • Numbers
  • Spaces
Default Value:
None
Accepts Variables:
No
Example:
This is a common configuration field that is used in many examples. Refer to:
  • Examples - Step-by-step use case examples, information about what types of examples are provided in the AgilePoint NX Product Documentation, and other resources where you can find more examples.

Description

Description:
Specifies an optional text description for your activity.
Allowed Values:
More than one line of text.
Default Value:
None
Accepts Variables:
No

Get Contacts Configuration

Specifies the information about one or more contacts to retrieve from Mailchimp.

Figure: Get Contacts Configuration screen

Get Contacts Configuration screen

Fields

Field NameDefinition

Mailchimp

Description:
Specifies the access token that connects to your Mailchimp service.
Allowed Values:
A list of access tokens configured for your environment.
Default Value:
None

Create Add Token icon

Opens this Screen:
Access Token for Mailchimp
Function of this Screen:
Configure an access token to connect to Mailchimp.

Audience Name

Description:
Specifies the name of the audience from which to retrieve the contacts.
Allowed Values:
An audience name from the list.

When you select the access token from the Mailchimp field, this field shows the audience names associated with the access token.

Default Value:
None
Accepts Variables:
Yes
Limitations:

Some information about third-party integrations is outside the scope of the AgilePoint NX Product Documentation. It is the responsibility of the vendors who create and maintain these technologies to provide this information. This includes specific business use cases and examples; explanations for third-party concepts; details about the data models and input and output data formats for third-party technologies; and various types of IDs, URL patterns, connection string formats, or other technical information that is specific to the third-party technologies. For more information, refer to Where Can I Find Information and Examples for Third-Party Integrations?

Map Response To App Schema

Description:
Maps information about one or more contacts from the Mailchimp data model to your process schema.
Allowed Values:

Click the Schema Mapping Schema Mapping icon button to open the Schema Mapper.

Use this screen to connect the response to the data model for your process.

Because the query can return more than one result, the parent node in the external data source must be mapped to a node in the AgilePoint NX process schema that is a repeating schema element. The child nodes in both data models must also be mapped, but child nodes in AgilePoint NX inherit the repeating behavior from their parent node.

Default Value:
None
Example:
Refer to: