Skip to main content
Create Job Family

Authorizations

Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Scopes

write

allows modifying resources

Body

application/json

Default structure for Job Family.

external_id
string<uuid>
required

The unique ID in your system, consisting of alphanumeric characters, hyphens and underscores.

Required string length: 1 - 100
Pattern: [a-zA-Z0-9_-]+
Example:

"a3903505-eb84-42dc-a79f-5e7b1fe897b7"

job_family_name
string
required

Name of the Job Family.

Required string length: 1 - 255
Example:

"Software Engineer"

job_family_group
string

Name of the Job Family Group.

Required string length: 1 - 255
Example:

"IT & Engineering"

active
boolean | null
default:true

The Job Family will not be used in matching if active is false. This is useful when a Job Family is being phased out.

Example:

true

Response

No Content