Create User
zammad.create_user
ActionBusiness appsconnection required
Calls the Zammad API with the connection's credentials.
Create a customer or an agent account.
Connection
- Required
- Yes — the node will not save without one
- Auth type
- API key
- Providers
- Zammad
- Secret shape
- the API token, or {"api_token": "…"}
- Config it needs
- base_url
- Resolved by
- config.connection_id, else node.connection_id
Configuration
7 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 user's email address, which Zammad also uses as the login when no separate login is given. | string | No | — | email format | david@example.com |
login A login for the account, when it should differ from the email address. | string | No | — | — | david |
firstname The user's first name. | string | No | — | — | David |
lastname The user's last name. | string | No | — | — | Bell |
organization The organization the user belongs to, by name or by id. | string | No | — | — | Acme Ltd |
roles Role names to grant, such as Agent or Customer; Zammad gives a new account the Customer role when this is left empty. | array | No | — | array of string | ["Customer"] |
fields Any further user attributes, including this install's custom object attributes, as a JSON object such as {"note": "Imported from the old desk"}. | object | No | — | — | — |
- At least one of email, login must be set.
Example configuration
Every value below is the contract’s own example or default — nothing invented.
{
"email": "david@example.com",
"firstname": "David",
"lastname": "Bell",
"login": "david",
"organization": "Acme Ltd",
"roles": [
"Customer"
]
}Output
One shape.
result
| Field | Type | Example |
|---|---|---|
id The user's numeric id. | number | — |
login The user's login. | string | — |
email The user's email address. | string | — |
firstname The user's first name. | string | — |
lastname The user's last name. | string | — |
organization_id Id of the organization the user belongs to. | number | — |
role_ids Ids of the roles the user holds. | array | — |
active True while the account is active. | boolean | — |
created_at When the account was created, as an ISO 8601 stamp. | string | — |
{
"active": false,
"created_at": "",
"email": "",
"firstname": "",
"id": 0,
"lastname": "",
"login": "",
"organization_id": 0,
"role_ids": []
}Notes
- An 'email' or a 'login' is required; the node refuses the call before it is made when both are missing.
See Create User run in a workflow.
In a technical demo we add the Zammad connection, drop the node on the canvas and let Workflow Health pre-flight it before the first real run.