Bulk Update Users
iterable.bulk_update_users
ActionEmailconnection required
Calls the Iterable API with the connection's credentials.
Create or update many user profiles in one call.
Connection
- Required
- Yes — the node will not save without one
- Auth type
- API key
- Providers
- Iterable
- Secret shape
- the API key, or {"api_key": "…"}
- Config it needs
- region, base_url
- Resolved by
- config.connection_id, else node.connection_id
Configuration
2 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 |
|---|---|---|---|---|---|
users The profiles to write, as a JSON array of Iterable user objects ({email or userId, dataFields}). At least one profile is required. | array | Yes | — | ≥ 1 characters; array of object | [{"dataFields":{"plan":"pro"},"email":"ada@example.com"}] |
create_new_fields Add data fields the project schema does not know yet. | boolean | No | — | — | — |
Example configuration
Every value below is the contract’s own example or default — nothing invented.
{
"users": [
{
"dataFields": {
"plan": "pro"
},
"email": "ada@example.com"
}
]
}Output
One shape.
result
| Field | Type | Example |
|---|---|---|
success_count How many records Iterable applied. | number | — |
fail_count How many records Iterable rejected. | number | — |
partial True when some records were applied and others were rejected. | boolean | — |
failed_updates Iterable's breakdown of the rejected records: invalid, not-found, conflicting and GDPR-forgotten identifiers. | object | — |
created_fields Profile fields Iterable created for this request. | array | — |
filtered_out_fields Fields Iterable dropped because they were not known. | array | — |
{
"created_fields": [],
"fail_count": 0,
"failed_updates": {},
"filtered_out_fields": [],
"partial": false,
"success_count": 0
}Notes
- Iterable answers 200 even when some records fail: check 'fail_count' and 'failed_updates', not just the absence of an error.
See Bulk Update Users run in a workflow.
In a technical demo we add the Iterable connection, drop the node on the canvas and let Workflow Health pre-flight it before the first real run.