Mailchimp Audiences UpdateMemberTags

Mailchimp Audiences UpdateMemberTags

Certified

Add or remove tags on a Mailchimp member

Changes the tags of one member with POST /lists/{listId}/members/{subscriberHash}/tags. Each tag is set ACTIVE (added) or INACTIVE (removed). Mailchimp answers 204 without a body.

Only add contacts who have opted in; you are responsible for GDPR and Mailchimp terms.

yaml
type: io.kestra.plugin.mailchimp.audiences.UpdateMemberTags

Tag a contact and remove another tag.

yaml
id: mailchimp_update_member_tags
namespace: company.team

tasks:
  - id: tags
    type: io.kestra.plugin.mailchimp.audiences.UpdateMemberTags
    apiKey: "{{ secret('MAILCHIMP_API_KEY') }}"
    listId: "a1b2c3d4e5"
    email: "jane.doe@example.com"
    tags:
      - name: customer
        status: ACTIVE
      - name: lead
        status: INACTIVE
Properties

Email address

Member email. Trimmed and lower-cased before it is hashed.

Audience ID

Mailchimp audience (list) id, found in the audience settings or with ListAudiences.

Tags

Tag changes, at least one. Each has a name and a status of ACTIVE or INACTIVE.

Definitions
namestring

Tag name

Name of the tag; it is created when it does not exist yet.

statusstring
Possible Values
ACTIVEINACTIVE

Tag status

ACTIVE adds the tag, INACTIVE removes it.

OAuth access token

Set exactly one of apiKey or accessToken. server is required with an access token.

Mailchimp API key

Set exactly one of apiKey or accessToken. The data center is taken from the key suffix (for example -us19) unless server is set.

Assets this task consumes as inputs or produces as outputs, for lineage tracking and the asset graph (Enterprise Edition). A flow declaring this property on a task is rejected in the open-source edition.

Definitions
assetFailureBehaviorstring
Possible Values
IGNOREFAILWARN

Asset failure behavior

Behavior applied to the task state when a declared asset fails to render, emit, or be persisted (e.g. a lock conflict): FAIL escalates it to FAILED, WARN (default) warns it if it would otherwise succeed, IGNORE leaves the state untouched.

enableAutobooleanstring

Whether to auto-register assets referenced dynamically at runtime that are not statically declared in inputs or outputs.

inputsarray

The assets consumed as inputs.

id*string
Min length1
typestring
outputs

The assets produced as outputs.

id*string
Min length1
Max length150
type*object
descriptionstring
displayNamestring
metadataobject
Default{}
namespacestring
Min length1
Max length150
id*string
Min length1
Max length150
type*object
descriptionstring
displayNamestring
metadataobject
Default{}
namespacestring
Min length1
Max length150
id*string
Min length1
Max length150
type*object
descriptionstring
displayNamestring
metadataobject
Default{}
namespacestring
Min length1
Max length150
id*string
Min length1
Max length150
type*object
descriptionstring
displayNamestring
metadataobject
Default{}
namespacestring
Min length1
Max length150
id*string
Min length1
Max length150
type*object
descriptionstring
displayNamestring
metadataobject
Default{}
namespacestring
Min length1
Max length150
id*string
Min length1
Max length150
type*string
Min length1

Custom asset type

descriptionstring
displayNamestring
metadataobject
Default{}
namespacestring
Min length1
Max length150

Base URL override

Replaces https://<server>.api.mailchimp.com/3.0. The credential is sent to this URL, so it must be an https *.api.mailchimp.com host.

Default3

Max retries

Retries done by this plugin on HTTP 429 (all methods) and on 5xx or I/O errors (GET and PUT only), with exponential backoff. Default 3, between 0 and 10. Kestra's HTTP client also replays a GET or PUT once after a 429 or 503 on its own, so 0 only turns off the plugin's retries.

Data center

Mailchimp data center such as us19. Required with accessToken, optional with apiKey (overrides the key suffix).

Sync tags

When true, the member's tags become exactly the active ones (is_syncing). Not sent when unset.

DefaultPT2M

Request timeout

Idle read timeout of each call: how long to wait without receiving data. Default PT2M, must be positive. Mailchimp itself cuts requests off after 120 seconds.