PUT api/v1/employeepreferences/{employeePreferenceId}

Update a particular employee preference

Request Information

URI Parameters

NameDescriptionTypeAdditional information
employeePreferenceId

globally unique identifier

Required

Body Parameters

EmployeePreferenceModel
NameDescriptionTypeAdditional information
EmployeePreferenceId

globally unique identifier

Required

Value

string

Required

Description

string

String length: inclusive between 0 and 2000

Preserve

boolean

Required

Source

string

String length: inclusive between 0 and 50

CreatedBy

string

String length: inclusive between 0 and 50

DateChangedUtc

date

Required

Request Formats

application/json, text/json

Sample:
{
  "EmployeePreferenceId": "e10c94fb-ac53-4256-9f57-d9e157a65f99",
  "Value": "sample string 2",
  "Description": "sample string 3",
  "Preserve": true,
  "Source": "sample string 5",
  "CreatedBy": "sample string 6",
  "DateChangedUtc": "2026-01-02T21:48:47.230679-06:00"
}

Response Information

Resource Description

ApiResponseModelOfEmployeePreferenceModel
NameDescriptionTypeAdditional information
Data

ApiResponseDataModelOfEmployeePreferenceModel

None.

Errors

Collection of string

None.

Warnings

Collection of string

None.

Response Formats

application/json, text/json

Sample:
{
  "Data": {
    "PageSize": 1,
    "Page": 2,
    "TotalPages": 3,
    "TotalResults": 4,
    "Results": {
      "EmployeePreferenceId": "4735a0af-c138-4ff4-ad84-2deb5080947f",
      "Value": "sample string 2",
      "Description": "sample string 3",
      "Preserve": true,
      "Source": "sample string 5",
      "CreatedBy": "sample string 6",
      "DateChangedUtc": "2026-01-02T21:48:47.230679-06:00"
    }
  },
  "Errors": [
    "sample string 1",
    "sample string 2"
  ],
  "Warnings": [
    "sample string 1",
    "sample string 2"
  ]
}