UpdateUpRaiseUser

Background

This REST API is meant to update users in UpRaise company directory. Below are the API request and responses for creating users.

API Details

App name	Endpoint

App name	Endpoint
UpRaise for Employee Success	https://employee-success.upraise.io/rest/upraise/public/1.0/directory/updateUser
UpRaise People	https://people.upraise.io/rest/upraise/public/1.0/directory/updateUser
UpRaise Employee Garrison	https://garrison.upraise.io/rest/upraise/public/1.0/directory/updateUser

On this page

On this page
1 Background 2 API Details 3 Sample request payload JSON (to update users) 4 Sample request payload JSON (to remove values from user profile attributes) 5 Request parameters 6 Sample response JSON for update user request 7 Response parameters

Sample request payload JSON (to update users)

{
    "accountId":"557058:2b56fd84-c1f6-4f8d-a881-83458b0908fa",
    "manager":{
        "accountId": "612efd530f8ff40068cd8d99"
    },
   "designation":{
      "id":"786"
   },
 "role":{
      "id":1233
   },
    "teams":[
      {
         "id":1419
      },
      {
        "id":1417
      }
   ],
   "leavePolicy": {
                "id":771
            },
   "holidayScheme": {
                "id":896
            },
   "workWeekScheme": {
                "id":497
            },
   "enrollmentDate":"2024-05-12",

    "profileAttributes":[
      {
         "id":6150,
         "userProfileAttrValue":"Block 2A-208, 1st Floor, Z Mall, Eastern Metropolitan Bypass, Kolkata, West Bengal 700078,India"
      },
	  {
         "id":6151,
         "userProfileAttrValue":".net, Jana, C++"
      },
      {
         "id":6158,
         "selectedOptions":[
            6303
         ]
      },
	  {
         "id":6160,
         "selectedOptions":[
            6310, 6308
         ]
      },
	  {
         "id": 6154,
         "userProfileAttrValue": "2022-04-16"
      },
	  {
         "id": 6156,
         "userProfileAttrValue": 35.65
      },
	  {
         "id": 6162,
         "selectedUsers": [
			"557058:47071b1a-8622-4333-aa39-7db293f3aa34"
		 ]
      },
	  {
         "id": 6164,
         "selectedUsers": [
			"557058:abffcb82-281b-422b-ad3a-683362ccd4db", "557058:47071b1a-8622-4333-aa39-7db293f3aa34"
		 ]
      }
   ]
}

Sample request payload JSON (to remove values from user profile attributes)

{
   "accountId":"61d406c3326554006cf69278",
   "designation":{},
   "manager":{},
   "teams":[],
   "profileAttributes":[
      {
         "id":20
      },
	  {
         "id":21
      },
      {
         "id":22
      },
	  {
         "id":23
      },
	  {
         "id": 24
      },
	  {
         "id": 25
      },
	  {
         "id": 26
      },
	  {
         "id": 27
      }
   ],
   "leavePolicy": {},
   "holidayScheme": {},
   "workWeekScheme": {}
}

Request parameters

Parent	Parameter	Type	Description	Possible values

Parent	Parameter	Type	Description	Possible values
	accountId	String	UpRaise user's account ID that needs to be updated	61d406c3326554006cf69278 70d496c6726904116cf69908
	role	Array	This contains the details related to UpRaise role	id
role	id	Number	UpRaise role ID	1232, 8383, etc.
	designation	Array	This contains the details related to designation	id
designation	id	Number	UpRaise designation ID	8978, 5363, etc.
	manager	Array	This contains the details related to user's manager	id
manager	accountId	String	UpRaise user’s manager’s account ID	06b43edc-5a95-45c9-9b7c-a3ff9e43d42d 07b63tyc-7a90-89c1-0v9c-a3hh9e47e42v
	teams	Array	This contains the team details that need to be updated	id
