Go to appAcademyWhat's new?
Back
Artisan IMG > Mailchimp (mailchimp) (d70696ec-2cee-4058-bae9-c310101e1ca2)
Mailchimp
OverviewOperations (sample payloads)Operations

Operations (sample payloads)

Main operations
Copy

Archive list member
Copy

Archive a list member.

Sample Input

1
{
2
    "list_id": "abc123def456",
3
    "email_address": "johndoe@example.com"
4
}

Sample Output

1
{
2
    "archived": true
3
}

Create customer
Copy

Add a new customer to a store.

Sample Input

1
{
2
    "store_id": "store123",
3
    "customer_id": "cust456",
4
    "email_address": "johndoe@example.com",
5
    "opt_in_status": true,
6
    "company": "Acme Corp",
7
    "first_name": "John",
8
    "last_name": "Doe",
9
    "address": {
10
        "address1": "123 Main St",
11
        "address2": "Apt 4B",
12
        "city": "New York",
13
        "province": "New York",
14
        "province_code": "NY",
15
        "postal_code": "10001",
16
        "country": "United States",
17
        "country_code": "US"
18
    }
19
}

Sample Output

1
{
2
    "id": "cust456",
3
    "email_address": "johndoe@example.com",
4
    "opt_in_status": true,
5
    "company": "Acme Corp",
6
    "first_name": "John",
7
    "last_name": "Doe",
8
    "orders_count": 0,
9
    "total_spent": 0,
10
    "address": {
11
        "address1": "123 Main St",
12
        "address2": "Apt 4B",
13
        "city": "New York",
14
        "province": "New York",
15
        "province_code": "NY",
16
        "postal_code": "10001",
17
        "country": "United States",
18
        "country_code": "US"
19
    },
20
    "created_at": "2023-05-15T10:30:00Z",
21
    "updated_at": "2023-05-15T10:30:00Z",
22
    "_links": [
23
        {
24
            "rel": "self",
25
            "href": "https://us1.api.mailchimp.com/3.0/ecommerce/stores/store123/customers/cust456",
26
            "method": "GET",
27
            "targetSchema": "https://us1.api.mailchimp.com/schema/3.0/Definitions/Ecommerce/Customers/Response.json"
28
        },
29
        {
30
            "rel": "parent",
31
            "href": "https://us1.api.mailchimp.com/3.0/ecommerce/stores/store123/customers",
32
            "method": "GET",
33
            "targetSchema": "https://us1.api.mailchimp.com/schema/3.0/Definitions/Ecommerce/Customers/CollectionResponse.json",
34
            "schema": "https://us1.api.mailchimp.com/schema/3.0/CollectionLinks/Ecommerce/Customers.json"
35
        }
36
    ]
37
}

Create ecommerce store
Copy

Add a new store.

Sample Input

1
{
2
    "store_foreign_id": "store123",
3
    "list_id": "a1b2c3d4e5",
4
    "store_name": "My Online Shop",
5
    "currency_code": "USD",
6
    "platform": "Shopify",
7
    "domain": "myonlineshop.com",
8
    "is_syncing": true,
9
    "email_address": "support@myonlineshop.com",
10
    "money_format": "$",
11
    "primary_locale": "en",
12
    "timezone": "America/New_York",
13
    "phone": "+1 (555) 123-4567",
14
    "address": {
15
        "address1": "123 Main St",
16
        "address2": "Suite 456",
17
        "city": "New York",
18
        "province": "New York",
19
        "province_code": "NY",
20
        "postal_code": "10001",
21
        "country": "United States",
22
        "country_code": "US"
23
    }
24
}

Sample Output

1
{
2
    "id": "store_abc123",
3
    "list_id": "a1b2c3d4e5",
4
    "name": "My Online Shop",
5
    "platform": "Shopify",
6
    "domain": "myonlineshop.com",
7
    "is_syncing": true,
8
    "email_address": "support@myonlineshop.com",
9
    "currency_code": "USD",
10
    "money_format": "$",
11
    "primary_locale": "en",
12
    "timezone": "America/New_York",
13
    "phone": "+1 (555) 123-4567",
14
    "address": {
15
        "address1": "123 Main St",
16
        "address2": "Suite 456",
17
        "city": "New York",
18
        "province": "New York",
19
        "province_code": "NY",
20
        "postal_code": "10001",
21
        "country": "United States",
22
        "country_code": "US",
23
        "longitude": -73.9857,
24
        "latitude": 40.7484
25
    },
26
    "connected_site": {
27
        "site_foreign_id": "site_xyz789",
28
        "site_script": {
29
            "url": "https://chimpstatic.com/mcjs-connected/js/users/a1b2c3d4e5/store_abc123.js",
30
            "fragment": "<script id=\"mcjs\">!function(c,h,i,m,p){m=c.createElement(h),p=c.getElementsByTagName(h)[0],m.async=1,m.src=i,p.parentNode.insertBefore(m,p)}(document,\"script\",\"https://chimpstatic.com/mcjs-connected/js/users/a1b2c3d4e5/store_abc123.js\");</script>"
31
        }
32
    },
33
    "automations": {
34
        "abandoned_cart": {
35
            "is_supported": true,
36
            "id": "auto_abc123",
37
            "status": "sending"
38
        },
39
        "abandoned_browse": {
40
            "is_supported": true,
41
            "id": "auto_def456",
42
            "status": "paused"
43
        }
44
    },
45
    "list_is_active": true,
46
    "created_at": "2023-04-15T10:30:00+00:00",
47
    "updated_at": "2023-04-15T10:30:00+00:00",
48
    "_links": [
49
        {
50
            "rel": "self",
51
            "href": "https://us1.api.mailchimp.com/3.0/ecommerce/stores/store_abc123",
52
            "method": "GET",
53
            "targetSchema": "https://us1.api.mailchimp.com/schema/3.0/Definitions/Ecommerce/Stores/Response.json"
54
        },
55
        {
56
            "rel": "parent",
57
            "href": "https://us1.api.mailchimp.com/3.0/ecommerce/stores",
58
            "method": "GET",
59
            "targetSchema": "https://us1.api.mailchimp.com/schema/3.0/Definitions/Ecommerce/Stores/CollectionResponse.json",
60
            "schema": "https://us1.api.mailchimp.com/schema/3.0/Paths/Ecommerce/Stores/Collection.json"
61
        }
62
    ]
63
}

Create member in list
Copy

Add a new member to the list.

Sample Input

1
{
2
    "list_id": "abc123def456",
3
    "email_address": "johndoe@example.com",
4
    "status": "subscribed",
5
    "email_type": "html",
6
    "merge_fields": [
7
        {
8
            "key": "FNAME",
9
            "value": "John"
10
        },
11
        {
12
            "key": "LNAME",
13
            "value": "Doe"
14
        },
15
        {
16
            "key": "BIRTHDAY",
17
            "value": "01/15"
18
        }
19
    ],
20
    "interests": [
21
        {
22
            "key": "9a8b7c6d5e",
23
            "value": true
24
        }
25
    ],
26
    "language": "en",
27
    "vip": false,
28
    "location": {
29
        "latitude": 40.7128,
30
        "longitude": -74.006
31
    },
32
    "marketing_permissions": [
33
        {
34
            "marketing_permission_id": "1a2b3c4d5e",
35
            "enabled": true
36
        }
37
    ],
38
    "ip_signup": "192.168.1.1",
39
    "timestamp_signup": "2023-06-15T10:30:00Z",
40
    "tags": [
41
        "new customer",
42
        "newsletter"
43
    ]
44
}

Sample Output

1
{
2
    "id": "852a763bcd",
3
    "email_address": "johndoe@example.com",
4
    "unique_email_id": "abc123def456ghi789",
5
    "full_name": "John Doe",
6
    "web_id": 123456789,
7
    "email_type": "html",
8
    "status": "subscribed",
9
    "merge_fields": {
10
        "FNAME": "John",
11
        "LNAME": "Doe",
12
        "BIRTHDAY": "01/15"
13
    },
14
    "interests": {
15
        "9a8b7c6d5e": true
16
    },
17
    "stats": {
18
        "avg_open_rate": 0,
19
        "avg_click_rate": 0,
20
        "ecommerce_data": {
21
            "total_revenue": 0,
22
            "number_of_orders": 0,
23
            "currency_code": "USD"
24
        }
25
    },
26
    "ip_signup": "192.168.1.1",
27
    "timestamp_signup": "2023-06-15T10:30:00Z",
28
    "ip_opt": "192.168.1.1",
29
    "timestamp_opt": "2023-06-15T10:30:00Z",
30
    "member_rating": 2,
31
    "last_changed": "2023-06-15T10:30:00Z",
32
    "language": "en",
33
    "vip": false,
34
    "email_client": "Gmail",
35
    "location": {
36
        "latitude": 40.7128,
37
        "longitude": -74.006,
38
        "gmtoff": -5,
39
        "dstoff": -4,
40
        "country_code": "US",
41
        "timezone": "America/New_York",
42
        "region": "NY"
43
    },
44
    "marketing_permissions": [
45
        {
46
            "marketing_permission_id": "1a2b3c4d5e",
47
            "text": "Receive newsletter",
48
            "enabled": true
49
        }
50
    ],
51
    "source": "API",
52
    "tags_count": 2,
53
    "tags": [
54
        {
55
            "id": 123,
56
            "name": "new customer"
57
        },
58
        {
59
            "id": 456,
60
            "name": "newsletter"
61
        }
62
    ],
63
    "list_id": "abc123def456",
64
    "_links": [
65
        {
66
            "rel": "self",
67
            "href": "https://us1.api.mailchimp.com/3.0/lists/abc123def456/members/852a763bcd",
68
            "method": "GET",
69
            "targetSchema": "https://us1.api.mailchimp.com/schema/3.0/Definitions/Lists/Members/Response.json"
70
        },
71
        {
72
            "rel": "parent",
73
            "href": "https://us1.api.mailchimp.com/3.0/lists/abc123def456/members",
74
            "method": "GET",
75
            "targetSchema": "https://us1.api.mailchimp.com/schema/3.0/Definitions/Lists/Members/CollectionResponse.json",
76
            "schema": "https://us1.api.mailchimp.com/schema/3.0/CollectionLinks/Lists/Members.json"
77
        },
78
        {
79
            "rel": "update",
80
            "href": "https://us1.api.mailchimp.com/3.0/lists/abc123def456/members/852a763bcd",
81
            "method": "PATCH",
82
            "targetSchema": "https://us1.api.mailchimp.com/schema/3.0/Definitions/Lists/Members/Response.json",
83
            "schema": "https://us1.api.mailchimp.com/schema/3.0/Definitions/Lists/Members/PATCH.json"
84
        },
85
        {
86
            "rel": "upsert",
87
            "href": "https://us1.api.mailchimp.com/3.0/lists/abc123def456/members/852a763bcd",
88
            "method": "PUT",
89
            "targetSchema": "https://us1.api.mailchimp.com/schema/3.0/Definitions/Lists/Members/Response.json",
90
            "schema": "https://us1.api.mailchimp.com/schema/3.0/Definitions/Lists/Members/PUT.json"
91
        },
92
        {
93
            "rel": "delete",
94
            "href": "https://us1.api.mailchimp.com/3.0/lists/abc123def456/members/852a763bcd",
95
            "method": "DELETE"
96
        }
97
    ]
98
}

