Remove Contacts From List
brevo.remove_contacts_from_list
ActionEmailconnection required
Calls the Brevo API with the connection's credentials.
Unsubscribe contacts from a list by email, numeric id or ext_id, or clear the whole list with 'remove_all'.
Connection
- Required
- Yes — the node will not save without one
- Auth type
- API key
- Providers
- Brevo
- Secret shape
- the API key, or {"api_key": "…"}
- Config it needs
- sender_email, sender_name, sms_sender
- Resolved by
- config.connection_id, else node.connection_id
Configuration
5 fields, 1 required. A dotted path is a nested object and name[] an array of objects — the editor renders the same tree.
| Field | Type | Required | Default | Constraints | Example |
|---|---|---|---|---|---|
list_id Numeric id of the Brevo contact list to act on. | string | Yes | — | — | 12 |
emails Email addresses of existing contacts, at most 150 per call. | array | No | — | ≥ 1 characters; array of string | ["jane@example.com"] |
ids Numeric contact ids, at most 150 per call. | array | No | — | ≥ 1 characters; array of string | ["42"] |
ext_ids EXT_ID attribute values of existing contacts, at most 150 per call. | array | No | — | ≥ 1 characters; array of string | ["crm-8891"] |
remove_all Remove every contact from the list. Brevo runs this in the background and answers with a process id. | boolean | No | false | — | — |
- At least one of emails, ids, ext_ids, remove_all must be set.
Example configuration
Every value below is the contract’s own example or default — nothing invented.
{
"emails": [
"jane@example.com"
],
"ext_ids": [
"crm-8891"
],
"ids": [
"42"
],
"list_id": "12",
"remove_all": false
}Output
One shape.
result
| Field | Type | Example |
|---|---|---|
list_id The list the contacts were added to or removed from. | string | — |
success Identifiers Brevo applied the change to. | array | — |
failure Identifiers Brevo refused, e.g. already in or out of the list. | array | — |
process_id Background job id, set only when removing every contact. | number | — |
total Contacts the background removal covers, when one was started. | number | — |
{
"failure": [],
"list_id": "",
"process_id": 0,
"success": [],
"total": 0
}See Remove Contacts From List run in a workflow.
In a technical demo we add the Brevo connection, drop the node on the canvas and let Workflow Health pre-flight it before the first real run.