v1/availabilities

post

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

Create a new (un-)availability.

Body Params

Schema for the creation of an availability.

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.

available

boolean

required

Defaults to true

Does this availability object mark available or unavailable timeframes?

true: Available.
false: Unvailable.

employment_id

int32

required

≥ 1

ID of the employment.

ends_at

date-time

required

End date-time (ISO 8601) of the availability (rounded to steps of 15 minutes)

override

boolean

required

Defaults to false

Destroy conflicting availabilities? Conflict arises if the timeframe or timeframes (for repeated availabilities) of two availabilities overlap.

repeat

boolean

required

Defaults to false

Is the availability repeated weekly?

starts_at

date-time

required

Start date-time (ISO 8601) of the availability (rounded to steps of 15 minutes)

Response

201Created the new availability.