Create segment member
Copy

Add a member to a static segment.

Sample Input

1
{
2
    "list_id": "abc123def456",
3
    "segment_id": "seg789ghi012",
4
    "email_address": "johndoe@example.com"
5
}

Sample Output

1
{
2
    "id": "3a7b4e2c1f",
3
    "email_address": "johndoe@example.com",
4
    "unique_email_id": "def456abc123",
5
    "email_type": "html",
6
    "status": "subscribed",
7
    "merge_fields": {
8
        "FNAME": "John",
9
        "LNAME": "Doe",
10
        "ADDRESS": {
11
            "addr1": "123 Main St",
12
            "addr2": "Apt 4B",
13
            "city": "New York",
14
            "state": "NY",
15
            "zip": "10001",
16
            "country": "USA"
17
        },
18
        "PHONE": "555-123-4567",
19
        "BIRTHDAY": "01/15"
20
    },
21
    "interests": {
22
        "a": true
23
    },
24
    "stats": {
25
        "avg_open_rate": 0.25,
26
        "avg_click_rate": 0.05
27
    },
28
    "ip_signup": "192.168.1.1",
29
    "timestamp_signup": "2023-06-15T10:30:00+00:00",
30
    "ip_opt": "192.168.1.2",
31
    "timestamp_opt": "2023-06-15T10:35:00+00:00",
32
    "member_rating": 4,
33
    "last_changed": "2023-06-15T10:35:00+00:00",
34
    "language": "en",
35
    "vip": false,
36
    "email_client": "Gmail",
37
    "location": {
38
        "latitude": 40.7128,
39
        "longitude": -74.006,
40
        "gmtoff": -4,
41
        "dstoff": -5,
42
        "country_code": "US",
43
        "timezone": "America/New_York"
44
    },
45
    "last_note": {
46
        "note_id": 12345,
47
        "created_at": "2023-06-15T11:00:00+00:00",
48
        "created_by": "user@example.com",
49
        "note": "Added to VIP segment"
50
    },
51
    "list_id": "abc123def456",
52
    "_links": [
53
        {
54
            "rel": "self",
55
            "href": "https://us1.api.mailchimp.com/3.0/lists/abc123def456/members/3a7b4e2c1f",
56
            "method": "GET",
57
            "targetSchema": "https://us1.api.mailchimp.com/schema/3.0/Definitions/Lists/Members/Response.json"
58
        },
59
        {
60
            "rel": "parent",
61
            "href": "https://us1.api.mailchimp.com/3.0/lists/abc123def456/members",
62
            "method": "GET",
63
            "targetSchema": "https://us1.api.mailchimp.com/schema/3.0/Definitions/Lists/Members/CollectionResponse.json",
64
            "schema": "https://us1.api.mailchimp.com/schema/3.0/CollectionLinks/Lists/Members.json"
65
        }
66
    ]
67
}

Delete customer
Copy

Delete a customer from a store.

Sample Input

1
{
2
    "store_id": "store123",
3
    "customer_id": "cust456"
4
}

Sample Output

1
{
2
    "deleted": true
3
}

Delete ecommerce store
Copy

Delete a store.

Sample Input

1
{
2
    "store_id": "store123"
3
}

Sample Output

1
{
2
    "deleted": true
3
}

Delete list member
Copy

Delete all personally identifiable information related to a list member, and remove them from a list. This will make it impossible to re-import the list member.

Sample Input

1
{
2
    "list_id": "a1b2c3d4e5",
3
    "email_address": "johndoe@example.com"
4
}

Sample Output

1
{
2
    "deleted": true
3
}

Delete order
Copy

Delete an order from a store.

Sample Input

1
{
2
    "store_id": "store123",
3
    "order_id": "order456"
4
}

Sample Output

1
{
2
    "deleted": true
3
}

Get ecommerce store
Copy

Get information about a specific store.

Sample Input

1
{
2
    "store_id": "store123",
3
    "fields": [
4
        "id",
5
        "name",
6
        "platform",
7
        "domain",
8
        "currency_code"
9
    ],
10
    "exclude_fields": [
11
        "_links",
12
        "connected_site"
13
    ]
14
}

Sample Output

1
{
2
    "id": "store123",
3
    "name": "My Online Store",
4
    "platform": "Shopify",
5
    "domain": "myonlinestore.com",
6
    "currency_code": "USD"
7
}

List account orders
Copy

Get information about an account's orders.

Sample Input

1
{
2
    "fields": [
3
        "id",
4
        "customer",
5
        "order_total",
6
        "currency_code"
7
    ],
8
    "exclude_fields": [
9
        "shipping_address",
10
        "billing_address"
11
    ],
12
    "campaign_id": "b1234567",
13
    "count": 2,
14
    "offset": 0
15
}

Sample Output

1
{
2
    "orders": [
3
        {
4
            "id": "ORD123456",
5
            "customer": {
6
                "id": "CUST987654",
7
                "email_address": "johndoe@example.com",
8
                "opt_in_status": true,
9
                "first_name": "John",
10
                "last_name": "Doe",
11
                "orders_count": 3,
12
                "total_spent": 250.75
13
            },
14
            "order_total": 89.99,
15
            "currency_code": "USD"
16
        },
17
        {
18
            "id": "ORD789012",
19
            "customer": {
20
                "id": "CUST345678",
21
                "email_address": "janesmith@example.com",
22
                "opt_in_status": true,
23
                "first_name": "Jane",
24
                "last_name": "Smith",
25
                "orders_count": 1,
26
                "total_spent": 129.99
27
            },
28
            "order_total": 129.99,
29
            "currency_code": "USD"
30
        }
31
    ],
32
    "total_items": 2,
33
    "_links": [
34
        {
35
            "rel": "self",
36
            "href": "https://api.mailchimp.com/3.0/ecommerce/orders",
37
            "method": "GET",
38
            "targetSchema": "https://api.mailchimp.com/schema/3.0/Ecommerce/Orders/Collection.json"
39
        }
40
    ]
41
}

List campaign email activity
Copy

Get a list of email activities that have happened for a given campaign.

Sample Input

1
{
2
    "campaign_id": "b1234abc",
3
    "fields": [
4
        "email_address",
5
        "activity"
6
    ],
7
    "exclude_fields": [
8
        "_links"
9
    ],
10
    "since": "2023-05-01T00:00:00Z",
11
    "count": 50,
12
    "offset": 0
13
}

Sample Output

1
{
2
    "emails": [
3
        {
4
            "email_address": "john.doe@example.com",
5
            "activity": [
6
                {
7
                    "action": "open",
8
                    "type": "open",
9
                    "timestamp": "2023-05-02T10:15:30Z",
10
                    "ip": "192.168.1.1"
11
                },
12
                {
13
                    "action": "click",
14
                    "type": "click",
15
                    "timestamp": "2023-05-02T10:16:45Z",
16
                    "url": "https://example.com/product",
17
                    "ip": "192.168.1.1"
18
                }
19
            ]
20
        },
21
        {
22
            "email_address": "jane.smith@example.com",
23
            "activity": [
24
                {
25
                    "action": "open",
26
                    "type": "open",
27
                    "timestamp": "2023-05-03T14:20:00Z",
28
                    "ip": "192.168.2.2"
29
                }
30
            ]
31
        }
32
    ],
33
    "campaign_id": "b1234abc",
34
    "total_items": 2
35
}

List campaign folders
Copy

Get all folders used to organize campaigns.

Sample Input

1
{
2
    "count": 10,
3
    "offset": 0
4
}

Sample Output

1
{
2
    "folders": [
3
        {
4
            "name": "Newsletter Campaigns",
5
            "id": "abc123def456",
6
            "count": 5,
7
            "_links": [
8
                {
9
                    "rel": "self",
10
                    "href": "https://us1.api.mailchimp.com/3.0/campaign-folders/abc123def456",
11
                    "method": "GET",
12
                    "targetSchema": "https://us1.api.mailchimp.com/schema/3.0/Definitions/CampaignFolders/Response.json"
13
                }
14
            ]
15
        },
16
        {
17
            "name": "Promotional Campaigns",
18
            "id": "ghi789jkl012",
19
            "count": 3,
20
            "_links": [
21
                {
22
                    "rel": "self",
23
                    "href": "https://us1.api.mailchimp.com/3.0/campaign-folders/ghi789jkl012",
24
                    "method": "GET",
25
                    "targetSchema": "https://us1.api.mailchimp.com/schema/3.0/Definitions/CampaignFolders/Response.json"
26
                }
27
            ]
28
        }
29
    ],
30
    "total_items": 2,
31
    "_links": [
32
        {
33
            "rel": "self",
34
            "href": "https://us1.api.mailchimp.com/3.0/campaign-folders",
35
            "method": "GET",
36
            "targetSchema": "https://us1.api.mailchimp.com/schema/3.0/Definitions/CampaignFolders/CollectionResponse.json",
37
            "schema": "https://us1.api.mailchimp.com/schema/3.0/CollectionLinks/CampaignFolders.json"
38
        }
39
    ]
40
}

List campaign recipients
Copy

Get a list of all the people who received a particular campaign.

Sample Input

1
{
2
    "campaign_id": "b1234abc",
3
    "fields": [
4
        "email_address",
5
        "merge_fields",
6
        "status"
7
    ],
8
    "exclude_fields": [
9
        "_links"
10
    ],
11
    "count": 10,
12
    "offset": 0
13
}

