What's the purpose of this endpoint?
Create a new user or update existing user.
How it works
By default, we create a new member under the root team admin, unless you specify a manager_email property, in which case we add the user to that subteam.
When the user is created, we send an email to that user with their credentials and instructions on how to download the app. Welcome emails won't be sent when using sandbox
If a user already exists, then we update the member. You can update a user's attributes and also move them to a different subteam by passing the manager_email attribute.
We need the user email or token_id parameter to be sent. If no user is found the API will return a 404 error.
Params
All of these parameters are described in the member model. For more information, please read that table first.
| Parameter | Type | Required | Notes |
|---|---|---|---|
| string | yes | Must be unique, otherwise the API will return a 422 error | |
| first_name | string | no | |
| last_name | string | no | |
| phone | string | no | |
| employee_number | string | no | |
| role | string | no | Possible values are the same as decribed in the model of members. Default is member. If admin or manager is sent, we create a new subteam for that user. |
| start_date | string | no | Format: yyyy-mm-dd |
| end_date | string | no | Format: yyyy-mm-dd |
| leave_start_date | string | no | Format: yyyy-mm-dd |
| leave_end_date | string | no | Format: yyyy-mm-dd |
| leave_reason | string | no | |
| manager_email | string | no | Email of the manager who the user reports to. Its important to know this manager must already exist on your team and must already have a role of manager or admin. If these two requirements are not true, the endpoint will return a 422 error |
| program_name | string | no | Specify the program name the employee should be assigned to. If you want to remove the employee from their program send no_program |
| metadata | array of objects | no | Array of metadata objects that can be assigned to the employee. See table below. |
Metadata object
| Parameter | Type | Required | Notes |
|---|---|---|---|
| name | String | Yes | Name of the metadatum |
| value | String | Yes | Value for the metadatum. If the value is null, the metadatum will be archived in Everlance |
What's next?
When the user is created, we send an email to that user with their credentials and instructions on how to download the app.
Please save the user token_id so you can then make additional API calls to get and update the user.