eloomi v3 docs: Update a user by Email

Request

PATCH https://api.eloomi.com/v3/users-email/{email}

Path parameters

Parameter name	Value	Description	Additional
email	string	Email of the required user	Required

Request headers

Parameter name	Value	Description	Additional
ClientId	string	Provided by eloomi	Required
Authorization	string	Look in the documentation for the authentication endpoint on how to construct this	Required

Request body

{
    "access_groups": [
        "integer"
    ],
    "activate": "string",
    "department_code": [
        "string"
    ],
    "department_id": [
        "string"
    ],
    "direct_manager_employee_ids": [
        "string"
    ],
    "direct_manager_ids": [
        "integer"
    ],
    "email": "email",
    "employee_id": "string",
    "end_of_employment_at": "yyyy-mm-dd hh:mm:ss",
    "first_name": "string",
    "generic_role": "string",
    "language_code": "string",
    "last_name": "string",
    "mobile_phone": "string",
    "password": "string",
    "personal_email": "email",
    "phone": "string",
    "profile_ids": [
        "integer"
    ],
    "prompts": {
        "email": "boolean",
        "employee_id": "boolean",
        "legal_consent": "boolean",
        "password": "boolean",
        "phone": "boolean",
        "phone_code": "boolean"
    },
    "start_of_employment_at": "yyyy-mm-dd hh:mm:ss",
    "team_ids": [
        "string"
    ],
    "title": "string",
    "user_permission": "string"
}

Properties

Name	Example	Description	Additional
access_groups[]	[ 1, 2 ]	The IDs of the access groups the user belongs to	Optional
activate	true	How user should be activated `deactivate` - Do not activate the user `standard` - Send user an email with activation link `company_default` - What is specified at the company level `pre_generated_password` - Activate user and send a pregenerated password `instant` Activate user Possible values are: `deactivate` `standard` `company_default` `pre_generated_password` `instant`	Optional
department_code[]	[ "DEP123" ]		Optional
department_id[]	[ 1, 2 ]		Optional
direct_manager_employee_ids[]	[ "E123", "E5431" ]	The employee ids of the direct managers of the user	Optional
direct_manager_ids[]	[ 122, 5 ]	The eloomi id of the direct managers of the user	Optional
email	"support@eloomi.com"	The users email	Optional
employee_id	"E1002"	The users employee id	Optional
end_of_employment_at	"2018-12-25 08:00:00"	When the employee ends employment	Optional
first_name	"Jane"	The users first name	Optional
generic_role	"Accountant"	The users role	Optional
language_code	"da"	The language to be used in eloomi (Defaults to the langauge specified on a company level)	Optional
last_name	"Doe"	The users last name	Optional
mobile_phone	"+4412345678"	The users mobile phone number	Optional
password	"Secret1!"	The users password	Optional
personal_email	"users.name.69@example.org"	The users personal email	Optional
phone	"+4512345678"	The users phone number	Optional
profile_ids[]	[ 1, 2 ]	The id(s) of the users profile(s)	Optional
prompts		User will be prompted to fill out these properties when they login the next time, if a property isn't defined, he is not propmted to fill it out at all, if it's true it's required to be filled out, if it's false then it's optional.	Optional
prompts.email		If set, user will be prompted to fill out their email next time they login. If set to true then it's required to be filled out, otherwise it's optional.	Optional
prompts.employee_id		If set, user will be prompted to fill out their employee_id next time they login. If set to true then it's required to be filled out, otherwise it's optional.	Optional
prompts.legal_consent		If set, user will be prompted to give legal consent next time they login. If set to true then it's required to be given, otherwise it's optional.	Optional
prompts.password		If set, user will be prompted to set a password next time they login. If set to true then it's required to be filled out, otherwise it's optional.	Optional
prompts.phone		If set, user will be prompted to fill out their phone-number next time they login. If set to true then it's required to be filled out, otherwise it's optional.	Optional
prompts.phone_code		If set, user will be prompted to fill out their phone country-code next time they login. If set to true then it's required to be filled out, otherwise it's optional.	Optional
start_of_employment_at	"2017-12-25 08:00:00"	When the employee starts employment	Optional
team_ids[]	[ 1, 2 ]		Optional
title	"Head of Accouting"	The users title	Optional
user_permission	"user"	The users default access (Defaults to user) Possible values are: `user` `company adm`	Optional

Response

The following HTTP status codes may be returned, optionally with a response resource.

Status code	Description	Resource
200	OK User updated	UserSuccess
400	Bad Request Request contained invalid data	GenericSuccess
401	Unauthorized Not allowed	ErrorSuccess