Sign in

v1

latestOpenAPI 3.1.0Copyright Pismo2026-07-247702,7523.1 MB
Holiday calendar

Add holiday

Add a new holiday to an existing holiday calendar.

post/v1/holiday-calendar/holiday

Request body

holiday_datestring required

Holiday date. Format = yyyy-mm-dd.

namestring required

Holiday name

descriptionstring

Holiday description

external_idstring

Client-created external ID.

Either this field or holiday_calendar_id is REQUIRED. Pass one or the other but not both.

holiday_calendar_idinteger

Holiday calendar ID.

Either this field or external_id is REQUIRED. Pass one or the other but not both.

metadatastring

Any data object with key/value pairs. No limit on length.

Note: This field must not be used to send Personally Identifiable Information (PII), Payment Card Industry (PCI) data, or any sensitive/regulated information. Metadata fields are intended for operational, non-sensitive data only. For sensitive data, use the specific parameters designed for that purpose. For more information, refer to Get started with Pismo APIs.

Example request

{
  "holiday_date": "2023-12-01",
  "name": "New Year's Day",
  "description": "Day to party like it's 1999",
  "external_id": "f89urqljnahosluiefku",
  "holiday_calendar_id": 8675309,
  "metadata": "{ \"key\": \"value\"}"
}

Response

OK

created_atstring date-time

Datetime program calendar strategy was created. Format = YYYY-MM-DDTHH:MM:SS:MM.

descriptionstring

Holiday description

external_idstring

Customer-provided external ID field for customer monitoring and tracking.

holiday_calendar_idinteger

Holiday calendar ID

holiday_datestring

Holiday date. Format = yyyy-mm-dd.

holiday_idinteger

Holiday ID

metadatastring

Any data object with key/value pairs. No limit on length.

Note: This field must not be used to send Personally Identifiable Information (PII), Payment Card Industry (PCI) data, or any sensitive/regulated information. Metadata fields are intended for operational, non-sensitive data only. For sensitive data, use the specific parameters designed for that purpose. For more information, refer to Get started with Pismo APIs.

namestring

Holiday name

working_datestring date

Next work day following the holiday. Format = yyyy-mm-dd.

Example response

{
  "created_at": "2024-09-12T16:46:16.43663522",
  "description": "Day to party like it's 1999",
  "external_id": "9erqwerncsodignlkd80we4ty",
  "holiday_calendar_id": 8675309,
  "holiday_date": "2023-12-01",
  "holiday_id": 8675309,
  "metadata": "{ \"key\": \"value\"}",
  "name": "New Year's Day",
  "working_date": "2023-01-02"
}