v1/availabilities/{availability_id}

put

https://shyftplan.com/api/v1/availabilities/{availability_id}

Update an existing availability.

Path Params

availability_id

int32

required

≥ 1

ID of the availability.

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.

available

boolean

required

Defaults to true

Does this availability object mark available or unavailable timeframes?

ends_at

date-time

required

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

override

boolean

required

Destroy conflicting availabilities

starts_at

date-time

required

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

update_all

boolean

required

Set to true to update all records of a repeating event.

Response

200Update an existing Availability