Copy shifts (asynchronous)

post

https://{subdomain}.{region}.deputy.com/api/management/v2/shifts:copy

Copies shifts to new target dates. Supports two patterns: 1) Copy by date range and areas, 2) Copy specific shift IDs. This is an asynchronous API that returns immediately with a job ID in the response data.jobId field. Use the job ID to poll the /management/v2/shifts/copy/job/{jobId} endpoint to check completion status and retrieve results. The operation processes copying in the background.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

startDate

string

Start date of the shifts to copy. Format: YYYY-MM-DD (e.g., "2023-03-11"). Required for pattern 1.

endDate

string

End date of the shifts to copy (inclusive). Format: YYYY-MM-DD (e.g., "2023-03-18"). Required for pattern 1.

areas

array of int32s

Array of area IDs to filter shifts for copying. If empty, all areas are included. Used for pattern 1.

areas

targetDates

array of strings

Target dates to copy shifts to. Format: YYYY-MM-DD. Each date will receive copies of the source shifts.
Mutually exclusive with dayOffsets.

targetDates

viewType

string

enum

Defaults to DAILY

View type that determines which shifts are included in the copy operation.
Required when using targetDates. Not required when using dayOffsets.

shiftIds

array of int32s

Array of specific shift IDs to copy. Used for pattern 2. If provided, startDate, endDate, and areas are ignored.

shiftIds

dayOffsets

array of int32s

Day offsets for copying shifts. Each value is the number of days to offset
from source shift dates. Mutually exclusive with targetDates.
When provided, viewType is not required.

dayOffsets

Response

Language

Credentials

Header

URL

Loading…

Response

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

application/json

200A successful response.