v1/special_dates/{id}

put

https://shyftplan.com/api/v1/special_dates/{id}

Update a special date.

Path Params

int32

required

≥ 1

ID of the special date.

Query Params

location_ids[]

array of int32s

List of IDs of locations where the special date is valid. This will be ignored if all_locations is true.

location_ids[]

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

required

≥ 1

ID of a shyftplan account.

name

string

required

Name of the special date.

special_date

date

required

Calendar day of the special day. Must be in the future. Format: YYYY-MM-DD, for example: 2025-10-31.

all_locations

boolean

Defaults to true

Boolean value to determine whether the special date is valid in all locations of the company. If not (false), you can provide a list of IDs of locations where the date is valid using the parameter location_ids.

end_time

date-time

End time of the special date event. This will be ignored, if full_day is true.

full_day

boolean

Defaults to true

Boolean value to determine if the special date occupies a full calendar day.

is_included_in_hour_account

boolean

Defaults to true

Boolean value to determine if the special date should result in bonus time in the shyftplan hour account of employees.

start_time

date-time

Start time of the special date. This will be ignored, if full day is true.

Responses

200Success

401Unauthorized

404SpecialDate not found\nCompany not found

422Invalid request