Sample Output

1
{
2
    "sent_to": [
3
        {
4
            "email_address": "john.doe@example.com",
5
            "merge_fields": {
6
                "FNAME": "John",
7
                "LNAME": "Doe",
8
                "ADDRESS": {
9
                    "addr1": "123 Main St",
10
                    "addr2": "",
11
                    "city": "Anytown",
12
                    "state": "CA",
13
                    "zip": "12345",
14
                    "country": "US"
15
                },
16
                "PHONE": "555-123-4567",
17
                "BIRTHDAY": "01/15"
18
            },
19
            "status": "subscribed"
20
        },
21
        {
22
            "email_address": "jane.smith@example.com",
23
            "merge_fields": {
24
                "FNAME": "Jane",
25
                "LNAME": "Smith",
26
                "ADDRESS": {
27
                    "addr1": "456 Oak Ave",
28
                    "addr2": "Apt 7",
29
                    "city": "Springfield",
30
                    "state": "IL",
31
                    "zip": "67890",
32
                    "country": "US"
33
                },
34
                "PHONE": "555-987-6543",
35
                "BIRTHDAY": "09/22"
36
            },
37
            "status": "subscribed"
38
        }
39
    ],
40
    "campaign_id": "b1234abc",
41
    "total_items": 2
42
}

List campaign sub reports
Copy

Get a list of sub reports for a parent campaign.

Sample Input

1
{
2
    "campaign_id": "b1234abc"
3
}

Sample Output

1
{
2
    "reports": [
3
        {
4
            "id": "sub123",
5
            "campaign_title": "Summer Sale Newsletter",
6
            "type": "regular",
7
            "list_id": "list456",
8
            "list_is_active": true,
9
            "list_name": "Customers",
10
            "subject_line": "Don't Miss Our Summer Sale!",
11
            "preview_text": "Exclusive discounts inside",
12
            "emails_sent": 10000,
13
            "abuse_reports": 2,
14
            "unsubscribed": 15,
15
            "send_time": "2023-06-15T10:00:00Z",
16
            "rss_last_send": null,
17
            "bounces": {
18
                "hard_bounces": 50,
19
                "soft_bounces": 30,
20
                "syntax_errors": 0
21
            },
22
            "forwards": {
23
                "forwards_count": 75,
24
                "forwards_opens": 40
25
            },
26
            "opens": {
27
                "opens_total": 5500,
28
                "unique_opens": 4800,
29
                "open_rate": 48,
30
                "last_open": "2023-06-18T23:59:59Z"
31
            },
32
            "clicks": {
33
                "clicks_total": 1200,
34
                "unique_clicks": 950,
35
                "unique_subscriber_clicks": 900,
36
                "click_rate": 9.5,
37
                "last_click": "2023-06-18T22:45:30Z"
38
            },
39
            "facebook_likes": {
40
                "recipient_likes": 30,
41
                "unique_likes": 28,
42
                "facebook_likes": 35
43
            },
44
            "industry_stats": {
45
                "type": "Retail",
46
                "open_rate": 22.5,
47
                "click_rate": 2.7,
48
                "bounce_rate": 0.8,
49
                "unopen_rate": 77.5,
50
                "unsub_rate": 0.2,
51
                "abuse_rate": 0.01
52
            },
53
            "list_stats": {
54
                "sub_rate": 0.5,
55
                "unsub_rate": 0.15,
56
                "open_rate": 48,
57
                "click_rate": 9.5
58
            },
59
            "ab_split": null,
60
            "timewarp": null,
61
            "timeseries": [
62
                {
63
                    "timestamp": "2023-06-15T10:00:00Z",
64
                    "emails_sent": 10000,
65
                    "unique_opens": 2000,
66
                    "recipients_clicks": 400
67
                },
68
                {
69
                    "timestamp": "2023-06-15T14:00:00Z",
70
                    "emails_sent": 10000,
71
                    "unique_opens": 3500,
72
                    "recipients_clicks": 700
73
                }
74
            ],
75
            "share_report": {
76
                "share_url": "https://mailchimp.com/reports/share/abc123",
77
                "share_password": "summerSale2023"
78
            },
79
            "ecommerce": {
80
                "total_orders": 250,
81
                "total_spent": 12500,
82
                "total_revenue": 15000,
83
                "currency_code": "USD"
84
            },
85
            "delivery_status": {
86
                "enabled": true,
87
                "can_cancel": false,
88
                "status": "delivered",
89
                "emails_sent": 10000,
90
                "emails_canceled": 0
91
            },
92
            "_links": [
93
                {
94
                    "rel": "parent",
95
                    "href": "https://us1.api.mailchimp.com/3.0/reports/b1234abc",
96
                    "method": "GET",
97
                    "targetSchema": "https://us1.api.mailchimp.com/schema/3.0/Definitions/Reports/Response.json",
98
                    "schema": "https://us1.api.mailchimp.com/schema/3.0/Paths/Reports/Collection.json"
99
                }
100
            ]
101
        }
102
    ],
103
    "campaign_id": "b1234abc",
104
    "total_items": 1,
105
    "_links": [
106
        {
107
            "rel": "self",
108
            "href": "https://us1.api.mailchimp.com/3.0/reports/b1234abc/sub-reports",
109
            "method": "GET",
110
            "targetSchema": "https://us1.api.mailchimp.com/schema/3.0/Definitions/Reports/SubReports/CollectionResponse.json",
111
            "schema": "https://us1.api.mailchimp.com/schema/3.0/Paths/Reports/SubReports/Collection.json"
112
        }
113
    ]
114
}

List campaign subscriber activity
Copy

Get a list of email activities that have happened for a given campaign and a particular subscriber.

Sample Input

1
{
2
    "campaign_id": "b1234abc",
3
    "email": "subscriber@example.com"
4
}

Sample Output

1
{
2
    "campaign_id": "b1234abc",
3
    "list_id": "a9876xyz",
4
    "list_is_active": true,
5
    "email_id": "c5678def",
6
    "email_address": "subscriber@example.com",
7
    "activity": [
8
        {
9
            "action": "open",
10
            "type": "open",
11
            "timestamp": "2023-05-15T10:30:00Z",
12
            "ip": "192.168.1.1"
13
        },
14
        {
15
            "action": "click",
16
            "type": "click",
17
            "timestamp": "2023-05-15T10:32:15Z",
18
            "url": "https://example.com/product",
19
            "ip": "192.168.1.1"
20
        }
21
    ],
22
    "_links": [
23
        {
24
            "rel": "parent",
25
            "href": "https://us1.api.mailchimp.com/3.0/reports/b1234abc/email-activity",
26
            "method": "GET",
27
            "targetSchema": "https://us1.api.mailchimp.com/schema/3.0/Definitions/Reports/EmailActivity/CollectionResponse.json",
28
            "schema": "https://us1.api.mailchimp.com/schema/3.0/Paths/Reports/EmailActivity/Collection.json"
29
        }
30
    ]
31
}

List campaigns
Copy

Get a list of campaigns.

Sample Input

1
{
2
    "count": 10,
3
    "offset": 0,
4
    "campaign_status": "sent",
5
    "campaign_type": "regular",
6
    "sort_dir": "DESC",
7
    "campaign_sort_field": "send_time",
8
    "since_send_time": "2023-01-01T00:00:00Z"
9
}

Sample Output

1
{
2
    "campaigns": [
3
        {
4
            "id": "a1b2c3d4e5",
5
            "web_id": 123456,
6
            "type": "regular",
7
            "create_time": "2023-03-15T10:00:00Z",
8
            "archive_url": "https://mailchimp.com/campaigns/a1b2c3d4e5-archive",
9
            "long_archive_url": "https://us1.campaign-archive.com/?u=abcdef123456&id=a1b2c3d4e5",
10
            "status": "sent",
11
            "emails_sent": 5000,
12
            "send_time": "2023-03-20T09:00:00Z",
13
            "content_type": "html",
14
            "needs_block_refresh": false,
15
            "resendable": true,
16
            "recipients": {
17
                "list_id": "list123",
18
                "list_is_active": true,
19
                "list_name": "Newsletter Subscribers",
20
                "recipient_count": 5000
21
            },
22
            "settings": {
23
                "subject_line": "March Newsletter: Exciting Updates!",
24
                "preview_text": "Check out our latest news and offers",
25
                "title": "March 2023 Newsletter",
26
                "from_name": "Your Company",
27
                "reply_to": "newsletter@yourcompany.com",
28
                "use_conversation": true,
29
                "to_name": "*|FNAME|*",
30
                "folder_id": "folder456",
31
                "authenticate": true,
32
                "auto_footer": true,
33
                "inline_css": true
34
            },
35
            "tracking": {
36
                "opens": true,
37
                "html_clicks": true,
38
                "text_clicks": true,
39
                "goal_tracking": false,
40
                "ecomm360": true,
41
                "google_analytics": "utm_source=newsletter&utm_medium=email&utm_campaign=march2023"
42
            },
43
            "report_summary": {
44
                "opens": 3500,
45
                "unique_opens": 3000,
46
                "open_rate": 60,
47
                "clicks": 1200,
48
                "subscriber_clicks": 1000,
49
                "click_rate": 20,
50
                "ecommerce": {
51
                    "total_orders": 50,
52
                    "total_spent": 2500,
53
                    "total_revenue": 3000
54
                }
55
            }
56
        }
57
    ],
58
    "total_items": 1,
59
    "_links": [
60
        {
61
            "rel": "self",
62
            "href": "https://us1.api.mailchimp.com/3.0/campaigns",
63
            "method": "GET",
64
            "targetSchema": "https://us1.api.mailchimp.com/schema/3.0/Definitions/Campaigns/CollectionResponse.json",
65
            "schema": "https://us1.api.mailchimp.com/schema/3.0/Paths/Campaigns/Collection.json"
66
        }
67
    ]
68
}

List customers
Copy

Get information about a store's customers.

Sample Input

1
{
2
    "store_id": "store123",
3
    "fields": [
4
        "email_address",
5
        "first_name",
6
        "last_name",
7
        "orders_count",
8
        "total_spent"
9
    ],
10
    "exclude_fields": [
11
        "_links"
12
    ],
13
    "email_address": "customer@example.com",
14
    "count": 10,
15
    "offset": 0
16
}

Sample Output

