Create a department

This endpoint lets you create new departments for a given organization_reference

This endpoint requires departments_rw scope.

new department

POST https://www.welcomekit.co/api/v1/external/departments

Query Parameters

NameTypeDescription

organization_reference*

string

Organization reference

name*

string

Name

slug

string

Slug (used on careers websites)

is_active

boolean

Department active?

description

string

Description

{
  "id": 42,
  "name": "Tech",
  "is_active": true,
  "slug": "tech",
  "description": "Foo bar"
}

NB: the slug is automatically generated from the department’s name

Request example

curl -X POST "https://www.welcomekit.co/api/v1/external/departments" \
    -H "Content-Type: application/json" \
    -H "Authorization: Bearer WK_API_KEY" \
    -d @- <<EOF
{
  "organization_reference": "Pg4eV6k",
  "name": "Tech",
  "is_active": true,
  "description": "Foo bar"
}
EOF

Last updated