FlowmageDocs

Change list membership

BetaChanges data

Adds records to a HubSpot list, removes them, or both.

Settings

SettingWhat it is
ConnectionRequiredThe HubSpot connection the step signs in with.
List idRequiredThe List lists node gives you the id.
What to doOnly manual and snapshot lists can be changed this way — a dynamic list is maintained by its own filters.
Ids to addany JSON
Ids to removeany JSON
Technical details
KeyValue
connectiontexta connection id from `requires.connections` (provider `hubspot`)
listIdtextits `{{ }}` must give a string
mode"add" or "remove" or "addAndRemove", by default "add"
recordIdsToAddany JSONits `{{ }}` must give an array; used when `mode` is one of "add", "addAndRemove"
recordIdsToRemoveany JSONits `{{ }}` must give an array; used when `mode` is one of "remove", "addAndRemove"

Output

FieldType
listIdstring
recordsAddedIds sent to be addednumber
recordsRemovedIds sent to be removednumber
Sample output, and the expression for each field
  • listId"7"
  • recordsAdded2
  • recordsRemoved0

Errors

When a step of this node stops a run, the run page shows a code. Look it up:

Example step

The step as a flow file holds it. Replace each value in <…>.

{
  "config": {
    "connection": "<connection id>",
    "listId": "<list id>",
    "mode": "add"
  },
  "label": "Change list membership",
  "type": "hubspot.updateListMembership",
  "version": 1
}