FlowmageDocs

Create or update user

BetaChanges data

Creates a Zendesk user, or updates the one that matches.

Settings

SettingWhat it is
ConnectionRequiredThe Zendesk connection the step signs in with.
NameRequiredZendesk accepts at most five changes a minute for one person, so a loop over many people needs to go slowly.
E-mail addressWhat Zendesk matches on when there is no external id. Without either of the two, every run creates another person.
Your own idMatched before the e-mail address — the safest way to keep one person one.
Role"" or "end-user" or "agent" or "admin"
Organization idThe List organizations node gives you the id.
Phone numbertext
TagsComma-separated.
Custom fieldsA 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.
NotesOnly agents see this.
Detailstext
Time zonetext
Languagetext
Treat the e-mail address as verifiedOn, Zendesk does not send this person a confirmation mail.
Technical details
KeyValue
connectiontexta connection id from `requires.connections` (provider `zendesk`)
nametext
emailtext
externalIdtext
role"" or "end-user" or "agent" or "admin"
organizationIdtext
phonetext
tagstext
userFieldsobject of text, by default {}
notestext
detailstext
timeZonetext
localetext
verifiedtrue/false, by default false

Output

FieldType
userIdstring
userobject
createdWhether this run created the personboolean
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
}