Skip to content

Commit 57d0968

Browse files
authored
fix(mailchimp): archive members correctly, add permanent delete, and align requests with the marketing api (#10031)
* fix(mailchimp): archive via DELETE member, add permanent delete, hash member emails and guard path ids, require status_if_new on unarchive, default tag status, stringify batch bodies * fix(mailchimp): reject empty tag and batch inputs instead of sending no-ops, keep numeric tag names, document the archive and permanent delete actions * chore(docs): regenerate integration docs, catalog, and tool metadata * fix(mailchimp): parse tags as JSON only when they look like JSON and reject malformed JSON * fix(mailchimp): reject tag statuses other than active and inactive
1 parent 769e6cf commit 57d0968

74 files changed

Lines changed: 664 additions & 122 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

‎apps/docs/content/docs/integrations/mailchimp.mdx‎

Lines changed: 30 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -14,9 +14,9 @@ Use [Mailchimp](https://mailchimp.com/) in Sim to manage audiences and members,
1414

1515
## Member removal
1616

17-
**Delete Member from Mailchimp Audience** calls Mailchimp's reversible archive endpoint. **Archive Member from Mailchimp Audience** instead targets permanent deletion of identifying data, after which the member cannot be re-imported. These UI labels differ from the provider's terminology.
17+
**Delete Member from Mailchimp Audience** and **Archive Member from Mailchimp Audience** both call Mailchimp's reversible [archive endpoint](https://mailchimp.com/developer/marketing/api/list-members/archive-list-member); an archived member can be added back.
1818

19-
The current permanent-deletion action sends `DELETE`, while [Mailchimp documents `POST` for delete-permanent](https://mailchimp.com/developer/marketing/api/lists/members/create-member-action-delete-permanent). Its compatibility is unverified; do not rely on it for deletion until the request method is corrected and tested.
19+
**Permanently Delete Member from Mailchimp Audience** calls [`POST .../actions/delete-permanent`](https://mailchimp.com/developer/marketing/api/list-member-actions/delete-list-member-permanently), which erases the member's identifying data. It cannot be undone, and the address cannot be re-imported.
2020
{/* MANUAL-CONTENT-END */}
2121

2222
## Use the block [#usage-instructions]
@@ -307,9 +307,32 @@ Archive a member from a Mailchimp audience without permanently deleting their da
307307

308308
</ReferenceDetails>
309309

310+
### Permanently Delete Member from Mailchimp Audience
311+
312+
Permanently delete a member and their personally identifiable data from a Mailchimp audience. This cannot be undone, and the address cannot be re-imported.
313+
314+
<ReferenceDetails>
315+
316+
#### Input
317+
318+
| Parameter | Type | Required | Description |
319+
| --------- | ---- | -------- | ----------- |
320+
| `listId` | string | Yes | The unique ID for the audience/list \(e.g., "abc123def4"\) |
321+
| `subscriberEmail` | string | Yes | Member email address or MD5 hash of the lowercase email |
322+
323+
#### Output
324+
325+
| Parameter | Type | Description |
326+
| --------- | ---- | ----------- |
327+
| `success` | boolean | Operation success status |
328+
| `output` | object | Permanent deletion confirmation |
329+
| ↳ `success` | boolean | Operation success |
330+
331+
</ReferenceDetails>
332+
310333
### Archive Member from Mailchimp Audience
311334

312-
Request permanent deletion of a member and their identifying data. This targets delete-permanent, despite the Archive Member label; provider acceptance of the current HTTP method is unverified.
335+
Archive a member in a Mailchimp audience. Archived contacts keep their data and can be restored with Unarchive Member.
313336

314337
<ReferenceDetails>
315338

@@ -325,7 +348,7 @@ Request permanent deletion of a member and their identifying data. This targets
325348
| Parameter | Type | Description |
326349
| --------- | ---- | ----------- |
327350
| `success` | boolean | Operation success status |
328-
| `output` | object | Permanent-deletion request confirmation |
351+
| `output` | object | Archive confirmation |
329352
| ↳ `success` | boolean | Operation success |
330353

331354
</ReferenceDetails>
@@ -1137,7 +1160,7 @@ Add tags to a member in a Mailchimp audience
11371160
| --------- | ---- | -------- | ----------- |
11381161
| `listId` | string | Yes | The unique ID for the audience/list \(e.g., "abc123def4"\) |
11391162
| `subscriberEmail` | string | Yes | Member email address or MD5 hash of the lowercase email |
1140-
| `tags` | string | Yes | JSON array of tag objects \(e.g., \[\{"name": "VIP", "status": "active"\}\]\) |
1163+
| `tags` | string | Yes | JSON array of tag objects \(e.g., \[\{"name": "VIP", "status": "active"\}\]\) or a comma-separated list of tag names; status defaults to "active" |
11411164

11421165
#### Output
11431166

@@ -1161,7 +1184,7 @@ Remove tags from a member in a Mailchimp audience
11611184
| --------- | ---- | -------- | ----------- |
11621185
| `listId` | string | Yes | The unique ID for the audience/list \(e.g., "abc123def4"\) |
11631186
| `subscriberEmail` | string | Yes | Member email address or MD5 hash of the lowercase email |
1164-
| `tags` | string | Yes | JSON array of tag objects with inactive status \(e.g., \[\{"name": "VIP", "status": "inactive"\}\]\) |
1187+
| `tags` | string | Yes | JSON array of tag objects with inactive status \(e.g., \[\{"name": "VIP", "status": "inactive"\}\]\) or a comma-separated list of tag names; status defaults to "inactive" |
11651188

11661189
#### Output
11671190

@@ -1766,7 +1789,7 @@ Create a new batch operation in Mailchimp
17661789

17671790
| Parameter | Type | Required | Description |
17681791
| --------- | ---- | -------- | ----------- |
1769-
| `operations` | string | Yes | JSON array of batch operations \(e.g., \[\{"method": "POST", "path": "/lists/\{list_id\}/members", "body": "..."\}\]\) |
1792+
| `operations` | string | Yes | JSON array of batch operations \(e.g., \[\{"method": "POST", "path": "/lists/\{list_id\}/members", "body": \{"email_address": "user@example.com", "status": "subscribed"\}\}\]\); an object body is sent as the JSON string Mailchimp expects |
17701793

17711794
#### Output
17721795

‎apps/sim/blocks/blocks/mailchimp.ts‎

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -63,6 +63,10 @@ export const MailchimpBlock: BlockConfig = {
6363
{ text: 'Delete member', field: 'subscriberEmail', core: true },
6464
{ text: 'from audience', field: 'listId' },
6565
],
66+
delete_member_permanent: [
67+
{ text: 'Permanently delete member', field: 'subscriberEmail', core: true },
68+
{ text: 'from audience', field: 'listId' },
69+
],
6670
archive_member: [
6771
{ text: 'Archive member', field: 'subscriberEmail', core: true },
6872
{ text: 'in audience', field: 'listId' },
@@ -322,6 +326,7 @@ export const MailchimpBlock: BlockConfig = {
322326
{ label: 'Add or Update Member', id: 'add_or_update_member' },
323327
{ label: 'Update Member', id: 'update_member' },
324328
{ label: 'Delete Member', id: 'delete_member' },
329+
{ label: 'Permanently Delete Member', id: 'delete_member_permanent' },
325330
{ label: 'Archive Member', id: 'archive_member' },
326331
{ label: 'Unarchive Member', id: 'unarchive_member' },
327332
// Campaign operations
@@ -425,6 +430,7 @@ export const MailchimpBlock: BlockConfig = {
425430
'add_or_update_member',
426431
'update_member',
427432
'delete_member',
433+
'delete_member_permanent',
428434
'archive_member',
429435
'unarchive_member',
430436
'get_segments',
@@ -467,6 +473,7 @@ export const MailchimpBlock: BlockConfig = {
467473
'add_or_update_member',
468474
'update_member',
469475
'delete_member',
476+
'delete_member_permanent',
470477
'archive_member',
471478
'unarchive_member',
472479
'get_segments',
@@ -656,6 +663,7 @@ Return ONLY the JSON object - no explanations or markdown.`,
656663
'get_member',
657664
'update_member',
658665
'delete_member',
666+
'delete_member_permanent',
659667
'archive_member',
660668
'unarchive_member',
661669
'get_member_tags',
@@ -671,6 +679,7 @@ Return ONLY the JSON object - no explanations or markdown.`,
671679
'get_member',
672680
'update_member',
673681
'delete_member',
682+
'delete_member_permanent',
674683
'archive_member',
675684
'unarchive_member',
676685
'get_member_tags',
@@ -1660,6 +1669,7 @@ Return ONLY the JSON array - no explanations or markdown.`,
16601669
'mailchimp_add_or_update_member',
16611670
'mailchimp_update_member',
16621671
'mailchimp_delete_member',
1672+
'mailchimp_delete_member_permanent',
16631673
'mailchimp_archive_member',
16641674
'mailchimp_unarchive_member',
16651675
'mailchimp_get_campaigns',

‎apps/sim/tools/generated/tool-ids.ts‎

Lines changed: 1 addition & 1 deletion
Large diffs are not rendered by default.

‎apps/sim/tools/generated/tool-metadata.ts‎

Lines changed: 1 addition & 1 deletion
Large diffs are not rendered by default.

‎apps/sim/tools/generated/tool-outputs.ts‎

Lines changed: 1 addition & 1 deletion
Large diffs are not rendered by default.

‎apps/sim/tools/mailchimp/add_member.ts‎

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,7 @@ import {
66
} from '@/tools/mailchimp/types'
77
import { MAILCHIMP_CREDENTIAL_OAUTH } from '@/tools/shared/saved-credentials'
88
import type { ToolConfig } from '@/tools/types'
9+
import { safeUrlPathSegment } from '@/tools/url-path'
910

1011
const logger = createLogger('MailchimpAddMember')
1112

@@ -78,7 +79,11 @@ export const mailchimpAddMemberTool: ToolConfig<
7879
},
7980

8081
request: {
81-
url: (params) => buildMailchimpUrl(params.apiKey, `/lists/${params.listId}/members`),
82+
url: (params) =>
83+
buildMailchimpUrl(
84+
params.apiKey,
85+
`/lists/${safeUrlPathSegment(params.listId, 'listId')}/members`
86+
),
8287
method: 'POST',
8388
headers: (params) => ({
8489
Authorization: `Bearer ${params.apiKey}`,

‎apps/sim/tools/mailchimp/add_member_tags.ts‎

Lines changed: 11 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,12 @@
1-
import { createLogger } from '@sim/logger'
2-
import { buildMailchimpUrl, handleMailchimpError } from '@/tools/mailchimp/types'
1+
import {
2+
buildMailchimpUrl,
3+
buildMemberTags,
4+
handleMailchimpError,
5+
mailchimpMemberSegment,
6+
} from '@/tools/mailchimp/types'
37
import { MAILCHIMP_CREDENTIAL_OAUTH } from '@/tools/shared/saved-credentials'
48
import type { ToolConfig } from '@/tools/types'
5-
6-
const logger = createLogger('MailchimpAddMemberTags')
9+
import { safeUrlPathSegment } from '@/tools/url-path'
710

811
export interface MailchimpAddMemberTagsParams {
912
apiKey: string
@@ -52,31 +55,23 @@ export const mailchimpAddMemberTagsTool: ToolConfig<
5255
type: 'string',
5356
required: true,
5457
visibility: 'user-or-llm',
55-
description: 'JSON array of tag objects (e.g., [{"name": "VIP", "status": "active"}])',
58+
description:
59+
'JSON array of tag objects (e.g., [{"name": "VIP", "status": "active"}]) or a comma-separated list of tag names; status defaults to "active"',
5660
},
5761
},
5862

5963
request: {
6064
url: (params) =>
6165
buildMailchimpUrl(
6266
params.apiKey,
63-
`/lists/${params.listId}/members/${params.subscriberEmail}/tags`
67+
`/lists/${safeUrlPathSegment(params.listId, 'listId')}/members/${mailchimpMemberSegment(params.subscriberEmail)}/tags`
6468
),
6569
method: 'POST',
6670
headers: (params) => ({
6771
Authorization: `Bearer ${params.apiKey}`,
6872
'Content-Type': 'application/json',
6973
}),
70-
body: (params) => {
71-
let tags = []
72-
try {
73-
tags = JSON.parse(params.tags)
74-
} catch (error) {
75-
logger.warn('Failed to parse tags', { error })
76-
}
77-
78-
return { tags }
79-
},
74+
body: (params) => ({ tags: buildMemberTags(params.tags, 'active') }),
8075
},
8176

8277
transformResponse: async (response: Response) => {

‎apps/sim/tools/mailchimp/add_or_update_member.ts‎

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,9 +3,11 @@ import {
33
buildMailchimpUrl,
44
handleMailchimpError,
55
type MailchimpMember,
6+
mailchimpMemberSegment,
67
} from '@/tools/mailchimp/types'
78
import { MAILCHIMP_CREDENTIAL_OAUTH } from '@/tools/shared/saved-credentials'
89
import type { ToolConfig } from '@/tools/types'
10+
import { safeUrlPathSegment } from '@/tools/url-path'
911

1012
const logger = createLogger('MailchimpAddOrUpdateMember')
1113

@@ -86,7 +88,10 @@ export const mailchimpAddOrUpdateMemberTool: ToolConfig<
8688

8789
request: {
8890
url: (params) =>
89-
buildMailchimpUrl(params.apiKey, `/lists/${params.listId}/members/${params.subscriberEmail}`),
91+
buildMailchimpUrl(
92+
params.apiKey,
93+
`/lists/${safeUrlPathSegment(params.listId, 'listId')}/members/${mailchimpMemberSegment(params.subscriberEmail)}`
94+
),
9095
method: 'PUT',
9196
headers: (params) => ({
9297
Authorization: `Bearer ${params.apiKey}`,

‎apps/sim/tools/mailchimp/add_segment_member.ts‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,7 @@ import {
55
} from '@/tools/mailchimp/types'
66
import { MAILCHIMP_CREDENTIAL_OAUTH } from '@/tools/shared/saved-credentials'
77
import type { ToolConfig } from '@/tools/types'
8+
import { safeUrlPathSegment } from '@/tools/url-path'
89

910
export interface MailchimpAddSegmentMemberParams {
1011
apiKey: string
@@ -62,7 +63,7 @@ export const mailchimpAddSegmentMemberTool: ToolConfig<
6263
url: (params) =>
6364
buildMailchimpUrl(
6465
params.apiKey,
65-
`/lists/${params.listId}/segments/${params.segmentId}/members`
66+
`/lists/${safeUrlPathSegment(params.listId, 'listId')}/segments/${safeUrlPathSegment(params.segmentId, 'segmentId')}/members`
6667
),
6768
method: 'POST',
6869
headers: (params) => ({

‎apps/sim/tools/mailchimp/add_subscriber_to_automation.ts‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,7 @@ import type { MailchimpMember } from '@/tools/mailchimp/types'
22
import { buildMailchimpUrl, handleMailchimpError } from '@/tools/mailchimp/types'
33
import { MAILCHIMP_CREDENTIAL_OAUTH } from '@/tools/shared/saved-credentials'
44
import type { ToolConfig } from '@/tools/types'
5+
import { safeUrlPathSegment } from '@/tools/url-path'
56

67
export interface MailchimpAddSubscriberToAutomationParams {
78
apiKey: string
@@ -59,7 +60,7 @@ export const mailchimpAddSubscriberToAutomationTool: ToolConfig<
5960
url: (params) =>
6061
buildMailchimpUrl(
6162
params.apiKey,
62-
`/automations/${params.workflowId}/emails/${params.workflowEmailId}/queue`
63+
`/automations/${safeUrlPathSegment(params.workflowId, 'workflowId')}/emails/${safeUrlPathSegment(params.workflowEmailId, 'workflowEmailId')}/queue`
6364
),
6465
method: 'POST',
6566
headers: (params) => ({

0 commit comments

Comments
 (0)