API Reference

Creates a new Holiday Group in `InSetup` status for the specified company.

post
https://example.com/wep/companies//holiday-groups

Access: System, Admin, and ClientAdmin users only.

Required fields: name, payCodeId, compensationMins.
The payCodeId is validated for company ownership, BaseOn constraint, and TimeOffCategory = Holidays.

If isDefault = true and another Valid default group exists, the group is still created
(it is InSetup) but a warning HG_DEFAULT_VALID_CONFLICT is included in the response.

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

Company identifier from route.

Body Params

Step 1 payload with group info fields.

Create request for Holiday Group.

groupInfo
object

Step 1 payload for Holiday Group creation.

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?