Update division

patch

https://sandbox.pismolabs.io/corporate/v2/divisions/{divisionCode}

Updates a division. Only provided fields are updated. Other fields are left unchanged.

This endpoint generates a Corporate division updated event.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

divisionCode

string

required

length ≤ 36

Division code registered in the Create division endpoint.

Body Params

Patch division request body

division_code

string

length ≤ 36

Code used to identify your division within the organization. Division code should only contain letters, numbers, and hyphens.

hierarchy_id

uuid

length ≤ 36

Hierarchy ID generated by the Create hierarchy endpoint.

level_id

uuid

≤ 36

Level ID generated by the Create hierarchy endpoint.

administrative_division_id

int64

Administrative division ID. Specifying an administrative division ID in this field links your division to it. This is useful when you want to use the holidays defined in that administrative division.

name

string

≤ 40

Division name

parent_code

string

Division code that can be set as the parent of the division being created. The parent must be at a level with a lower index than the division being created. It must comply with the rule ^[a-zA-Z0-9-]+$.

description

string | null

Division description

timezone

string

Division timezone in timezone database format.
This value is used in the calculations for holidays, weekends, and daily balances. If a timezone is not specified, the division inherits the timezone from its parent division. If the parent division also lacks a specified timezone, Pismo defaults to using UTC. To clear this field, specify an empty string.

program_ids

array of int32s

≤ 100

List of allowed program IDs. The programs must belong to the organization. This list is used for validation during the Create transaction banking account process. You can retrieve the organization programs using the List programs endpoint. If no program IDs are specified, this division inherits the program_ids list from the parent division, if it exists.

program_ids

schema

object

Valid JSON schema as specified in https://json-schema.org/specification.html. Used to validate the JSON of custom fields in the Create transaction banking account process. If this field is not set, the division inherits its schema from the parent division, if it exists.

Responses

204

No Content

401

Access token is missing or invalid

403

The request has been lost

Update division

Changelog

Support

Pismo is here to help

400Bad Request

404Not Found

500Internal Server Error