Skip to main content
POST
Bulk Search Departments by Name

Authorizations

Authorization
string
header
required

Token-based authentication with required prefix "Token"

Body

departments
object[]
required
Required array length: 1 - 10000 elements
upsert
boolean
default:false

If true, create departments that don't exist

Response

200 - application/json
id
integer
required
read-only
parent_name
string
required
read-only
tags
object[]
required
read-only
last_modified_at
string<date-time>
required
read-only
code
string
required
Maximum string length: 250
name
string | null
required
Maximum string length: 250
created_at
string<date-time>
required
read-only
customer
integer
required
read-only
active
boolean
default:true
display_name
string | null
Maximum string length: 600
tag_ids
integer<int64>[]
Required range: -9223372036854776000 <= x <= 9223372036854776000
tag_group_ids
integer<int64>[]
Required range: -9223372036854776000 <= x <= 9223372036854776000
parent
integer | null