Sign in

v1

latestOpenAPI 3.1.02026-07-242735131.1 MB
Departments

Create New Department

Creates a new department in the specified company. Department names may be non-unique and must be non-empty with no more than 255 characters (Unicode code points).

Scopes

CategoryRead only ScopeWrite only Scope (read access implicit)
Manage company resources (company_admin)-Manage departments (company_department:write)
post/v1/company-departments

Request body

company_idstring required

The Company ID. Required in all cases, whether the API credentials have access to multiple companies or just one.

namestring required

The name of the company department. May be non-unique and limited to 255 characters, maximum.

Example request

{
  "company_id": "669f9e18-889f-4c2c-95b8-67795a3113cc",
  "name": "Marketing"
}

Response

Created

Example response

{
  "company_department": {
    "company_id": "669f9e18-889f-4c2c-95b8-67795a3113cc",
    "id": "663e0b79-c893-45ff-a1b2-f6dcabc098b5",
    "name": "Marketing"
  }
}