v1/shift_presets

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

Body Params
string
required

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

E-mail address of the API user.

string
required

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

Authentication token - can be fetched by login action.

int32
required
≥ 1

ID of a shyftplan account.

int32
required

Break duration in minutes

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

string

Optional MCP-safety idempotency key. When present with API-token auth, repeated calls with the same fingerprint within the TTL window replay the cached response instead of re-creating the shift preset. Ignored for session auth.

string

ShiftPreset metadata as json

string
required

Name for the shift preset (maximum 256 characters)

string

ShortName for ShiftPreset (max 3 characters)

date-time
required

Start date for Shift Preset

date-time
required

End date for Shift Preset

tag_ids
array of objects

List of shift tags that will be added to every shift based on the preset

tag_ids
Responses

Language
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json