1
{
2
    "store_id": "store123",
3
    "customers": [
4
        {
5
            "id": "cust001",
6
            "email_address": "customer@example.com",
7
            "first_name": "John",
8
            "last_name": "Doe",
9
            "orders_count": 5,
10
            "total_spent": 250.75
11
        },
12
        {
13
            "id": "cust002",
14
            "email_address": "jane@example.com",
15
            "first_name": "Jane",
16
            "last_name": "Smith",
17
            "orders_count": 3,
18
            "total_spent": 175.5
19
        }
20
    ],
21
    "total_items": 2,
22
    "_links": [
23
        {
24
            "rel": "self",
25
            "href": "https://us1.api.mailchimp.com/3.0/ecommerce/stores/store123/customers",
26
            "method": "GET",
27
            "targetSchema": "https://us1.api.mailchimp.com/schema/3.0/Definitions/Ecommerce/Customers/CollectionResponse.json",
28
            "schema": "https://us1.api.mailchimp.com/schema/3.0/Paths/Ecommerce/Stores/Customers/Collection.json"
29
        }
30
    ]
31
}

List ecommerce stores
Copy

Get information about all stores.

Sample Input

1
{
2
    "fields": [
3
        "id",
4
        "name",
5
        "platform",
6
        "domain"
7
    ],
8
    "exclude_fields": [
9
        "_links"
10
    ],
11
    "count": 2,
12
    "offset": 0
13
}

Sample Output

1
{
2
    "stores": [
3
        {
4
            "id": "store123",
5
            "name": "My Online Shop",
6
            "platform": "Shopify",
7
            "domain": "myonlineshop.com"
8
        },
9
        {
10
            "id": "store456",
11
            "name": "Awesome Gadgets",
12
            "platform": "WooCommerce",
13
            "domain": "awesomegadgets.com"
14
        }
15
    ],
16
    "total_items": 2,
17
    "_links": [
18
        {
19
            "rel": "self",
20
            "href": "https://us1.api.mailchimp.com/3.0/ecommerce/stores",
21
            "method": "GET",
22
            "targetSchema": "https://us1.api.mailchimp.com/schema/3.0/Definitions/EcommerceStores/CollectionResponse.json",
23
            "schema": "https://us1.api.mailchimp.com/schema/3.0/Paths/EcommerceStores/Collection.json"
24
        }
25
    ]
26
}

List interest categories
Copy

Get information about a list’s interest categories.

Sample Input

1
{
2
    "list_id": "a1b2c3d4e5",
3
    "interest_group_type": "checkboxes",
4
    "fields": [
5
        "id",
6
        "title",
7
        "type"
8
    ],
9
    "exclude_fields": [
10
        "_links"
11
    ],
12
    "count": 10,
13
    "offset": 0
14
}

Sample Output

1
{
2
    "list_id": "a1b2c3d4e5",
3
    "categories": [
4
        {
5
            "list_id": "a1b2c3d4e5",
6
            "id": "abc123def",
7
            "title": "Favorite Products",
8
            "display_order": 1,
9
            "type": "checkboxes"
10
        },
11
        {
12
            "list_id": "a1b2c3d4e5",
13
            "id": "ghi456jkl",
14
            "title": "Preferred Communication",
15
            "display_order": 2,
16
            "type": "checkboxes"
17
        }
18
    ],
19
    "total_items": 2
20
}

List interests
Copy

Get information about an interest category's interests.

Sample Input

1
{
2
    "list_id": "abc123def456",
3
    "interest_category_id": "9876fedcba",
4
    "fields": [
5
        "id",
6
        "name",
7
        "subscriber_count"
8
    ],
9
    "exclude_fields": [
10
        "_links"
11
    ],
12
    "count": 50,
13
    "offset": 0
14
}

Sample Output

1
{
2
    "interests": [
3
        {
4
            "category_id": "9876fedcba",
5
            "list_id": "abc123def456",
6
            "id": "interest1",
7
            "name": "Sports",
8
            "subscriber_count": "1250"
9
        },
10
        {
11
            "category_id": "9876fedcba",
12
            "list_id": "abc123def456",
13
            "id": "interest2",
14
            "name": "Music",
15
            "subscriber_count": "980"
16
        },
17
        {
18
            "category_id": "9876fedcba",
19
            "list_id": "abc123def456",
20
            "id": "interest3",
21
            "name": "Technology",
22
            "subscriber_count": "1500"
23
        }
24
    ],
25
    "list_id": "abc123def456",
26
    "category_id": "9876fedcba",
27
    "total_items": 3
28
}

List list merge fields
Copy

Retrieve all merge fields for a specific list.

Sample Input

1
{
2
    "list_id": "a1b2c3d4e5",
3
    "count": 10,
4
    "offset": 0,
5
    "fields": [
6
        "merge_id",
7
        "tag",
8
        "name",
9
        "type"
10
    ],
11
    "exclude_fields": [
12
        "_links"
13
    ],
14
    "type": "text",
15
    "required": true
16
}

Sample Output

1
{
2
    "merge_fields": [
3
        {
4
            "merge_id": 1,
5
            "tag": "FNAME",
6
            "name": "First Name",
7
            "type": "text",
8
            "required": true,
9
            "default_value": "",
10
            "public": true,
11
            "display_order": 1,
12
            "options": {
13
                "size": 25
14
            },
15
            "help_text": "Enter your first name",
16
            "list_id": "a1b2c3d4e5"
17
        },
18
        {
19
            "merge_id": 2,
20
            "tag": "LNAME",
21
            "name": "Last Name",
22
            "type": "text",
23
            "required": true,
24
            "default_value": "",
25
            "public": true,
26
            "display_order": 2,
27
            "options": {
28
                "size": 25
29
            },
30
            "help_text": "Enter your last name",
31
            "list_id": "a1b2c3d4e5"
32
        }
33
    ],
34
    "list_id": "a1b2c3d4e5",
35
    "total_items": 2
36
}

List list segments
Copy

Get a list of all segments in a list.

Sample Input

1
{
2
    "list_id": "abc123def456",
3
    "type2": "saved",
4
    "include_cleaned": true,
5
    "include_transactional": false,
6
    "include_unsubscribed": true,
7
    "count": 50,
8
    "offset": 0
9
}

Sample Output

1
{
2
    "segments": [
3
        {
4
            "id": 12345,
5
            "name": "Active Subscribers",
6
            "member_count": 1500,
7
            "type": "saved",
8
            "created_at": "2023-05-01T10:00:00Z",
9
            "updated_at": "2023-05-15T14:30:00Z",
10
            "options": {
11
                "match": "all",
12
                "conditions": [
13
                    {
14
                        "field": "email_open_rate",
15
                        "op": "gt",
16
                        "value": "20",
17
                        "extra": ""
18
                    }
19
                ]
20
            },
21
            "list_id": "abc123def456",
22
            "_links": [
23
                {
24
                    "rel": "self",
25
                    "href": "https://us1.api.mailchimp.com/3.0/lists/abc123def456/segments/12345",
26
                    "method": "GET",
27
                    "targetSchema": "https://us1.api.mailchimp.com/schema/3.0/Definitions/Lists/Segments/Response.json",
28
                    "schema": "https://us1.api.mailchimp.com/schema/3.0/Paths/Lists/Segments/Instance.json"
29
                }
30
            ]
31
        },
32
        {
33
            "id": 67890,
34
            "name": "Recent Customers",
35
            "member_count": 750,
36
            "type": "saved",
37
            "created_at": "2023-04-15T09:00:00Z",
38
            "updated_at": "2023-05-10T11:45:00Z",
39
            "options": {
40
                "match": "any",
41
                "conditions": [
42
                    {
43
                        "field": "last_changed",
44
                        "op": "greater",
45
                        "value": "30",
46
                        "extra": ""
47
                    }
48
                ]
49
            },
50
            "list_id": "abc123def456",
51
            "_links": [
52
                {
53
                    "rel": "self",
54
                    "href": "https://us1.api.mailchimp.com/3.0/lists/abc123def456/segments/67890",
55
                    "method": "GET",
56
                    "targetSchema": "https://us1.api.mailchimp.com/schema/3.0/Definitions/Lists/Segments/Response.json",
57
                    "schema": "https://us1.api.mailchimp.com/schema/3.0/Paths/Lists/Segments/Instance.json"
58
                }
59
            ]
60
        }
61
    ],
62
    "list_id": "abc123def456",
63
    "total_items": 2,
64
    "_links": [
65
        {
66
            "rel": "self",
67
            "href": "https://us1.api.mailchimp.com/3.0/lists/abc123def456/segments",
68
            "method": "GET",
69
            "targetSchema": "https://us1.api.mailchimp.com/schema/3.0/Definitions/Lists/Segments/CollectionResponse.json",
70
            "schema": "https://us1.api.mailchimp.com/schema/3.0/Paths/Lists/Segments/Collection.json"
71
        }
72
    ]
73
}

List lists
Copy

Get a list of lists.

Sample Input

1
{
2
    "count": 2,
3
    "offset": 0
4
}

Sample Output

