PUT /api/public/user/{id}/

Update user object.

Servers

Path parameters

Name Type Required Description
id Integer Yes

Request headers

Name Type Required Description
Content-Type String Yes The media type of the request body.

Default value: "application/json"

Request body fields

Name Type Required Description
location String No

User's location

first_name String No

User's first name

reviewer_id Integer No

(0, null) will remove reviewer from user

is_active Boolean No

Designates whether the user can use this account

reporting_period String No

User's reporting period

biweekly_due_day Integer No

User's biweekly due day

email String No

User's email

last_name String No

User's last name

due_day Integer No

User's weekly due day

monthly_due_day Integer No

User's monthly due day

monthly_due_day_which_in_month String No

User's due day in month

phone String No

User's phone number

This field only supports United States phone numbers. The value must start with the US area code followed by 10 digits: 1##########.

biweekly_due_day_which_week String No

User's biweekly week

start_date_ts String No

User's start date in timestamp

title String No

User's title

skip_company_wide_questions Boolean No

Opt this person out of company-wide questions

hire_date_ts String No

User's hire date in timestamp

employee_id String No

User's employee ID

company_groups_ids[] Array No

Array of ids of company groups the user is a member of. Empty array will remove user from all groups.

How to start integrating

  1. Add HTTP Task to your workflow definition.
  2. Search for the API you want to integrate with and click on the name.
    • This loads the API reference documentation and prepares the Http request settings.
  3. Click Test request to test run your request to the API and see the API's response.