Partially updates a Holiday Group (Step 1, Step 2, and/or Step 3 data).

patch

https://example.com/wep/companies/{companyId}/holiday-groups/{groupId}

Access: System, Admin, and ClientAdmin users only.

PATCH behavior is partial: only explicitly sent sections/fields are updated; omitted sections keep current values.
Supported sections: groupInfo (Step 1), holidaySelection (Step 2), holidayPaySetup (Step 3).

For Valid groups, the resulting merged state is re-validated before persistence to prevent
invalid state transitions. For InSetup groups, partial state is allowed.

The isDefault conflict rules differ by group status: Valid groups reject the change with
400 Bad Request, while InSetup groups accept it with a warning in the response.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

companyId

int32

required

Company identifier from route.

groupId

int32

required

Holiday Group identifier from route.

Body Params

PATCH payload; omitted sections remain unchanged.

Partial update request for Holiday Group setup steps.

groupInfo

object

Step 1 partial payload for Holiday Group PATCH.

holidaySelection

array of objects | null

Optional Step 2 payload interpreted as final active selection set.

holidaySelection

holidayPaySetup

object

Holiday Group Step 3 payload for supported pay options.

Headers

api-version

string

required

Defaults to 2.0

The requested API version

x-api-version

string

Defaults to 2.0

The requested API version

content-type

string

enum

Defaults to application/json

Generated from available request content types

Allowed:

Responses

Language

Credentials

Bearer

jwt

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200OK

400Bad Request

401Unauthorized

403Forbidden

404Not Found