Update User
iterable.update_user
ActionEmailconnection required
Calls the Iterable API with the connection's credentials.
Create or update a user profile, merging the supplied data fields into it.
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
6 fields, none 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 |
|---|---|---|---|---|---|
email The email address that identifies the user. Provide this or 'user_id'. | string | No | — | email format | — |
user_id The userId that identifies the user. Provide this or 'email'. | string | No | — | — | — |
data_fields Custom fields to store, as a JSON object. Iterable merges them into the profile. | object | No | — | — | — |
prefer_user_id Create the profile from 'user_id' when no matching user exists. | boolean | No | — | — | — |
merge_nested_objects Merge nested objects into the profile instead of overwriting them. | boolean | No | — | — | — |
create_new_fields Add data fields the project schema does not know yet. | boolean | No | — | — | — |
- At least one of email, user_id must be set.
Output
One shape.
result
| Field | Type | Example |
|---|---|---|
code Iterable's response code, 'Success' when the call was accepted. | string | — |
msg The human-readable message Iterable returned. | string | — |
params Any extra detail Iterable attached to the response. | object | — |
{
"code": "",
"msg": "",
"params": {}
}Notes
- Missing fields are merged, never deleted — this endpoint cannot clear a field.
See Update User 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.