Update Worker Profile

Describes the API specifications for updating the details of a worker profile.

Request

URI: https://<SAP Fieldglass envionment URL>/api/vi/worker-profile/<workerRef>

HTTP Method: PATCH

Request Parameters

Parameter	Required	Data Type	Description	Parameter Type
workerRef	yes	String	The unique reference ID of the user.	Path
prefix	No	String	Prefix of profile worker.	Request Body
firstName	No	String	First name of profile worker.	Request Body
lastName	No	String	Last Name of profile worker.	Request Body
email	No	String	Email address of the profile worker.	Request Body
ccEmail	No	String	Copy To email address of the profile worker.	RequestBody
employeeId	No	String	Unique ID of the employee.	Request Body
title	No	String	Title of the employee.	Request Body
address1	No	String	Address of the profile worker.	Request Body
address2	No	String	Address of the profile worker.	Request Body
city	No	String	City associated with the address of the profile worker.	Request Body
stateProvince	No	String	State/province associated with the address of the profile worker.	Request Body
country	No	String	Country associated to the address of the profile worker.	Request Body
postalCode	No	String	Zip/postal code associated to the address of the profile worker.	Request Body
phoneNumber	No	String	Phone number of the profile worker.	Request Body
faxNumber	No	String	Fax number of the profile worker.	Request Body
mobileNumber	No	String	Mobile number of the profile worker.	Request Body
linkedInPublicProfileUrl	No	String	URL to worker's LinkedIn profile.	Request Body
username	No	String	User name of the profile worker.	Request Body
role	No	String	The profile worker's role.	Request Body
Custom Field Name1	No	Dependent on Custom Field configuration	This is the value that is entered for the specific profile worker custom field being updated. If this field is left blank, it will be updated to have a blank value.	Request Body
Custom Field Name2	No	Dependent on Custom Field configuration	This is the value that is entered for the specific profile worker custom field being updated. If this field is left blank, it will be updated to have a blank value.	Request Body

Request Example

Sample Code

API Call

PATCH https://company.com/api/v1/worker-profile/ANTEPW00000008
authorization: Bearer WDXlKj3TTOn3rpg9GHnZpbKmvj1=
x-ApplicationKey: 5c91f4fdb0c6ee9992ff476f89bf6cf25e589350
content-type: application/json

Sample Code

Request Body

{
    "prefix": "Ms.",
    "firstName": "Sabine",
    "lastName": "Bosch",
    "email": "sbosch@acme.com",
    "ccEmail": "h.akiyama@acme.com; cvega@acme.com",
    "employeeId": "C20394964",
    "title": "Senior Engineer",
    "address1": "4138 Pheasant Ridge Road",
    "address2": "Apartment A",
    "city": "Philadelphia",
    "stateProvince": "PA",
    "country": "USA",
    "postalCode": "19131",
    "phoneNumber": "202-555-0015",
    "faxNumber": "202-555-0016",
    "mobileNumber": "202-555-0017",
    "linkedInPublicProfileUrl": "https://linked-in.com/sbosch",
    "username": "sabine_bosch",
    "role": "Profile Worker",
    "profileWorkerCustomFields": {
        "Worker_Reg_Date": "1999-01-28",
        "Worker_Occupation": "Software Engineer",
        "Worker_WorkType_PickList": "For-profit company or organization",
        "Worker_PO_Number": "1234556"
    }
}

Response

Response Status and Error Codes

See Common Status and Error Codes for more information.

Response Example

Successfully Saved!