API Reference

Partially updates an existing company holiday event.

patch
https://example.com/wep/companies//calendar-events/

Access: System, Admin, and ClientAdmin users only.

PATCH behavior is partial: only explicitly sent fields are updated; omitted fields keep current values.

Master records cannot be updated through company endpoints.
For inherited client copies, only ApplyTimeOff and Description are editable.

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

Company identifier from route.

int32
required

Holiday event identifier.

Body Params

PATCH payload; omitted fields remain unchanged.

PATCH payload for updating an existing holiday calendar event.

date | null

Holiday start date (inclusive).
Data type is validated and must be Number

date | null

Holiday end date (inclusive).
Data type is validated and must be Number

string | null

Holiday name visible to users.

string | null

Optional holiday note/description.

int32
enum

Holiday type.

Members:

  • 1 - Other ( Other. )
  • 2 - Federal ( Federal holiday (USA). )
  • 3 - State ( State holiday (USA). )
  • 4 - CountryOfficial ( Official country holiday. )

Allowed:
string | null

Two-letter country code (ISO Alpha-2).

string | null

Two-letter US state code.

boolean | null

Whether holiday applies to payroll.

boolean | null

Whether holiday applies to Time Off.

Headers
string
required
Defaults to 2.0

The requested API version

string
Defaults to 2.0

The requested API version

string
enum
Defaults to application/json

Generated from available request content types

Allowed:
Responses

Updated 3 months ago

Did this page help you?
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 3 months ago

Did this page help you?