Update WorkerPayGroup

put

https://api.sandbox.salsa.dev/api/rest/v1/employers/{employerId}/worker-pay-groups/{workerPayGroupId}

Updates an existing WorkerPayGroup with the specified Id.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

employerId

string

required

Employer Id to update the WorkerPayGroup for

workerPayGroupId

string

required

WorkerPayGroup Id to update

Body Params

WorkerPayGroup update details

Input for updating an existing WorkerPayGroup.

ignoreWorkerIds

boolean | null

deprecated

Allow updating pay group without affecting associated workers.

isDefaultWorkerPayGroup

boolean | null

Defines whether this is the default pay group for this employer. All new workers will be attached to the default pay group.

name

string | null

Display name to help identify this pay group. Omit to leave unchanged.

paySchedule

workWeek

workerIds

array of strings | null

This list of workers attached to this pay group. Omit (or pass null) to leave workers unchanged; pass an empty list to remove all workers.

workerIds

Responses

500

Internal Server Error

200OK