PIpismo
Holiday calendar

Add holiday

Add a new holiday to an existing holiday calendar.

This endpoint generates a _______ event.

post/v1/holiday-calendar/holiday

Request

  • Base URL
    https://sandbox.pismolabs.io/holidays-core
  • URL
    https://sandbox.pismolabs.io/holidays-core/v1/holiday-calendar/holiday
  • Auth
    HTTP bearer

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.

metadataMetadata

A valid JSON schema as specified in https://json-schema.org/specification.html. Used to register rules used to authorize the transaction.

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
}

Response

OK

created_atstring datetime

Date and time the holiday was created. Format = yyyy-mm-ddTHH:mm:ss.

descriptionstring

Holiday description

external_idstring

Client-created external ID

holiday_calendar_idinteger

Holiday calendar ID

holiday_datestring

Holiday date. Format = yyyy-mm-dd.

holiday_idinteger

Holiday ID

metadataMetadata

A valid JSON schema as specified in https://json-schema.org/specification.html. Used to register rules used to authorize the transaction.

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-04-30T17:24:03",
  "description": "Day to party like it's 1999",
  "external_id": "f89urqljnahosluiefku",
  "holiday_calendar_id": 8675309,
  "holiday_date": "2023-12-01",
  "holiday_id": 8675309,
  "name": "New Year's Day",
  "working_date": "2023-01-02"
}

Changes

No recorded changes to this operation across all 1 revision of this API.