Create or update user
BetaChanges data
Creates a Zendesk user, or updates the one that matches.
Settings
| Setting | What it is |
|---|---|
| ConnectionRequired | The Zendesk connection the step signs in with. |
| NameRequired | Zendesk accepts at most five changes a minute for one person, so a loop over many people needs to go slowly. |
| E-mail address | What Zendesk matches on when there is no external id. Without either of the two, every run creates another person. |
| Your own id | Matched before the e-mail address — the safest way to keep one person one. |
| Role | "" or "end-user" or "agent" or "admin" |
| Organization id | The List organizations node gives you the id. |
| Phone number | text |
| Tags | Comma-separated. |
| Custom fields | A user field is keyed by its KEY here, not by a number — the opposite of a ticket field. You find the key in Zendesk under Admin Center → People → Fields. |
| Notes | Only agents see this. |
| Details | text |
| Time zone | text |
| Language | text |
| Treat the e-mail address as verified | On, Zendesk does not send this person a confirmation mail. |
Technical details
| Key | Value |
|---|---|
connection | texta connection id from `requires.connections` (provider `zendesk`) |
name | text |
email | text |
externalId | text |
role | "" or "end-user" or "agent" or "admin" |
organizationId | text |
phone | text |
tags | text |
userFields | object of text, by default {} |
notes | text |
details | text |
timeZone | text |
locale | text |
verified | true/false, by default false |
Output
| Field | Type |
|---|---|
userId | string |
user | object |
createdWhether this run created the person | boolean |
Sample output, and the expression for each field
- createdtrue
- user
- id7
- name"Ann Jansen"
- userId"7"
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>",
"details": "",
"email": "",
"externalId": "",
"locale": "",
"name": "<name>",
"notes": "",
"organizationId": "",
"phone": "",
"role": "",
"tags": "",
"timeZone": "",
"userFields": {},
"verified": false
},
"label": "Create or update user",
"type": "zendesk.createOrUpdateUser",
"version": 1
}