POST /api/public/user/bulk/
Create or update user objects.
Servers
- https://my.15five.com/
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 |
|---|---|---|---|
[] |
Array | Yes | |
[].time_zone |
String | No |
Timezone for the employee. |
[].job_description |
String | No |
The employee’s job description. |
[].termination_date |
String | No |
The date of the employee's termination, if applicable Note: Unlike other attributes, termination_date will apply for users which are deactivated. |
[].update_group_membership_by_group_type |
Object | No |
Specify group memberships per group type using an object keyed by the group type id. For example:
Note: For each group type specified, you must include every group to which the employee should belong. Employees will be removed from any group not included in the groups array for a specified group type. If a key is not specified for an existing group type, that group type will not be affected by the import. This property cannot be used with the |
[].strengths |
String | No |
Employee’s strengths as determined by Gallup Strength Finder, VIA personality test, Big Five, Meyers-Briggs, or other methods. |
[].send_welcome_from_user_id |
String | No |
Email address of the person from 15Five. |
[].location |
String | No |
Primary employee work location. |
[].custom_[field name] |
String | No |
Custom attributes are used to bring in employee data that currently does not exist within 15Five using text and date-based fields like "Department" or "Birthday". |
[].first_name |
String | No |
The first name for the employee. |
[].reviewer_id |
Integer | No |
Email address of the person that will review the employee’s Check-in. This establishes the manager/employee (reviewer/reporter) relationship in 15Five. |
[].is_active |
Boolean | No |
Flag indicating if this employee is active or inactive. |
[].is_group_admin_for[] |
Array | No |
Use this field to update group admins in bulk (group ids to be specified). |
[].group_ids[] |
Array | No |
Ids for groups that the employee is active in. This property cannot be used with the |
[].phone_number |
String | No |
The phone number for the employee. This field only supports United States phone numbers. The value must start with the US area code followed by 10 digits: 1##########. |
[].id |
Integer | No |
User primary key specified by 15Five. If provided, it will be used as the unique identifier regardless of the company's setting for "Employee identifier". |
[].email |
String | Yes |
The email address for the employee. |
[].last_name |
String | No |
The last name for the employee. |
[].due_day |
Integer | No |
The day of the week that the employee’s Check-in is due. |
[].start_date_ts |
String | No |
The date a new employee will be invited to and have access to 15Five. |
[].title |
String | No |
Employee's title |
[].employee_id |
String | No |
This field is required if "Employee ID" is selected as the company's "Employee identifier". Go to Company settings > Import settings to view and configure the "Employee identifier" setting. |
[].hire_date |
String | No |
The date the employee started working at the company. |
How to start integrating
- Add HTTP Task to your workflow definition.
- 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.
- Click Test request to test run your request to the API and see the API's response.