Name

Description

Data Type

Required?

Example

Connected Account

The connected account to use for the request

Connected Account

Yes

Short description

Short description of the user

Text (Long)

Yes

Active?

Whether to activate the user

True/False

No

Building

The Building address

Text (Short)

No

City

City of the user

Text (Short)

No

Company

The name of the company for the user

Text (Short)

No

Country

Country of the user

Text (Short)

No

Department

Department of the user

Text (Short)

No

Email

The email address associated with the user

Email

No

First name

The first name of the user

Text (Short)

No

Gender

The gender of the user

Text (Short)

No

Home phone

Home phone of the user

Text (Short)

No

Last name

The last name of the user

Text (Short)

No

Location

Location of the user

Text (Short)

No

Manager

Manager of the user

Text (Short)

No

Middle name

The middle name of the user

Text (Short)

No

Mobile phone

Mobile phone number of the user

Text (Short)

No

Password

The user's password

Text (Short)

No

Password needs reset?

Whether to require a password reset when the user logs in

True/False

No

Phone

The main phone number of the user

Text (Short)

No

Role ID 1

Roles of the user

Text (Short)

No

Role ID 2

Roles of the user

Text (Short)

No

Role ID 3

Roles of the user

Text (Short)

No

Source

Text (Short)

No

State

State for the user

Text (Short)

No

Street

Street information for the user separated by comma

Text (Short)

No

Username

A username associated with the user (e.g. user_name.123)

Text (Short)

No

Zip code

Zip code for the user

Text (Short)

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.