v2/availabilities

post

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

Create a new availability

Body Params

Create a new 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

required

≥ 1

ID of a shyftplan account.

starts_at

date-time

required

Date-time (ISO 8601) for the begin of the object's span.

ends_at

date-time

required

Date-time (ISO 8601) for the end of the object's span.

override

boolean

required

Defaults to false

Destroy conflicting availabilities

available

boolean

required

Defaults to true

Is the Employee available (true) or unavailable (false)?

employment_id

int32

required

≥ 1

ID of the employment.

repeat

boolean

required

Defaults to false

Is the availability repeated weekly?

Responses

201Success

400Bad request

401Unauthorized

403Forbidden

404Entity/company not found.

422Invalid request.