---
title: "Update a job property"
method: PATCH
path: "/configuration/job-properties/{id}"
tags: ["configuration"]
---

# Update a job property

`PATCH /configuration/job-properties/{id}`

## Request

- Base URL: `https://api.smartrecruiters.com`
- URL: `https://api.smartrecruiters.com/configuration/job-properties/{id}`
- 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`

Updates a job property. Id parameter is a job property id or key.

## Request body

- Path[]
  - `path` string, required

## Response `200`

Updated 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

- `400`: Job property is not editable
- `403`: Forbidden to access the resource, check your authorisation and rights.
- `404`: Job property not found
- `422`: With codes: * *DEFINITION_NAME_IS_NOT_ALLOWED* when job property name is restricted, * *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)