teams	id	Number	Team ID for the team that needs to be updated	1, 2, etc.
	profileAttributes	Array	This array contains all the custom user profile attributes related parameters	id userProfileAttrValue selectedOptions selectedUsers
	id	Number	Profile attribute ID that needs to be updated	89, 1, 5662, etc.
	userProfileAttrValue	String/Number/Date	User this parameter to pass values for attributes below for field types - Text field (Single and multi-line text) Numeric field Date picker field	Any values based on the field types. Eg. if you want to update the address field then pass the field ID and address under ‘userProfileAttrValue’ parameter
	selectedOptions	String/Number/Date	Use this parameter to pass values for attributes below field types - Select list (single and multiple choice options)	Any values based on the field types. Eg. if you want to update the skill attribute then pass the field ID and one or more option values under ‘selectedOptions’ parameter
	selectedUsers	String	Use this parameter to pass values for attributes below field types - UserPicker (single and multi-user picker)	Any values based on the field types. Eg. if you want to update the Direct reports attribute then pass the field ID and user’s account IDs under ‘selectedUsers’ parameter
	leavePolicy	Array	This contains the leave policy ID that needs to be updated for the user	id
leavePolicy	id	Number	Leave policy ID that needs to be updated for the user	1, 2, etc.
	holidayScheme	Array	This contains the holiday scheme ID that needs to be updated for the user	id
holidayScheme	id	Number	Holiday scheme ID that needs to be updated for the user	1, 2, etc.
	workWeekScheme	Array	This contains the workweek scheme ID that needs to be updated for the user	id
workWeekScheme	id	Number	Workweek scheme ID that needs to be updated for the user	1, 2, etc.
	enrollmentDate	Date	Enrolment date of the user. Enroment date can be updated only when you are updating the policy for the first time or changing the policy within 24 hours of the first policy enrolment. Read Change/select enrolment date	Any date in YYYY-MM-DD format

Sample response JSON for update user request

{
    "id": 30934,
    "jiraUserRestApiUrl": "<baseURL>/rest/api/2/user?accountId=557058:2b56fd84-c1f6-4f8d-a881-83458b0908fa",
    "name": "Alan",
    "accountId": "557058:2b56fd84-c1f6-4f8d-a881-83458b0908fa",
    "active": true,
    "timeZone": "Asia/Kolkata",
    "manager": {
        "id": 30933,
        "jiraUserRestApiUrl": "<baseURL>/rest/api/2/user?accountId=612efd530f8ff40068cd8d99"
    },
    "designation": {
        "id": 786,
        "name": "Automation Tester"
    },
    "role": {
        "id": 1233,
        "name": "HR_ADMIN"
    },
    "teams": [
        {
            "id": 1417,
            "name": "Quality Analysis"
        },
        {
            "id": 1419,
            "name": "Product QA"
        }
    ]
}

Response parameters

Parent	Parameter	Type	Description	Possible values

Parent	Parameter	Type	Description	Possible values
	id	String	UpRaise user ID that is being updated	90929, 35353, etc.
	jiraUserRestApiUrl	String	Jira user Rest API URL of the user being updated	<baseURL>/rest/api/2/user?accountId=557058:2b56fd84-c1f6-4f8d-a881-83458b0908fa
	name	String	Name of the user being updated	John Doe, Peter Rees, etc.
	accountId	String	User’s account ID that is being updated	557058:2b56fd84-c1f6-4f8d-a881-83458b0908fa 907058:5b56gd89-c1f8-4f9d-a001-834589088qb
	active	String	UpRaise status of the user	true false
	timezone	String	Timezone of the user	Any given timezone
	manager	Array	This contains the details of the user’s manager	id jiraUserRestApiUrl
manager	id	Number	User ID of the user who is manager of the user being updated	6373, 0101, etc.
manager	jiraUserRestApiUrl	String	Jira user Rest API URL of the manager	<baseURL>/rest/api/2/user?accountId=612efd530f8ff40068cd8d99
	designation	Array	This contains the details related to the designation of the user	id name
designation	id	Number	Designation ID	8383, 464, etc.
designation	name	String	Actual designation of the user that is being updated	Sales manager Software developer
	role	Array	This contains the details of user’s UpRaise role	id name
role	id	Number	UpRaise role ID	672, 5363, etc.
role	name	String	UpRaise user role	User Admin Super admin Any custom UpRaise role
	teams	Array	This contains the details of the updated team/s	id name
teams	id	Number	Team ID	7272, 392, etc.
teams	name	String	Team name	Sales, Customer Success, etc.

In the response, we only provide the updated default parameters and not the custom profile attributes. Response also does not include leave policy related parameters.