v1/shift_presets

post

https://shyftplan.com/api/v1/shift_presets

Create a shift preset. Note that shift presets have to be enabled first in the company profile of the shyftplan account.

Query Params

company_id

int32

required

≥ 1

ID of a shyftplan account.

tag_ids[]

array of int32s

Filter an array of Tag ID

tag_ids[]

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.

name

string

required

Name for the shift preset (maximum 256 characters)

short_name

string

ShortName for ShiftPreset (max 3 characters)

starts_at

date-time

required

Start date for Shift Preset

ends_at

date-time

required

End date for Shift Preset

break_time

int32

required

Break duration in minutes

color

string

required

Color (HEX format, e.g. #FF00FF). Default colors are: #cddbfc, #bcc5d0, #ffd5f6, #e0eafc, #b6b7ba, #d8c7fc, #b8d0d9, #ebcefc, #ffdee9, #d4d9eb, #dbd8dc, #cddbb5, #f7dbad, #d3caba, #f8e6d1, #c4e0c8, #e2d6c9, #c2dcda, #f1ccb7, #e1bdbe - one of these is used if an invalid value is submitted

metadata

string

ShiftPreset metadata as json

Responses

Language

Loading…

Response

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

application/json

201Successfully created

400Company not found\n Tag not found\n Evaluation Tag not found

403forbidden

422The request is invalid\n Incorrect tag context\n Invalid company_id\n Incorrect evaluation tag context\n Shift Tags feature is not enabled\n Shift preset cannot exceed more than 24 hours\n end_date cannot be before start_date