1
{
2
    "lists": [
3
        {
4
            "id": "a1b2c3d4e5",
5
            "web_id": 123456,
6
            "name": "Newsletter Subscribers",
7
            "contact": {
8
                "company": "Acme Corp",
9
                "address1": "123 Main St",
10
                "address2": "Suite 100",
11
                "city": "Springfield",
12
                "state": "IL",
13
                "zip": "62701",
14
                "country": "US",
15
                "phone": "555-123-4567"
16
            },
17
            "permission_reminder": "You're receiving this email because you signed up for our newsletter.",
18
            "use_archive_bar": true,
19
            "campaign_defaults": {
20
                "from_name": "Acme Corp",
21
                "from_email": "newsletter@acmecorp.com",
22
                "subject": "Monthly Newsletter",
23
                "language": "en"
24
            },
25
            "notify_on_subscribe": "owner@acmecorp.com",
26
            "notify_on_unsubscribe": "owner@acmecorp.com",
27
            "date_created": "2023-01-15T10:30:00+00:00",
28
            "list_rating": 4,
29
            "email_type_option": true,
30
            "subscribe_url_short": "http://eepurl.com/abcdef",
31
            "subscribe_url_long": "https://acmecorp.us1.list-manage.com/subscribe?u=a1b2c3d4e5f6g7h8i9j0&id=1234567890",
32
            "beamer_address": "us1-abcdef123-abcdef123@inbound.mailchimp.com",
33
            "visibility": "pub",
34
            "double_optin": true,
35
            "has_welcome": true,
36
            "marketing_permissions": false,
37
            "modules": [
38
                "email"
39
            ],
40
            "stats": {
41
                "member_count": 5000,
42
                "total_contacts": 5500,
43
                "unsubscribe_count": 150,
44
                "cleaned_count": 50,
45
                "member_count_since_send": 100,
46
                "unsubscribe_count_since_send": 10,
47
                "cleaned_count_since_send": 5,
48
                "campaign_count": 25,
49
                "campaign_last_sent": "2023-05-01T09:00:00+00:00",
50
                "merge_field_count": 5,
51
                "avg_sub_rate": 2.5,
52
                "avg_unsub_rate": 0.5,
53
                "target_sub_rate": 5,
54
                "open_rate": 22.5,
55
                "click_rate": 3.2,
56
                "last_sub_date": "2023-05-10T14:23:00+00:00",
57
                "last_unsub_date": "2023-05-09T11:45:00+00:00"
58
            },
59
            "_links": [
60
                {
61
                    "rel": "self",
62
                    "href": "https://us1.api.mailchimp.com/3.0/lists/a1b2c3d4e5",
63
                    "method": "GET",
64
                    "targetSchema": "https://us1.api.mailchimp.com/schema/3.0/Lists/Instance.json"
65
                }
66
            ]
67
        },
68
        {
69
            "id": "f6g7h8i9j0",
70
            "web_id": 789012,
71
            "name": "Product Updates",
72
            "contact": {
73
                "company": "Acme Corp",
74
                "address1": "456 Oak Ave",
75
                "address2": "",
76
                "city": "Springfield",
77
                "state": "IL",
78
                "zip": "62702",
79
                "country": "US",
80
                "phone": "555-987-6543"
81
            },
82
            "permission_reminder": "You're receiving this email because you opted in for product updates.",
83
            "use_archive_bar": false,
84
            "campaign_defaults": {
85
                "from_name": "Acme Product Team",
86
                "from_email": "products@acmecorp.com",
87
                "subject": "Product Update",
88
                "language": "en"
89
            },
90
            "notify_on_subscribe": "",
91
            "notify_on_unsubscribe": "",
92
            "date_created": "2023-03-01T14:45:00+00:00",
93
            "list_rating": 3,
94
            "email_type_option": false,
95
            "subscribe_url_short": "http://eepurl.com/ghijkl",
96
            "subscribe_url_long": "https://acmecorp.us1.list-manage.com/subscribe?u=f6g7h8i9j0k1l2m3n4o5&id=0987654321",
97
            "beamer_address": "us1-ghijkl456-ghijkl456@inbound.mailchimp.com",
98
            "visibility": "prv",
99
            "double_optin": false,
100
            "has_welcome": false,
101
            "marketing_permissions": true,
102
            "modules": [
103
                "email",
104
                "ads"
105
            ],
106
            "stats": {
107
                "member_count": 2000,
108
                "total_contacts": 2100,
109
                "unsubscribe_count": 50,
110
                "cleaned_count": 20,
111
                "member_count_since_send": 30,
112
                "unsubscribe_count_since_send": 5,
113
                "cleaned_count_since_send": 2,
114
                "campaign_count": 10,
115
                "campaign_last_sent": "2023-05-05T16:30:00+00:00",
116
                "merge_field_count": 3,
117
                "avg_sub_rate": 1.8,
118
                "avg_unsub_rate": 0.3,
119
                "target_sub_rate": 3,
120
                "open_rate": 35.7,
121
                "click_rate": 5.9,
122
                "last_sub_date": "2023-05-11T09:12:00+00:00",
123
                "last_unsub_date": "2023-05-10T17:30:00+00:00"
124
            },
125
            "_links": [
126
                {
127
                    "rel": "self",
128
                    "href": "https://us1.api.mailchimp.com/3.0/lists/f6g7h8i9j0",
129
                    "method": "GET",
130
                    "targetSchema": "https://us1.api.mailchimp.com/schema/3.0/Lists/Instance.json"
131
                }
132
            ]
133
        }
134
    ],
135
    "total_items": 2,
136
    "constraints": {
137
        "may_create": true,
138
        "max_instances": 100,
139
        "current_total_instances": 2
140
    },
141
    "_links": [
142
        {
143
            "rel": "self",
144
            "href": "https://us1.api.mailchimp.com/3.0/lists",
145
            "method": "GET",
146
            "targetSchema": "https://us1.api.mailchimp.com/schema/3.0/Lists/Collection.json",
147
            "schema": "https://us1.api.mailchimp.com/schema/3.0/CollectionLinks/Lists.json"
148
        }
149
    ]
150
}

List member activity
Copy

Retrieve details about a subscriber's recent activity.

Sample Input

1
{
2
    "list_id": "abc123def456",
3
    "email_address": "johndoe@example.com",
4
    "fields": [
5
        "activity",
6
        "email_id",
7
        "list_id"
8
    ],
9
    "exclude_fields": [
10
        "_links"
11
    ],
12
    "action": [
13
        "open",
14
        "click"
15
    ],
16
    "count": 50,
17
    "offset": 0
18
}

Sample Output

1
{
2
    "activity": [
3
        {
4
            "action": "open",
5
            "timestamp": "2023-05-15T10:30:00Z",
6
            "type": "email",
7
            "campaign_id": "camp123",
8
            "title": "Summer Sale Newsletter"
9
        },
10
        {
11
            "action": "click",
12
            "timestamp": "2023-05-15T10:32:00Z",
13
            "type": "email",
14
            "campaign_id": "camp123",
15
            "title": "Summer Sale Newsletter"
16
        }
17
    ],
18
    "email_id": "johndoe@example.com",
19
    "contact_id": "cont789",
20
    "list_id": "abc123def456",
21
    "total_items": 2
22
}

List recent member notes
Copy

Retrieve recent notes for a specific list member.

Sample Input

1
{
2
    "list_id": "abc123def456",
3
    "email_address": "johndoe@example.com",
4
    "sort_field": "created_at",
5
    "sort_dir": "DESC",
6
    "fields": [
7
        "notes",
8
        "email_id",
9
        "list_id"
10
    ],
11
    "exclude_fields": [
12
        "_links"
13
    ],
14
    "count": 10,
15
    "offset": 0
16
}

Sample Output

1
{
2
    "notes": [
3
        {
4
            "id": 12345,
5
            "created_at": "2023-05-15T14:30:00Z",
6
            "created_by": "user@company.com",
7
            "updated_at": "2023-05-15T14:30:00Z",
8
            "note": "Customer requested information about our premium plan.",
9
            "list_id": "abc123def456",
10
            "email_id": "67890fghij"
11
        },
12
        {
13
            "id": 12344,
14
            "created_at": "2023-05-10T09:15:00Z",
15
            "created_by": "admin@company.com",
16
            "updated_at": "2023-05-10T09:15:00Z",
17
            "note": "Follow up on recent purchase experience.",
18
            "list_id": "abc123def456",
19
            "email_id": "67890fghij"
20
        }
21
    ],
22
    "email_id": "67890fghij",
23
    "list_id": "abc123def456",
24
    "total_items": 2
25
}

Raw HTTP request (advanced)
Copy

Perform a raw HTTP request with some pre-configuration and processing by the connector, such as authentication.

Sample Input

1
{
2
    "method": "GET",
3
    "url": {
4
        "endpoint": "/lists"
5
    },
6
    "headers": [
7
        {
8
            "key": "Accept",
9
            "value": "application/json"
10
        }
11
    ],
12
    "query_parameters": [
13
        {
14
            "key": "count",
15
            "value": "10"
16
        },
17
        {
18
            "key": "offset",
19
            "value": "0"
20
        }
21
    ],
22
    "body": {
23
        "none": null
24
    },
25
    "include_raw_body": false,
26
    "parse_response": "true"
27
}

Sample Output

1
{
2
    "response": {
3
        "status_code": 200,
4
        "headers": {
5
            "Content-Type": "application/json",
6
            "Server": "openresty",
7
            "X-Request-Id": "a1b2c3d4-5e6f-7g8h-9i0j-1k2l3m4n5o6p"
8
        },
9
        "body": {
10
            "lists": [
11
                {
12
                    "id": "abc123def",
13
                    "web_id": 123456,
14
                    "name": "Newsletter Subscribers",
15
                    "contact": {
16
                        "company": "Acme Corp",
17
                        "address1": "123 Main St",
18
                        "city": "Springfield",
19
                        "state": "IL",
20
                        "zip": "62701",
21
                        "country": "US"
22
                    },
23
                    "permission_reminder": "You're receiving this email because you signed up for our newsletter.",
24
                    "use_archive_bar": true,
25
                    "campaign_defaults": {
26
                        "from_name": "Acme Corp",
27
                        "from_email": "newsletter@acmecorp.com",
28
                        "subject": "",
29
                        "language": "en"
30
                    },
31
                    "notify_on_subscribe": "",
32
                    "notify_on_unsubscribe": "",
33
                    "date_created": "2023-05-15T10:23:45+00:00",
34
                    "list_rating": 4,
35
                    "email_type_option": true,
36
                    "subscribe_url_short": "http://eepurl.com/abcdef",
37
                    "subscribe_url_long": "https://acmecorp.us1.list-manage.com/subscribe?u=a1b2c3d4e5f6g7h8i9j0&id=1a2b3c4d5e",
38
                    "beamer_address": "us1-abcdef123-acmecorp@inbound.mailchimp.com",
39
                    "visibility": "pub",
40
                    "double_optin": true,
41
                    "has_welcome": false,
42
                    "marketing_permissions": false,
43
                    "modules": [],
44
                    "stats": {
45
                        "member_count": 1234,
46
                        "unsubscribe_count": 56,
47
                        "cleaned_count": 7,
48
                        "member_count_since_send": 8,
49
                        "unsubscribe_count_since_send": 2,
50
                        "cleaned_count_since_send": 1,
51
                        "campaign_count": 15,
52
                        "campaign_last_sent": "2023-05-10T09:00:00+00:00",
53
                        "merge_field_count": 5,
54
                        "avg_sub_rate": 8,
55
                        "avg_unsub_rate": 1,
56
                        "target_sub_rate": 10,
57
                        "open_rate": 25,
58
                        "click_rate": 3,
59
                        "last_sub_date": "2023-05-14T16:48:23+00:00",
60
                        "last_unsub_date": "2023-05-13T11:32:07+00:00"
61
                    },
62
                    "total_items": 1
63
                }
64
            ],
65
            "total_items": 1,
66
            "constraints": {
67
                "may_create": true,
68
                "max_instances": 100,
69
                "current_total_instances": 1
70
            }
71
        }
72
    }
73
}

