Update Worker Preferences

Describes the API specifications for updating a profile worker's preferences.

Request

URI: https://<SAP Fieldglass envionment URL>/api/vi/worker-preferences/<username>

HTTP Method: PATCH

Request Parameters

Parameter

Required

Data Type

Description

Parameter Type

username

Yes

String

The unique name of the user.

Path

timeZone

No

String

The profile worker's time zone.

Request Body

dateFormat

No

String

The preferred date format.

Request Body

timeFormat

No

String

The preferred time format.

Request Body

numberFormat

No

String

The preferred number format.

Request Body

language

No

String

The profile worker's preferred language.

Request Body

emailFormat

No

String

The preferred format for email messages.

Request Body

emailMessage

No

String

The preferred type of email messages received.

Request Body

systemMessage

No

String

The preferred type of system messages received.

Request Body

Request Example

Response

Response Status and Error Codes

See Common Status and Error Codes for more information.

Response Example

Successfully Saved!