Sign in

v1

latestOpenAPI 3.1.0Copyright Pismo2026-07-247702,7523.1 MB
Administrative divisions V2 (deprecated)

Create administrative division (deprecated)

DEPRECATED. Call Create holiday calendar instead.

This endpoint is deprecated starting April 30, 2026, and final removal from both test (EXT) and production environments on October 30, 2026.

Create an administrative division.

This is a v2 endpoint that offers more granular control over financial activities on non-business days. To understand the differences between v1 and v2 endpoints, refer to Platform setup - Holidays and administrative divisions.

post/divisions-core/v2/administrative-division

Request body

namestring required

Administrative division name

type'City' | 'State' | 'Country' required

Admin division type

parent_idinteger

Parent ID

external_idstring

Client-supplied external ID. It must comply with the rule ^[a-zA-Z0-9-]+$.

parent_external_idstring

Parent external ID. Must comply with the rule ^[a-zA-Z0-9-]+$.

working_daysinteger[]

Week days that are working days where 0 = Sunday and 6 = Saturday. The default - [1,2,3,4,5] - corresponds to Monday through Friday.

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

{
  "name": "Scotland",
  "type": "State",
  "external_id": "8675309",
  "parent_external_id": "8675309",
  "working_days": [
    1,
    2,
    3,
    4,
    5
  ],
  "metadata": "{ \"key\": \"value\"}"
}

Response

Created

idinteger

Admininistrative division ID

external_idstring

Client-supplied external ID. It must comply with the rule ^[a-zA-Z0-9-]+$.

namestring

Administrative division name

parent_idinteger

Parent ID

type'City' | 'State' | 'Country'

Admin division type

working_daysinteger[]

Week days that are working days where 0 = Sunday and 6 = Saturday. The default - [1,2,3,4,5] - corresponds to Monday through Friday.

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 response

{
  "id": 84849,
  "external_id": "8675309",
  "name": "Scotland",
  "type": "State",
  "working_days": [
    1,
    2,
    3,
    4,
    5
  ],
  "metadata": "{ \"key\": \"value\"}"
}