v1/shiftplans

post

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

Create a new Shiftplan.

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

≥ 1

ID of a shyftplan account.

idempotency_key

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.

location_id

int32

required

≥ 1

ID of a location.

metadata

string

Shiftplan metadata as json

name

string

required

Name of the shift schedule.

starts_at

date

required

Start date of the shift schedule

ends_at

date

required

End date of the shift schedule

Response

201

Create a new Shiftplan.