MailChimp

Entities, operations, and actions

All the Integration Connectors provide a layer of abstraction for the objects of the connected application. You can access an application's objects only through this abstraction. The abstraction is exposed to you as entities, operations, and actions.

• Entity: An entity can be thought of as an object, or a collection of properties, in the connected application or service. The definition of an entity differs from a connector to a connector. For example, in a database connector, tables are the entities, in a file server connector, folders are the entities, and in a messaging system connector, queues are the entities.

  However, it is possible that a connector doesn't support or have any entities, in which case the Entities list will be empty.

• Operation: An operation is the activity that you can perform on an entity. You can perform any of the following operations on an entity:
  • List
  • Get
  • Create
  • Update
  • Delete

  Selecting an entity from the available list, generates a list of operations available for the entity. For a detailed description of the operations, see the Connectors task's entity operations. However, if a connector doesn't support any of the entity operations, such unsupported operations aren't listed in the Operations list.

• Action: An action is a first class function that is made available to the integration through the connector interface. An action lets you make changes to an entity or entities, and vary from connector to connector. Normally, an action will have some input parameters, and an output parameter. However, it is possible that a connector doesn't support any action, in which case the Actions list will be empty.

Actions

This section lists the actions supported by the connector. To understand how to configure the actions, see Action examples.

CampaignTest action

Send a test email for a MailChimp campaign.

Input parameters of the CampaignTest action

For example on how to configure the CampaignTest action, see Action examples.

CampaignSend action

Send a MailChimp campaign.

Input parameters of the CampaignSend action

For example on how to configure the CampaignSend action, see Action examples.

CampaignPause action

Pauses a MailChimp RSS campaign.

Input parameters of the CampaignPause action

For example on how to configure the CampaignPause action, see Action examples.

CampaignResume action

Resumes a MailChimp RSS campaign.

Input parameters of the CampaignResume action

For example on how to configure the CampaignResume action, see Action examples.

Action examples

Example - CampaignTest

1. In the Configure connector task dialog, click Actions.
2. Select the CampaignTest action, and then click Done.
3. In the Task Input section of the Connectors task, click connectorInputPayload and then enter a value similar to the following in the Default Value field:

   {
   "CampaignID": "4bd7a9abac",
   "TestEmails": "sample@gmail.com",
   "SendType": "plaintext"
   }

If the action is successful, the CampaignTest task's connectorOutputPayload response parameter will have a value similar to the following:

{
"Success": "true"
}

Example - CampaignSend

1. In the Configure connector task dialog, click Actions.
2. Select the CampaignSend action, and then click Done.
3. In the Task Input section of the Connectors task, click connectorInputPayload and then enter a value similar to the following in the Default Value field:

   {
   "CampaignID": "1699382f6d"
   } 

If the action is successful, the CampaignSend task's connectorOutputPayload response parameter will have a value similar to the following:

{
"Success": "true"
}

Example - CampaignPause

1. In the Configure connector task dialog, click Actions.
2. Select the CampaignPause action, and then click Done.
3. In the Task Input section of the Connectors task, click connectorInputPayload and then enter a value similar to the following in the Default Value field:

   {
   "CampaignID": "4bd7a9abac"
   }

If the action is successful, the CampaignPause task's connectorOutputPayload response parameter will have a value similar to the following:

 {
"Success": "true"
}

Example - CampaignResume

1. In the Configure connector task dialog, click Actions.
2. Select the CampaignResume action, and then click Done.
3. In the Task Input section of the Connectors task, click connectorInputPayload and then enter a value similar to the following in the Default Value field:

   {
   "CampaignID": "4bd7a9abac"
   }

This example will show the specific Object records. If the action is successful, the CampaignResume task's connectorOutputPayload response parameter will have a value similar to the following:

{
"Success": "true"
}

Entity operation examples

This section shows how to perform some of the entity operations in this connector.

Example - List all campaigns

1. In the Configure connector task dialog, click Entities.
2. Select Campaigns from the Entity list.
3. Select the List operation, and then click Done.
4. Optionally, in Task Input section of the Connectors task, you can filter your result set by specifying a filter clause. Specify the filter clause value always within the single quotes (').

Example - Get a single automation

1. In the Configure connector task dialog, click Entities.
2. Select Automations from the Entity list.
3. Select the Get operation, and then click Done.
4. In the Task Input section of the Connectors task, click EntityId and then enter 1ac204985e in the Default Value field.

   Here, 1ac204985e is a unique record ID in the Automations entity.

Example - Delete a campaign

1. In the Configure connector task dialog, click Entities.
2. Select Campaigns from the Entity list.
3. Select the Delete operation, and then click Done.
4. In the Task Input section of the Connectors task, click entityId and then enter 06f20ace93 in the Default Value field.

Example - Create a campaign folder

1. In the Configure connector task dialog, click Entities.
2. Select CampaignFolders from the Entity list.
3. Select the Create operation, and then click Done.
4. In the Task Input section of the Connectors task, click connectorInputPayload and then enter a value similar to the following in the Default Value field:

   {
   "Name": "CampaignFolderCreated1707812599459"
   }
   Running this example, returns a response similar to the following in the connector
   task's connectorOutputPayload output variable:
   {
   "Id": "650469bb07"
   }
   

Example - Update a file manager folder

1. In the Configure connector task dialog, click Entities.
2. Select FileManagerFolders from the Entity list.
3. Select the Update operation, and then click Done.
4. In the Task Input section of the Connectors task, click connectorInputPayload and then enter a value similar to the following in the Default Value field:

   {   
   "Name": "MyNewFolder9"
   }

5. Click entityId, and then enter 18159 in the Default Value field.

   Running this example, returns a response similar to the following in the connector task's connectorOutputPayload output variable:

   {   
   "Id": "18159"
   }