---
title: "Create a job property"
method: POST
path: "/configuration/job-properties"
tags: ["configuration"]
---

# Create a job property

`POST /configuration/job-properties`

## Request

- Base URL: `https://api.smartrecruiters.com`
- URL: `https://api.smartrecruiters.com/configuration/job-properties`
- Auth: one of:
  - API key in header `x-smarttoken`
  - OAuth 2
    - Authorization code: `https://www.smartrecruiters.com/identity/oauth/allow`
    - Token URL: `https://api.smartrecruiters.com/identity/oauth/token` scopes: `configuration_manage`

Creates a job property

## Request body

- JobPropertyDefinitionCreationRequest
  - `label` string, required
  - `category` 'job' | 'organization', required
  - `active` boolean
  - `visible` boolean, required
  - `required` boolean
  - `key` string

## Response `201`

Created job property

- JobPropertyDefinition
  - `id` string
  - `label` string, required
  - `category` 'job' | 'organization', required
  - `active` boolean
  - `visible` boolean, required
  - `required` boolean
  - `key` string
  - `reference` CrossSystemDataReference: Reference to an external source system. Read-only — not modifiable through SmartRecruiters.
    - `type` string: Type of the external entity (e.g. "picklist").
    - `code` string: Code of the external entity (e.g. "ecPhoneType").
  - `actions` Actions

## Other responses

- `403`: Forbidden to access the resource, check your authorisation and rights.
- `409`: with code * **NON_UNIQUE_CUSTOM_FIELD_KEY** when job property key already exists
- `422`: With codes: * *JOB_PROPERTY_LIMIT_EXCEEDED* when job properties limit is reached, * *DEFINITION_NAME_IS_NOT_ALLOWED* when job property name is restricted, * *INVALID_JOB_PROPERTY_KEY* when the job property `key` contains invalid characters, * *INVALID_JOB_PROPERTY* when a job property field contains invalid characters.

---

[API](https://skmtc.dev/smartrecruiters/apis/configuration-api.md) - [All operations](https://skmtc.dev/smartrecruiters/apis/configuration-api/llms.txt) - [OpenAPI document](https://skmtc.dev/smartrecruiters/apis/configuration-api/revisions/65491281a1a6?raw)