Update a division

At a glance

Property	Behavior
Authentication	Required in X-API-Key
Tenant context	Optional narrowing; resource and references must remain in scope
Dry run	Supported with dryRun=true
Request body	application/json; closed schema; maximum documented body 5 MiB
Response	JSON
Primary success	`200`
Side effects	Persists supported division and hierarchy changes; dry run suppresses persistence
Retry guidance	Re-read hierarchy and current division before replay

Operational behavior

Updates a division. If supplied, X-Tenant-ID must match the division’s tenant. With dryRun=true, the API returns the projected division without saving it.

Parent changes must remain in the same tenant and cannot create a cycle.
Use parentId null for root and costCenter null to clear the cost center.

Common errors

Error code	Meaning
`VALIDATION_ERROR`	Schema or business validation failed
`INVALID_REQUEST_ID`	X-Request-ID is not UUID v4 or v7
`INVALID_API_KEY`	Missing, invalid, deleted, or inactive API key
`TENANT_NOT_IN_SCOPE`	Selected tenant is outside API-key scope
`NOT_FOUND`	Resource is absent or not accessible in scope
`NOT_ACCEPTABLE`	Requested response media type is unavailable
`DIVISION_CYCLE`	Parent update would create a hierarchy cycle
`DIVISION_NAME_NOT_UNIQUE_ON_SAME_LEVEL`	Sibling name is already used
`PAYLOAD_TOO_LARGE`	Complete request exceeds the documented limit
`UNSUPPORTED_MEDIA_TYPE`	Request media type is not accepted
`INVALID_REFERENCE`	Referenced resource is missing or unavailable
`RATE_LIMIT_EXCEEDED`	API-key rate limit was exceeded

The operation response list and Error handling page are authoritative for complete handling.

Before implementation

Generate and log a new X-Request-ID for the attempt.
Handle every documented response status.
Do not log X-API-Key or unnecessary personal data.
Reconcile current resource state before replaying an ambiguous write.

Related integration guidance

Review the complete process, state, retry, and operational pattern for this operation.

Authorizations

X-API-Key

string

header

required

JobHandy integration API key. Send the credential in the X-API-Key header. Treat the key as a secret and use it only from trusted server-side environments.

Headers

X-Tenant-ID

string

inactive

optional

not sent by default

Narrows the operation to one tenant in the API key's scope. Any referenced or target resource must be accessible through that tenant. In interactive clients, use the {{tenantId}} variable when a tenant must be selected. Keep the header disabled when tenant selection is not required.

Pattern: ^[0-9a-fA-F]{24}$

X-Request-ID

string<uuid>

inactive

optional

not sent by default

Optional request identifier. If supplied, it must be a UUID v4 or v7 and is returned unchanged in every response. If omitted, the API generates one. Invalid values return 400 INVALID_REQUEST_ID. If your client uses a {{requestId}} variable, refresh it with a new UUID version 4 or 7 for every HTTP request attempt. Keep the header disabled to let the API generate the request identifier.

Pattern: ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[47][0-9a-fA-F]{3}-[89aAbB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$

Path Parameters

string

required

Division ID.

Pattern: ^[0-9a-fA-F]{24}$

Example:

"68920e08eeaea4f2301eecb3"

Query Parameters

dryRun

boolean

inactive

optional

server default: false

not sent by default

When true, the API validates the request without applying the change. The operation's responses specify the returned representation. When omitted, the server uses false.

Example:

true

Body

application/json

The JSON request body must not exceed 5,242,880 bytes.

Fields accepted when updating a division. At least one field is required.

name

string

inactive

optional

not sent by default

New division name. It must be unique among siblings.

Minimum string length: 1

Example:

"Enterprise Sales"

parentId

string | null

inactive

nullable

optional

not sent by default

New parent division ID. Use null to move the division to the root level.

Pattern: ^[0-9a-fA-F]{24}$

Example:

"68920e08eeaea4f2301eecb3"

order

number

inactive

optional

not sent by default

New display order among sibling divisions.

Example:

2

costCenter

string | null

inactive

nullable

optional

not sent by default

Replacement cost center. Use null to clear the existing value.

Example:

null

Response

Returns the updated division, or the projected division when dryRun=true.

Division details.

string

required

read-only

Division ID. A create dry run returns a preview ID that cannot be used in later requests.

Example:

"68920e08eeaea4f2301eecb3"

tenant

string

required

read-only

ID of the tenant that owns the division.

Pattern: ^[0-9a-fA-F]{24}$

Example:

"68a000000000000000000010"

name

string

required

Division name.

Example:

"Sales"

parentId

string | null

required

nullable

Parent division ID, or null for a root division.

Minimum string length: 1

Pattern: ^[0-9a-fA-F]{24}$

Example:

null

order

number

required

Display order among sibling divisions.

Example:

1

costCenter

string | null

required

nullable

Customer-defined cost center, or null when none is assigned.

Minimum string length: 1

Example:

"CC-SALES"

createdAt

string<date-time>

required

read-only

UTC creation timestamp.

Minimum string length: 1

Pattern: Z$

Example:

"2026-01-15T10:30:00.000Z"

updatedAt

string<date-time>

required

read-only

UTC timestamp of the latest update.

Minimum string length: 1

Pattern: Z$

Example:

"2026-07-01T08:15:00.000Z"

Overview

Data Models

Specification

At a glance

Operational behavior

Common errors

Before implementation

Related integration guidance

Authorizations

Headers

Path Parameters

Query Parameters

Body

Response

​At a glance

​Operational behavior

​Common errors

​Before implementation

Related integration guidance

Authorizations

Headers

Path Parameters

Query Parameters

Body

Response

At a glance

Operational behavior

Common errors

Before implementation