Search members
Copy

Search for members across your Mailchimp lists.

Sample Input

1
{
2
    "query": "john@example.com",
3
    "list_id": "abc123def456",
4
    "fields": [
5
        "email_address",
6
        "full_name",
7
        "status"
8
    ],
9
    "exclude_fields": [
10
        "tags",
11
        "merge_fields"
12
    ]
13
}

Sample Output

1
{
2
    "exact_matches": {
3
        "members": [
4
            {
5
                "id": "a1b2c3d4e5",
6
                "email_address": "john@example.com",
7
                "unique_email_id": "abc123def456ghi789",
8
                "contact_id": "jkl012mno345",
9
                "full_name": "John Doe",
10
                "web_id": 123456789,
11
                "email_type": "html",
12
                "status": "subscribed",
13
                "consents_to_one_to_one_messaging": true,
14
                "stats": {
15
                    "avg_open_rate": 0.25,
16
                    "avg_click_rate": 0.1
17
                },
18
                "ip_signup": "192.168.1.1",
19
                "timestamp_signup": "2023-04-15T10:30:00Z",
20
                "ip_opt": "192.168.1.1",
21
                "timestamp_opt": "2023-04-15T10:30:00Z",
22
                "member_rating": 4,
23
                "last_changed": "2023-04-20T14:45:00Z",
24
                "language": "en",
25
                "vip": false,
26
                "email_client": "Gmail",
27
                "location": {
28
                    "latitude": 37.7749,
29
                    "longitude": -122.4194,
30
                    "country_code": "US",
31
                    "timezone": "America/Los_Angeles"
32
                },
33
                "source": "Website",
34
                "tags_count": 2,
35
                "list_id": "abc123def456"
36
            }
37
        ],
38
        "total_items": 1
39
    },
40
    "full_search": {
41
        "members": [],
42
        "total_items": 0
43
    },
44
    "_links": [
45
        {
46
            "rel": "self",
47
            "href": "https://us1.api.mailchimp.com/3.0/search-members",
48
            "method": "GET"
49
        }
50
    ]
51
}

Update ecommerce store
Copy

Update a store.

Sample Input

1
{
2
    "store_id": "store123",
3
    "store_name": "My Updated Online Shop",
4
    "platform": "Shopify",
5
    "domain": "myupdatedonlineshop.com",
6
    "is_syncing": true,
7
    "email_address": "contact@myupdatedonlineshop.com",
8
    "currency_code": "USD",
9
    "money_format": "$",
10
    "primary_locale": "en",
11
    "timezone": "America/New_York",
12
    "phone": "+1 (555) 123-4567",
13
    "address": {
14
        "address1": "123 Main St",
15
        "address2": "Suite 456",
16
        "city": "New York",
17
        "province": "New York",
18
        "province_code": "NY",
19
        "postal_code": "10001",
20
        "country": "United States",
21
        "country_code": "US"
22
    }
23
}

Sample Output

1
{
2
    "id": "store123",
3
    "list_id": "abc123def456",
4
    "name": "My Updated Online Shop",
5
    "platform": "Shopify",
6
    "domain": "myupdatedonlineshop.com",
7
    "is_syncing": true,
8
    "email_address": "contact@myupdatedonlineshop.com",
9
    "currency_code": "USD",
10
    "money_format": "$",
11
    "primary_locale": "en",
12
    "timezone": "America/New_York",
13
    "phone": "+1 (555) 123-4567",
14
    "address": {
15
        "address1": "123 Main St",
16
        "address2": "Suite 456",
17
        "city": "New York",
18
        "province": "New York",
19
        "province_code": "NY",
20
        "postal_code": "10001",
21
        "country": "United States",
22
        "country_code": "US",
23
        "longitude": -73.9857,
24
        "latitude": 40.7484
25
    },
26
    "connected_site": {
27
        "site_foreign_id": "shopify_12345",
28
        "site_script": {
29
            "url": "https://chimpstatic.com/mcjs-connected/js/users/abc123def456/store123.js",
30
            "fragment": "<script id=\"mcjs\">!function(c,h,i,m,p){m=c.createElement(h),p=c.getElementsByTagName(h)[0],m.async=1,m.src=i,p.parentNode.insertBefore(m,p)}(document,\"script\",\"https://chimpstatic.com/mcjs-connected/js/users/abc123def456/store123.js\");</script>"
31
        }
32
    },
33
    "automations": {
34
        "abandoned_cart": {
35
            "is_supported": true,
36
            "id": "abc123",
37
            "status": "sending"
38
        },
39
        "abandoned_browse": {
40
            "is_supported": true,
41
            "id": "def456",
42
            "status": "paused"
43
        }
44
    },
45
    "list_is_active": true,
46
    "created_at": "2023-01-15T10:00:00+00:00",
47
    "updated_at": "2023-06-20T14:30:00+00:00",
48
    "_links": [
49
        {
50
            "rel": "self",
51
            "href": "https://us1.api.mailchimp.com/3.0/ecommerce/stores/store123",
52
            "method": "GET",
53
            "targetSchema": "https://us1.api.mailchimp.com/schema/3.0/Definitions/Ecommerce/Stores/Response.json"
54
        },
55
        {
56
            "rel": "parent",
57
            "href": "https://us1.api.mailchimp.com/3.0/ecommerce/stores",
58
            "method": "GET",
59
            "targetSchema": "https://us1.api.mailchimp.com/schema/3.0/Definitions/Ecommerce/Stores/CollectionResponse.json",
60
            "schema": "https://us1.api.mailchimp.com/schema/3.0/Paths/Ecommerce/Stores/Collection.json"
61
        }
62
    ]
63
}

Update order
Copy

Update a specific order.

Sample Input

1
{
2
    "store_id": "store123",
3
    "order_id": "order456",
4
    "currency_code": "USD",
5
    "order_total": 89.99,
6
    "lines": [
7
        {
8
            "id": "line789",
9
            "product_id": "prod101",
10
            "product_variant_id": "var202",
11
            "quantity": 2,
12
            "price": 39.99,
13
            "discount": 5
14
        }
15
    ],
16
    "customer": {
17
        "id": "cust303",
18
        "email_address": "john.doe@example.com",
19
        "opt_in_status": true,
20
        "first_name": "John",
21
        "last_name": "Doe"
22
    },
23
    "campaign_id": "camp404",
24
    "financial_status": "paid",
25
    "fulfillment_status": "shipped",
26
    "order_url": "https://mystore.com/orders/order456",
27
    "discount_total": 5,
28
    "tax_total": 7.2,
29
    "shipping_total": 7.8,
30
    "processed_at_foreign": "2023-06-15T14:30:00Z",
31
    "updated_at_foreign": "2023-06-15T15:00:00Z",
32
    "shipping_address": {
33
        "name": "John Doe",
34
        "address1": "123 Main St",
35
        "city": "Anytown",
36
        "province": "California",
37
        "province_code": "CA",
38
        "postal_code": "12345",
39
        "country": "United States",
40
        "country_code": "US"
41
    }
42
}

Sample Output

1
{
2
    "id": "order456",
3
    "customer": {
4
        "id": "cust303",
5
        "email_address": "john.doe@example.com",
6
        "opt_in_status": true,
7
        "first_name": "John",
8
        "last_name": "Doe",
9
        "orders_count": 5,
10
        "total_spent": 450.75,
11
        "address": {
12
            "address1": "123 Main St",
13
            "city": "Anytown",
14
            "province": "California",
15
            "province_code": "CA",
16
            "postal_code": "12345",
17
            "country": "United States",
18
            "country_code": "US"
19
        },
20
        "created_at": "2023-01-01T10:00:00Z",
21
        "updated_at": "2023-06-15T15:00:00Z"
22
    },
23
    "store_id": "store123",
24
    "campaign_id": "camp404",
25
    "financial_status": "paid",
26
    "fulfillment_status": "shipped",
27
    "currency_code": "USD",
28
    "order_total": 89.99,
29
    "order_url": "https://mystore.com/orders/order456",
30
    "discount_total": 5,
31
    "tax_total": 7.2,
32
    "shipping_total": 7.8,
33
    "processed_at_foreign": "2023-06-15T14:30:00Z",
34
    "updated_at_foreign": "2023-06-15T15:00:00Z",
35
    "shipping_address": {
36
        "name": "John Doe",
37
        "address1": "123 Main St",
38
        "city": "Anytown",
39
        "province": "California",
40
        "province_code": "CA",
41
        "postal_code": "12345",
42
        "country": "United States",
43
        "country_code": "US"
44
    },
45
    "lines": [
46
        {
47
            "id": "line789",
48
            "product_id": "prod101",
49
            "product_title": "Sample Product",
50
            "product_variant_id": "var202",
51
            "product_variant_title": "Large",
52
            "image_url": "https://mystore.com/images/sample-product.jpg",
53
            "quantity": 2,
54
            "price": 39.99,
55
            "discount": 5
56
        }
57
    ],
58
    "_links": [
59
        {
60
            "rel": "self",
61
            "href": "https://us1.api.mailchimp.com/3.0/ecommerce/stores/store123/orders/order456",
62
            "method": "GET",
63
            "targetSchema": "https://us1.api.mailchimp.com/schema/3.0/Definitions/Ecommerce/Orders/Response.json"
64
        }
65
    ]
66
}

Upsert list member
Copy

Add or update a list member.

Sample Input

1
{
2
    "list_id": "abc123def456",
3
    "email_address": "johndoe@example.com",
4
    "status": "subscribed",
5
    "email_type": "html",
6
    "merge_fields": [
7
        {
8
            "key": "FNAME",
9
            "value": "John"
10
        },
11
        {
12
            "key": "LNAME",
13
            "value": "Doe"
14
        }
15
    ],
16
    "interests": [
17
        {
18
            "key": "9a8b7c6d5e",
19
            "value": true
20
        }
21
    ],
22
    "language": "en",
23
    "vip": false,
24
    "location": {
25
        "latitude": 40.7128,
26
        "longitude": -74.006
27
    },
28
    "marketing_permissions": [
29
        {
30
            "marketing_permission_id": "1a2b3c4d5e",
31
            "enabled": true
32
        }
33
    ],
34
    "ip_signup": "192.168.1.1",
35
    "timestamp_signup": "2023-04-15T10:30:00Z"
36
}

