Sign in

v1

latestOpenAPI 3.1.0Copyright Pismo2026-07-247702,7523.1 MB
Administrative divisions (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.

Administrative divisions are used to divide an organization's territory into separate areas. An organization covering Great Britian for example, might want to have separate divisions for England, Scotland, and Ireland. Each of these countries may have different holidays and need to be administered in different ways.

There is a Create administrative division V2 endpoint designed for greater flexibility in defining non-business days to accommodate specific business requirements. For details about the differences, refer to Platform setup - Holidays and administrative divisions.

post/divisions-core/v1/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-]+$.

external_id_referencestring

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

Example request

{
  "name": "Scotland",
  "type": "State",
  "external_id": "8675309",
  "external_id_reference": "CRM-software-ID"
}

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

Example response

{
  "id": 84849,
  "external_id": "8675309",
  "name": "Scotland",
  "type": "State"
}