Sign in

v1

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

Create holiday calendar

Creates a new holiday calendar with associated holidays.

This endpoint does not generate an event.

post/v1/holiday-calendar

Request body

namestring required

Holiday calendar name. Must be unique per organization.

typestring required

Type, free-form field. For example, Country or Region.

external_idstring

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

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.

parent_external_idstring

Client-created external ID for parent calendar. Refer to parent_id parameter for more information.

parent_idinteger

Calendar parent ID.

Holiday calendars can have parent-child relationships, creating a hierarchy. Child calendars inherit holidays from their parent calendars.

Common use case: Country → State → City hierarchy

Example:

  • Brazil (parent)
    • São Paulo (child of Brazil)
      • Campinas (child of São Paulo)

When you query holidays for Campinas, you automatically get:

  • Campinas city holidays
  • São Paulo state holidays
  • Brazil national holidays

You can reference the parent calendar using either:

  • parent_id: The internal parent calendar ID
  • parent_external_id: The parent calendar external_id
working_daysinteger[]

Working days array

1 = Monday, 6 = Saturday. Default = [1, 2, 3, 4, 5].

Example request

{
  "name": "Brazil holiday calendar",
  "type": "Country",
  "external_id": "9erqwerncsodignlkd80we4ty",
  "holidays": [
    {
      "name": "New Year's Day",
      "holiday_date": "2023-12-01",
      "description": "Day to party like it's 1999",
      "metadata": "{ \"key\": \"value\"}"
    }
  ],
  "metadata": "{ \"key\": \"value\"}",
  "parent_external_id": "f89urqljnahosluiefku",
  "parent_id": 8675309,
  "working_days": [
    1,
    2,
    3,
    4,
    5,
    6
  ]
}

Response

Created

external_idstring

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

holiday_calendar_idinteger

Holiday calendar 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

parent_external_idstring

Client-created external ID for parent calendar. Refer to parent_id parameter for more information.

parent_idinteger

Calendar parent ID.

Holiday calendars can have parent-child relationships, creating a hierarchy. Child calendars inherit holidays from their parent calendars.

Common use case: Country → State → City hierarchy

Example:

  • Brazil (parent)
    • São Paulo (child of Brazil)
      • Campinas (child of São Paulo)

When you query holidays for Campinas, you automatically get:

  • Campinas city holidays
  • São Paulo state holidays
  • Brazil national holidays

You can reference the parent calendar using either:

  • parent_id: The internal parent calendar ID
  • parent_external_id: The parent calendar external_id
typestring

Type, free-form field. For example, Country or Region.

working_daysinteger[]

Working days array

1 = Monday, 6 = Saturday. Default = [1, 2, 3, 4, 5].

Example response

{
  "external_id": "9erqwerncsodignlkd80we4ty",
  "holiday_calendar_id": 8675309,
  "holidays": [
    {
      "description": "Day to party like it's 1999",
      "holiday_date": "2023-12-01",
      "holiday_id": 8675309,
      "metadata": "{ \"key\": \"value\"}",
      "name": "New Year's Day",
      "working_date": "2023-01-02"
    }
  ],
  "metadata": "{ \"key\": \"value\"}",
  "name": "New Year's Day",
  "parent_external_id": "f89urqljnahosluiefku",
  "parent_id": 8675309,
  "type": "Country",
  "working_days": [
    1,
    2,
    3,
    4,
    5,
    6
  ]
}