Name

Description

Data Type

Required?

Example

Connected Account

The connected account to use for the request

Connected Account

Yes

User ID

Text (Short)

Yes

Alias

An alias displayed to end users

Text (Short)

No

Custom role ID

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

Number

No

Details

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

Text (Long)

No

Email

The user's primary email address

Email

No

External ID

A unique identifier from another system

Text (Short)

No

Locale

The user's locale

Text (Short)

No

Moderator?

Whether the user has forum moderation capabilities

True/False

No

Name

The user's name

Text (Short)

No

Notes

Any notes you want to store about the user

Text (Long)

No

Only private comments?

Whether the user can only create private comments

True/False

No

Organization ID

The ID of the user's organization. If the user has more than one organization memberships, the ID of the user's default organization

Text (Short)

No

Phone

The user's primary phone number

Text (Short)

No

Report CSV?

Whether or not the user can access the CSV report on the Search tab of the Reporting page in the Support admin interface

True/False

No

Restricted agent?

Whether the agent has any restrictions; false for admins and unrestricted agents, true for other agents

True/False

No

Role

The user's role

Predefined Choice List

No

Signature

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

Text (Short)

No

Suspended?

Whether the agent is suspended. Tickets from suspended users are also suspended, and these users cannot sign in to the end user portal

True/False

No

Tag ID 1

The array of tags applied to this user

Text (Short)

No

Tag ID 2

The array of tags applied to this user

Text (Short)

No

Tag ID 3

The array of tags applied to this user

Text (Short)

No

Ticket restriction

Specifies which tickets the user has access to

Predefined Choice List

No

Timezone

The user's time zone

Text (Short)

No

Field ID 1

Name of the field to sort on

Text (Short)

No

Value 1

Value of the field

Text (Long)

No

Field ID 2

Name of the field to sort on

Text (Short)

No

Value 2

Value of the field

Text (Long)

No

Field ID 3

Name of the field to sort on

Text (Short)

No

Value 3

Value of the field

Text (Long)

No

Verified?

Whether the user's primary identity is verified or not

True/False

No

Name

Description

Data Type

Required?

Example

JSON Output

JSON output returned by the API

Text (Long)

No

Name

Description

Success

This status is selected if the job has successfully completed.

Unsuccessful

This status is selected if the job has completed unsuccessfully.