Sample Output

1
{
2
    "id": "abc123def456ghi789",
3
    "email_address": "johndoe@example.com",
4
    "unique_email_id": "def456ghi789jkl012",
5
    "contact_id": "mno345pqr678stu901",
6
    "full_name": "John Doe",
7
    "web_id": 123456789,
8
    "email_type": "html",
9
    "status": "subscribed",
10
    "merge_fields": {
11
        "FNAME": "John",
12
        "LNAME": "Doe",
13
        "ADDRESS": "123 Main St, New York, NY 10001",
14
        "PHONE": "+1 (555) 123-4567",
15
        "BIRTHDAY": "01/15"
16
    },
17
    "interests": {
18
        "9a8b7c6d5e": true
19
    },
20
    "stats": {
21
        "avg_open_rate": 0.25,
22
        "avg_click_rate": 0.05,
23
        "ecommerce_data": {
24
            "total_revenue": 250.75,
25
            "number_of_orders": 3,
26
            "currency_code": "USD"
27
        }
28
    },
29
    "ip_signup": "192.168.1.1",
30
    "timestamp_signup": "2023-04-15T10:30:00Z",
31
    "ip_opt": "192.168.1.1",
32
    "timestamp_opt": "2023-04-15T10:30:00Z",
33
    "member_rating": 3,
34
    "last_changed": "2023-04-15T10:30:00Z",
35
    "language": "en",
36
    "vip": false,
37
    "email_client": "Gmail",
38
    "location": {
39
        "latitude": 40.7128,
40
        "longitude": -74.006,
41
        "gmtoff": -4,
42
        "dstoff": 0,
43
        "country_code": "US",
44
        "timezone": "America/New_York",
45
        "region": "NY"
46
    },
47
    "marketing_permissions": [
48
        {
49
            "marketing_permission_id": "1a2b3c4d5e",
50
            "text": "Receive email updates",
51
            "enabled": true
52
        }
53
    ],
54
    "last_note": {
55
        "note_id": 12345,
56
        "created_at": "2023-04-15T10:35:00Z",
57
        "created_by": "user@example.com",
58
        "note": "New subscriber added via API"
59
    },
60
    "source": "API",
61
    "tags_count": 2,
62
    "tags": [
63
        {
64
            "id": 1001,
65
            "name": "New Customer"
66
        },
67
        {
68
            "id": 1002,
69
            "name": "Newsletter Subscriber"
70
        }
71
    ],
72
    "list_id": "abc123def456",
73
    "_links": [
74
        {
75
            "rel": "self",
76
            "href": "https://us1.api.mailchimp.com/3.0/lists/abc123def456/members/abc123def456ghi789",
77
            "method": "GET",
78
            "targetSchema": "https://us1.api.mailchimp.com/schema/3.0/Definitions/Lists/Members/Response.json"
79
        },
80
        {
81
            "rel": "parent",
82
            "href": "https://us1.api.mailchimp.com/3.0/lists/abc123def456/members",
83
            "method": "GET",
84
            "targetSchema": "https://us1.api.mailchimp.com/schema/3.0/Definitions/Lists/Members/CollectionResponse.json",
85
            "schema": "https://us1.api.mailchimp.com/schema/3.0/CollectionLinks/Lists/Members.json"
86
        }
87
    ]
88
}

DDL operations
Copy

List campaign folders (DDL)
Copy

Note that DDL operations can only be called directly by Connectors API, or when using CustomJS in the Embedded solution editor for e.g. DDL-dependent data mapping

Sample Input

1
{}

Sample Output

1
{
2
    "folders": [
3
        {
4
            "id": "12345abcde",
5
            "name": "Newsletter Campaigns",
6
            "count": 5,
7
            "type": "campaign"
8
        },
9
        {
10
            "id": "67890fghij",
11
            "name": "Promotional Campaigns",
12
            "count": 3,
13
            "type": "campaign"
14
        },
15
        {
16
            "id": "54321klmno",
17
            "name": "Event Campaigns",
18
            "count": 2,
19
            "type": "campaign"
20
        }
21
    ],
22
    "total_items": 3
23
}

List campaigns (DDL)
Copy

Note that DDL operations can only be called directly by Connectors API, or when using CustomJS in the Embedded solution editor for e.g. DDL-dependent data mapping

Sample Input

1
{}

Sample Output

1
{
2
    "campaigns": [
3
        {
4
            "id": "b1234abc",
5
            "web_id": 123456,
6
            "type": "regular",
7
            "create_time": "2023-05-15T10:30:00+00:00",
8
            "archive_url": "https://us1.campaign-archive.com/?u=abc123&id=def456",
9
            "long_archive_url": "https://mailchi.mp/abc123/summer-sale-newsletter",
10
            "status": "sent",
11
            "emails_sent": 5000,
12
            "send_time": "2023-05-16T09:00:00+00:00",
13
            "content_type": "template",
14
            "needs_block_refresh": false,
15
            "resendable": true,
16
            "recipients": {
17
                "list_id": "a1b2c3d4e5",
18
                "list_name": "Main Subscribers",
19
                "segment_text": "Entire List",
20
                "recipient_count": 5000
21
            },
22
            "settings": {
23
                "subject_line": "Don't Miss Our Summer Sale!",
24
                "title": "Summer Sale Newsletter",
25
                "from_name": "Your Store",
26
                "reply_to": "support@yourstore.com",
27
                "use_conversation": false,
28
                "to_name": "*|FNAME|*",
29
                "folder_id": "f1g2h3i4",
30
                "authenticate": true,
31
                "auto_footer": true,
32
                "inline_css": true
33
            },
34
            "tracking": {
35
                "opens": true,
36
                "html_clicks": true,
37
                "text_clicks": false,
38
                "goal_tracking": false,
39
                "ecomm360": false,
40
                "google_analytics": "utm_source=mailchimp&utm_medium=email&utm_campaign=summer_sale"
41
            },
42
            "report_summary": {
43
                "opens": 2500,
44
                "unique_opens": 2000,
45
                "open_rate": 50,
46
                "clicks": 750,
47
                "subscriber_clicks": 600,
48
                "click_rate": 15,
49
                "ecommerce": {
50
                    "total_orders": 100,
51
                    "total_spent": 5000,
52
                    "total_revenue": 5000
53
                }
54
            }
55
        },
56
        {
57
            "id": "c5678def",
58
            "web_id": 789012,
59
            "type": "automation",
60
            "create_time": "2023-04-01T14:45:00+00:00",
61
            "archive_url": "https://us1.campaign-archive.com/?u=def456&id=ghi789",
62
            "long_archive_url": "https://mailchi.mp/def456/welcome-series-email-1",
63
            "status": "sending",
64
            "emails_sent": 250,
65
            "send_time": "2023-04-01T15:00:00+00:00",
66
            "content_type": "template",
67
            "needs_block_refresh": false,
68
            "resendable": false,
69
            "recipients": {
70
                "list_id": "e5f6g7h8i9",
71
                "list_name": "New Subscribers",
72
                "segment_text": "Automation",
73
                "recipient_count": 1000
74
            },
75
            "settings": {
76
                "subject_line": "Welcome to Our Community!",
77
                "title": "Welcome Series - Email 1",
78
                "from_name": "Your Community",
79
                "reply_to": "hello@yourcommunity.com",
80
                "use_conversation": true,
81
                "to_name": "*|FNAME|*",
82
                "folder_id": "j5k6l7m8",
83
                "authenticate": true,
84
                "auto_footer": true,
85
                "inline_css": true
86
            },
87
            "tracking": {
88
                "opens": true,
89
                "html_clicks": true,
90
                "text_clicks": true,
91
                "goal_tracking": true,
92
                "ecomm360": true,
93
                "google_analytics": "utm_source=mailchimp&utm_medium=email&utm_campaign=welcome_series"
94
            },
95
            "report_summary": {
96
                "opens": 200,
97
                "unique_opens": 180,
98
                "open_rate": 80,
99
                "clicks": 150,
100
                "subscriber_clicks": 120,
101
                "click_rate": 60,
102
                "ecommerce": {
103
                    "total_orders": 10,
104
                    "total_spent": 500,
105
                    "total_revenue": 500
106
                }
107
            }
108
        }
109
    ],
110
    "total_items": 2
111
}

List currency code (DDL)
Copy

Note that DDL operations can only be called directly by Connectors API, or when using CustomJS in the Embedded solution editor for e.g. DDL-dependent data mapping

Sample Input

1
{}

Sample Output

1
[
2
    {
3
        "value": "USD",
4
        "label": "US Dollar"
5
    },
6
    {
7
        "value": "EUR",
8
        "label": "Euro"
9
    },
10
    {
11
        "value": "GBP",
12
        "label": "British Pound"
13
    },
14
    {
15
        "value": "CAD",
16
        "label": "Canadian Dollar"
17
    },
18
    {
19
        "value": "AUD",
20
        "label": "Australian Dollar"
21
    },
22
    {
23
        "value": "JPY",
24
        "label": "Japanese Yen"
25
    },
26
    {
27
        "value": "CHF",
28
        "label": "Swiss Franc"
29
    }
30
]

List ecommerce store IDs (DDL)
Copy

Note that DDL operations can only be called directly by Connectors API, or when using CustomJS in the Embedded solution editor for e.g. DDL-dependent data mapping

Sample Input

1
{}

Sample Output

1
{
2
    "store_ids": [
3
        "store_001",
4
        "store_002",
5
        "store_003",
6
        "store_004",
7
        "store_005"
8
    ]
9
}

List interest categories (DDL)
Copy

Note that DDL operations can only be called directly by Connectors API, or when using CustomJS in the Embedded solution editor for e.g. DDL-dependent data mapping

Sample Input

1
{}

Sample Output

