Skip to content

Update Departments

PUT
/org/settings/departments

Replace the department list. Slugs must be unique; an omitted entry is removed.

Authorizations

Parameters

Header Parameters

X-Target-Org-Id
Any of:
string

Request Body required

The department taxonomy. REPLACES the whole list.

object
entries
required
Array<object>
<= 100 items
object
color
Any of:
string
<= 9 characters
description
Any of:
string
<= 500 characters
hidden
boolean
id
string
""
is_system_seed
boolean
name
required
string
>= 1 characters <= 64 characters
slug
required
string
>= 1 characters <= 64 characters
sort_order
integer

Responses

200

Successful Response

object
data
required

An open envelope for a settings object.

Open because an ontology concept and an SSO config both grow fields as the product does, and on a settings read a dropped field reads as “not configured” rather than “we did not tell you”.

object
key
additional properties
any
pagination
Any of:
object
has_next
required

Whether there are more pages

boolean
limit
required

Items per page

integer
next_cursor
Any of:
string
notes
Any of:
Array<string>
page
required

Current page number (1-indexed)

integer
total
required

Total number of items

integer
total_available
Any of:
integer
total_is_lower_bound
Any of:
boolean

422

Validation Error

object
detail
Array<object>
object
loc
required
Array
msg
required
string
type
required
string