API Reference

Creates a custom termination reason.

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

Access: System, Admin, and ClientAdmin users only.

If type is omitted or sent as null, the reason is stored with the Worklio.ApiModels.API.Enums.General.TerminationType_v10.NotSpecified category. If note is omitted or sent as null, the API stores a blank note.

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

Payload describing the custom termination reason to create.

Request payload used to create a custom termination reason.

string | null
required

Required display name for the custom termination reason. 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

Optional free-form note for the custom termination reason. Maximum length: 500 characters. When omitted or null, the API stores a blank note.

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