PIpismo
Holiday calendar

Update holiday calendar

Update a holiday calendar. Fields not passed are not updated.

patch/v1/holiday-calendar/{holiday_calendar_id}

Request

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

Path parameters

holiday_calendar_idstring required
Example:8675309

Holiday calendar ID

Request body

typestring

Holiday calendar type

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
external_idstring

Client-created external 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_daysinteger[]

Working days array

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

Example request

{
  "type": "Country",
  "parent_id": 8675309,
  "external_id": "f89urqljnahosluiefku",
  "name": "New Year's Day",
  "working_days": [
    1,
    2,
    3,
    4,
    5
  ]
}

Response

No Content

Changes

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