Users
A user entity allows you to maintain information about a user.
End Points
Create an user
Retrieve list of users
Update details of an user
Retrieve details of an user
Delete an user
Make an user inactive
Make an user active
Assign a role to user
Attribute
user_id
long
Unique ID for user generated by the server. This is used as identifier.
name
string
Name of the user.
first_name
string
First Name of the User.
last_name
string
Last Name of the User.
email
string
Active Email ID of the user.
email_ids
array
Registered Email Ids of the user.
email
string
Active Email ID of the user.
is_selected
boolean
Whether selected as active. It can either be
true
or false
. status
string
Status of the user. It can either be
active
or inactive
or deleted
or invited
. role_id
long
Unique ID for the role of user.
user_role
string
Role of the user.
user_type
string
Type of the User.
photo_url
string
Url of the profile photo.
default_approver_id
long
ID of the Approver.
default_approver_name
string
Name of the Approver for a user.
default_approver_email
string
Email Id of the Approver for a user.
created_time
string
Time at which this user was created.
last_modified_time
string
Time at which this user's details were last modified.
approves_to_id
long
ID of the User getting approved by.
approves_to_name
string
Name of to user getting approved by.
approves_to_email
string
Email ID of the user getting approved by.
submission_amount_limit
double
Limit of the amount being submitted.
approval_amount_limit
double
Limit of the amount being approved.
employee_number
string
Number of the employee.
department_id
long
Unique ID for the department.
department_name
string
Name of the department.
designation_name
string
Name of the designation.
designation_id
long
Unique ID for the designation generated by server.
date_of_birth
string
Date Of Birth of the User.
date_of_joining
string
Date of Joining of the User.
mobile
long
Mobile Number of the User.
gender
string
Gender of the User.
policy_id
long
Unique ID for the Policy.
policy_name
string
Name of the Policy.
bank_name
string
Name of the bank.
bank_account_type
string
Type of Bank Account.
custom_fields
array
Custom Fields added.
customfield_id
long
Unique ID for the Custom Field.
data_type
string
Data Type of the Custom Field.
is_active
boolean
Whether the Custom Field is Active. It can either be
true
or false
. is_basecurrency_amount
boolean
Whether the Custom Field is Base Currency Amount. It can either be
true
or false
. is_mandatory
boolean
Whether the Custom Field is Mandatory. It can either be
true
or false
. label
string
Label for the Custom Field.
value
string
Value entered in the Custom Field.
user_mail_in_id
string
Mail ID generated by Zoho Expense for the User.
Create an user
Create a new user.
Arguments
name
string
(Required)
Name of the user.
email
string
(Required)
Active Email ID of the user.
user_role
string
(Required)
Role of the user.
default_approver_email
string
Email Id of the Approver for a user.
approves_to_email
string
Email ID of the user getting approved by.
submission_amount_limit
double
Limit of the amount being submitted.
approval_amount_limit
double
Limit of the amount being approved.
employee_number
string
Number of the employee.
department_name
string
Name of the department.
designation_name
string
Name of the designation.
date_of_birth
string
Date Of Birth of the User.
date_of_joining
string
Date of Joining of the User.
mobile
long
Mobile Number of the User.
gender
string
Gender of the User.
policy_name
string
Name of the Policy.
custom_fields
array
Custom Fields added.
customfield_id
long
(Required)
Unique ID for the Custom Field.
value
string
(Required)
Value entered in the Custom Field.
Retrieve list of users
Details of all existing users.
Update details of an user
Update the details of an existing user.
Arguments
name
string
Name of the user.
user_role
string
Role of the user.
approval_amount_limit
double
Limit of the amount being approved.
submission_amount_limit
double
Limit of the amount being submitted.
department_id
long
Unique ID for the department.
department_name
string
Name of the department.
designation_name
string
Name of the designation.
mobile
long
Mobile Number of the User.
custom_fields
array
Custom Fields added.
customfield_id
long
(Required)
Unique ID for the Custom Field.
value
string
(Required)
Value entered in the Custom Field.
Retrieve details of an user
Details of an existing user.
Delete an user
Delete an existing user.
Make an user inactive
Make an user inactive.
Make an user active
Make an user active.
Assign a role to user
Assign a role to user.