v1/shiftplans/{id}/copy

post

https://shyftplan.com/api/v1/shiftplans/{id}/copy

Copy a Shiftplan

Path Params

int32

required

Body Params

user_email

string

required

This is a testing sandbox. We advise against using credentials for production accounts here.

E-mail address of the API user.

authentication_token

string

required

This is a testing sandbox. We advise against using credentials for production accounts here.

Authentication token - can be fetched by login action.

company_id

int32

required

≥ 1

ID of a shyftplan account.

copy_employees

boolean

required

Defaults to true

Copy Shiftplan with Employees

copy_full_shiftplan

boolean

required

Defaults to true

Copy full Shiftplan

ends_at

date

required

End of the Shiftplan

name

string

required

Name of the Shiftplan

starts_at

date

required

Start of the Shiftplan

without_conflicts

boolean

required

Defaults to false

Only copies assignments that wouldn't trigger a warning

copy_timeframe_ends_at

date

Copy timeframe end at

copy_timeframe_starts_at

date

Copy timeframe start at

is_exclude_special_days_enabled

boolean

Defaults to false

Should special days in the time-frame of the destination plan be left empty

is_include_end_on_special_days_enabled

boolean

Defaults to false

Can the destination plan end on a special date?

is_include_start_on_special_days_enabled

boolean

Defaults to false

Can the destination plan start on a special date?

position_ids

array of int32s

Positions IDs

position_ids

Responses

Language

Loading…

Response

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

application/json

201Automation was successfully started

401Unauthorized

403Forbidden

404Company not found\nShiftplan not found

422Invalid request