API Reference

Updates an existing custom termination reason.

patch
https://example.com/wep/custom-termination-reasons/

Access: System, Admin, and ClientAdmin users only.

This endpoint applies JSON Merge Patch semantics. Properties omitted from the request body keep their current stored values. If type is included with null, the stored category becomes Worklio.ApiModels.API.Enums.General.TerminationType_v10.NotSpecified. If note is included with null, the stored note is cleared to a blank value.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
int32
required

Custom termination reason identifier from the route.

Body Params

Patch payload containing the fields to update.

JSON Merge Patch payload used to update an existing custom termination reason.

string | null

Updated display name for the custom termination reason. Omit this property from the PATCH payload to keep the current value. Maximum length: 50 characters.

int32
enum

Identifies how a custom termination reason categorizes a separation. Serialized in the API contract as numeric byte values.

Members:

  • 0 - NotSpecified ( No termination category is assigned to the reason. )
  • 1 - Involuntary ( Employer-initiated separation. )
  • 2 - Voluntary ( Employee-initiated separation. )

Allowed:
string | null

Updated free-form note. Omit this property to keep the current value; include it with null to clear the stored note to a blank value. Maximum length: 500 characters.

Headers
string
required
Defaults to 2.0

The requested API version

string
Defaults to 2.0

The requested API version

Responses

Updated about 1 month ago

Language
Credentials
Bearer
jwt
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated about 1 month ago