Sign in

v1

latestOpenAPI 3.1.02026-07-24181585937.4 KB
Department & Team

department.create

Creates a department.

Requires the organizationWrite permission.

post/department.create

Request body

namestring required

The name of the department or team

externalNamestring nullable

An alternate candidate-facing name for this department that will be used on Ashby job boards

parentIdstring uuid nullable

The id of the department's parent department

extraDataobject nullable

Key-value pairs for your own use and reference. Keys must be at most 100 characters, values at most 512 characters, and total size less than 1kb.

Example request

{
  "name": "Engineering Operations",
  "externalName": "Engineering",
  "parentId": "1be42b8e-cafd-4beb-8121-f4981eb20f42",
  "extraData": {
    "partner_external_object_id": "12345",
    "partner_additional_data": "f763ba0e4"
  }
}

Response

Responses from the department.create endpoint

OR

Example response

{
  "success": true,
  "results": {
    "id": "3ae2b801-19f6-41ef-ad28-214bd731948f",
    "name": "Engineering Operations",
    "externalName": "Engineering",
    "isArchived": false,
    "parentId": null,
    "createdAt": "2024-01-01T00:00:00.000Z",
    "updatedAt": "2024-01-01T00:00:00.000Z",
    "extraData": null
  }
}