Update User

PUT/api/v2/users/{user_id}

Use it in a workflow

Add a step and choose the Zendesk connector.
Pick the Update User action (under Users).
Fill in the fields below, then reference the result from later steps as {{updateUser.response.data}}.

Request

Path parameters

user_idinteger (int64)required

The id of the user

Request body

Enter the body as JSON in the step's Body field.

userobjectrequired

Input schema for updating a user. All fields are optional - only include the fields you want to update.

agent_brand_idsarray<integer (int64)>

The IDs of the brands the agent is assigned to

aliasstring

An alias displayed to end users

custom_role_idinteger (int64)

A custom role if the user is an agent on the Enterprise plan or above

default_group_idinteger (int64)

The id of the user's default group

detailsstring

Any details you want to store about the user, such as an address

emailstring

The user's primary email address

external_idstring

A unique identifier from another system

group_idinteger (int64)

The id of the user's default group. Alias for default_group_id

identitiesarray<object>5 fields

languagestring

The user's language preference. Alias for locale.

localestring

The user's locale. A BCP-47 compliant tag for the locale. If both "locale" and "locale_id" are present on create or update, "locale_id" is ignored and only "locale" is used.

locale_idinteger (int64)

The user's language identifier

moderatorboolean

Designates whether the user has forum moderation capabilities

namestring

The user's name

notesstring

Any notes you want to store about the user

only_private_commentsboolean

true if the user can only create private comments

organization_idinteger (int64)

The id of the user's organization

organization_idsarray<integer (int64)>

The ids of the user's organizations

phonestring

The user's primary phone number

photoobject

The user's profile picture

remote_photo_urlstring

A URL pointing to the user's profile picture

rolestring

The user's role

shared_phone_numberboolean

Whether the phone number is shared or not

signaturestring

The user's signature. Only agents and admins can have signatures

skip_verify_emailboolean

If true, the user won't receive a verification email

suspendedboolean

If the user is suspended

tagsarray<string>

The user's tags

ticket_restrictionstring

Specifies which tickets the user has access to

time_zonestring

The user's time zone

user_fieldsobject

Values of custom fields in the user's profile

verifiedboolean

Any of the user's identities is verified

json

{
  "user": {
    "agent_brand_ids": [
      0
    ],
    "alias": "string",
    "custom_role_id": 0,
    "default_group_id": 0,
    "details": "string",
    "email": "string",
    "external_id": "string",
    "group_id": 0,
    "identities": [
      {
        "type": "email",
        "value": "string",
        "primary": false,
        "verification_method": "none",
        "verified": false
      }
    ],
    "language": "string",
    "locale": "string",
    "locale_id": 0
  }
}

Response

Returns 200 with an object. Read it in later steps with {{updateUser.response.data.<field>}}.

useroneOf

json

{
  "user": null
}

Need more? See the Zendesk guide for connection setup and behaviour shared by every action.

Was this page helpful?