1
[
2
    {
3
        "id": "a1e9f4b7c2",
4
        "title": "Product Interests",
5
        "type": "checkboxes",
6
        "display_order": 1
7
    },
8
    {
9
        "id": "b3d8c6a5f1",
10
        "title": "Newsletter Preferences",
11
        "type": "radio",
12
        "display_order": 2
13
    },
14
    {
15
        "id": "e2f7h9j4k6",
16
        "title": "Event Attendance",
17
        "type": "dropdown",
18
        "display_order": 3
19
    }
20
]

List interests (DDL)
Copy

Note that DDL operations can only be called directly by Connectors API, or when using CustomJS in the Embedded solution editor for e.g. DDL-dependent data mapping

Sample Input

1
{}

Sample Output

1
[
2
    {
3
        "id": "a1b2c3d4e5",
4
        "name": "Technology",
5
        "display_order": 1
6
    },
7
    {
8
        "id": "f6g7h8i9j0",
9
        "name": "Sports",
10
        "display_order": 2
11
    },
12
    {
13
        "id": "k1l2m3n4o5",
14
        "name": "Travel",
15
        "display_order": 3
16
    },
17
    {
18
        "id": "p6q7r8s9t0",
19
        "name": "Food & Cooking",
20
        "display_order": 4
21
    },
22
    {
23
        "id": "u1v2w3x4y5",
24
        "name": "Fashion",
25
        "display_order": 5
26
    }
27
]

List language codes (DDL)
Copy

Note that DDL operations can only be called directly by Connectors API, or when using CustomJS in the Embedded solution editor for e.g. DDL-dependent data mapping

Sample Input

1
{}

Sample Output

1
[
2
    {
3
        "value": "en",
4
        "label": "English"
5
    },
6
    {
7
        "value": "es",
8
        "label": "Spanish"
9
    },
10
    {
11
        "value": "fr",
12
        "label": "French"
13
    },
14
    {
15
        "value": "de",
16
        "label": "German"
17
    },
18
    {
19
        "value": "it",
20
        "label": "Italian"
21
    },
22
    {
23
        "value": "pt",
24
        "label": "Portuguese"
25
    },
26
    {
27
        "value": "ja",
28
        "label": "Japanese"
29
    },
30
    {
31
        "value": "zh",
32
        "label": "Chinese"
33
    },
34
    {
35
        "value": "ru",
36
        "label": "Russian"
37
    },
38
    {
39
        "value": "ar",
40
        "label": "Arabic"
41
    }
42
]

List list merge fields (DDL)
Copy

Note that DDL operations can only be called directly by Connectors API, or when using CustomJS in the Embedded solution editor for e.g. DDL-dependent data mapping

Sample Input

1
{}

Sample Output

1
{
2
    "merge_fields": [
3
        {
4
            "merge_id": 1,
5
            "tag": "FNAME",
6
            "name": "First Name",
7
            "type": "text",
8
            "required": false,
9
            "default_value": "",
10
            "public": true,
11
            "display_order": 1,
12
            "options": {
13
                "size": 25
14
            },
15
            "help_text": "",
16
            "list_id": "abc123def456"
17
        },
18
        {
19
            "merge_id": 2,
20
            "tag": "LNAME",
21
            "name": "Last Name",
22
            "type": "text",
23
            "required": false,
24
            "default_value": "",
25
            "public": true,
26
            "display_order": 2,
27
            "options": {
28
                "size": 25
29
            },
30
            "help_text": "",
31
            "list_id": "abc123def456"
32
        },
33
        {
34
            "merge_id": 3,
35
            "tag": "BIRTHDAY",
36
            "name": "Birthday",
37
            "type": "date",
38
            "required": false,
39
            "default_value": "",
40
            "public": true,
41
            "display_order": 3,
42
            "options": {
43
                "date_format": "MM/DD"
44
            },
45
            "help_text": "Please enter your birthday",
46
            "list_id": "abc123def456"
47
        }
48
    ],
49
    "total_items": 3
50
}

List list segments (DDL)
Copy

Note that DDL operations can only be called directly by Connectors API, or when using CustomJS in the Embedded solution editor for e.g. DDL-dependent data mapping

Sample Input

1
{}

Sample Output

1
{
2
    "segments": [
3
        {
4
            "id": 49381,
5
            "name": "Newsletter Subscribers",
6
            "member_count": 3542,
7
            "type": "saved",
8
            "created_at": "2023-05-15T09:23:47+00:00",
9
            "updated_at": "2023-06-01T14:30:22+00:00",
10
            "options": {
11
                "match": "all",
12
                "conditions": [
13
                    {
14
                        "field": "timestamp_opt",
15
                        "op": "greater",
16
                        "value": "2023-01-01T00:00:00+00:00"
17
                    }
18
                ]
19
            }
20
        },
21
        {
22
            "id": 49382,
23
            "name": "High Value Customers",
24
            "member_count": 1250,
25
            "type": "saved",
26
            "created_at": "2023-05-16T11:45:30+00:00",
27
            "updated_at": "2023-05-31T16:20:15+00:00",
28
            "options": {
29
                "match": "all",
30
                "conditions": [
31
                    {
32
                        "field": "total_spent",
33
                        "op": "greater",
34
                        "value": "1000"
35
                    }
36
                ]
37
            }
38
        }
39
    ],
40
    "total_items": 2,
41
    "links": [
42
        {
43
            "rel": "self",
44
            "href": "https://us1.api.mailchimp.com/3.0/lists/abc123/segments",
45
            "method": "GET",
46
            "targetSchema": "https://us1.api.mailchimp.com/schema/3.0/Definitions/Lists/Segments/CollectionResponse.json"
47
        }
48
    ]
49
}

List lists (DDL)
Copy

Note that DDL operations can only be called directly by Connectors API, or when using CustomJS in the Embedded solution editor for e.g. DDL-dependent data mapping

Sample Input

1
{}

Sample Output

1
[
2
    {
3
        "id": "a1b2c3d4e5",
4
        "name": "Newsletter Subscribers",
5
        "web_id": 123456,
6
        "contact": {
7
            "company": "Acme Corp",
8
            "address1": "123 Main St",
9
            "address2": "Suite 456",
10
            "city": "Springfield",
11
            "state": "IL",
12
            "zip": "62701",
13
            "country": "US",
14
            "phone": "555-123-4567"
15
        },
16
        "permission_reminder": "You're receiving this email because you signed up for our newsletter.",
17
        "use_archive_bar": true,
18
        "campaign_defaults": {
19
            "from_name": "Acme Marketing",
20
            "from_email": "marketing@acmecorp.com",
21
            "subject": "",
22
            "language": "en"
23
        },
24
        "notify_on_subscribe": "marketing@acmecorp.com",
25
        "notify_on_unsubscribe": "marketing@acmecorp.com",
26
        "date_created": "2023-05-15T10:30:00+00:00",
27
        "list_rating": 4,
28
        "email_type_option": true,
29
        "subscribe_url_short": "http://eepurl.com/abcdef",
30
        "subscribe_url_long": "https://acmecorp.us1.list-manage.com/subscribe?u=a1b2c3d4e5f6g7h8i9j0&id=1234567890",
31
        "beamer_address": "us1-a1b2c3d4e5-acmecorp@inbound.mailchimp.com",
32
        "visibility": "pub",
33
        "double_optin": true,
34
        "has_welcome": false,
35
        "marketing_permissions": true,
36
        "modules": [],
37
        "stats": {
38
            "member_count": 5000,
39
            "unsubscribe_count": 150,
40
            "cleaned_count": 50,
41
            "member_count_since_send": 4800,
42
            "unsubscribe_count_since_send": 20,
43
            "cleaned_count_since_send": 5,
44
            "campaign_count": 25,
45
            "campaign_last_sent": "2023-05-10T09:00:00+00:00",
46
            "merge_field_count": 5,
47
            "avg_sub_rate": 10,
48
            "avg_unsub_rate": 0.5,
49
            "target_sub_rate": 15,
50
            "open_rate": 22.5,
51
            "click_rate": 3.8,
52
            "last_sub_date": "2023-05-15T08:45:00+00:00",
53
            "last_unsub_date": "2023-05-14T16:30:00+00:00"
54
        }
55
    },
56
    {
57
        "id": "f6g7h8i9j0",
58
        "name": "Product Updates",
59
        "web_id": 789012,
60
        "contact": {
61
            "company": "Acme Corp",
62
            "address1": "456 Oak Ave",
63
            "address2": "",
64
            "city": "Springfield",
65
            "state": "IL",
66
            "zip": "62702",
67
            "country": "US",
68
            "phone": "555-987-6543"
69
        },
70
        "permission_reminder": "You're receiving this email because you opted in for product updates.",
71
        "use_archive_bar": false,
72
        "campaign_defaults": {
73
            "from_name": "Acme Product Team",
74
            "from_email": "products@acmecorp.com",
75
            "subject": "",
76
            "language": "en"
77
        },
78
        "notify_on_subscribe": "products@acmecorp.com",
79
        "notify_on_unsubscribe": "products@acmecorp.com",
80
        "date_created": "2023-03-01T14:15:00+00:00",
81
        "list_rating": 5,
82
        "email_type_option": true,
83
        "subscribe_url_short": "http://eepurl.com/ghijkl",
84
        "subscribe_url_long": "https://acmecorp.us1.list-manage.com/subscribe?u=f6g7h8i9j0k1l2m3n4o5&id=0987654321",
85
        "beamer_address": "us1-f6g7h8i9j0-acmecorp@inbound.mailchimp.com",
86
        "visibility": "prv",
87
        "double_optin": false,
88
        "has_welcome": true,
89
        "marketing_permissions": false,
90
        "modules": [],
91
        "stats": {
92
            "member_count": 2500,
93
            "unsubscribe_count": 75,
94
            "cleaned_count": 25,
95
            "member_count_since_send": 2450,
96
            "unsubscribe_count_since_send": 5,
97
            "cleaned_count_since_send": 2,
98
            "campaign_count": 12,
99
            "campaign_last_sent": "2023-05-05T11:00:00+00:00",
100
            "merge_field_count": 3,
101
            "avg_sub_rate": 8,
102
            "avg_unsub_rate": 0.3,
103
            "target_sub_rate": 12,
104
            "open_rate": 35.2,
105
            "click_rate": 6.7,
106
            "last_sub_date": "2023-05-15T10:20:00+00:00",
107
            "last_unsub_date": "2023-05-13T09:15:00+00:00"
108
        }
109
    }
110
]
Previous

Overview

Next

Operations