---
updatedAt: 2026-05-27T16:33:24.000Z
agentTools:
  projectIndex: https://developers.smartrecruiters.com/llms.txt
---

# Create a job property

Creates a job property

# OpenAPI definition

```json
{
  "openapi": "3.0.1",
  "info": {
    "version": "1.2.0",
    "title": "Configuration API",
    "contact": {
      "name": "SmartRecruiters",
      "url": "https://developers.smartrecruiters.com"
    }
  },
  "paths": {
    "/configuration/job-properties": {
      "post": {
        "responses": {
          "201": {
            "description": "Created job property",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/JobPropertyDefinition"
                }
              }
            }
          },
          "403": {
            "description": "Forbidden to access the resource, check your authorisation and rights.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "409": {
            "description": "with code\n* **NON_UNIQUE_CUSTOM_FIELD_KEY** when job property key already exists\n",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "422": {
            "description": "With codes:\n* *JOB_PROPERTY_LIMIT_EXCEEDED* when job properties limit is reached,\n* *DEFINITION_NAME_IS_NOT_ALLOWED* when job property name is restricted,\n* *INVALID_JOB_PROPERTY_KEY* when the job property `key` contains invalid characters,\n* *INVALID_JOB_PROPERTY* when a job property field contains invalid characters.\n"
          }
        },
        "description": "Creates a job property",
        "tags": [
          "configuration"
        ],
        "summary": "Create a job property",
        "operationId": "configuration.job-properties.create",
        "security": [
          {
            "key": []
          },
          {
            "oauth": [
              "configuration_manage"
            ]
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/JobPropertyDefinitionCreationRequest"
              }
            }
          },
          "description": "job property to be created"
        }
      }
    }
  },
  "components": {
    "securitySchemes": {
      "key": {
        "type": "apiKey",
        "in": "header",
        "name": "x-smarttoken"
      },
      "oauth": {
        "type": "oauth2",
        "flows": {
          "authorizationCode": {
            "authorizationUrl": "https://www.smartrecruiters.com/identity/oauth/allow",
            "tokenUrl": "https://api.smartrecruiters.com/identity/oauth/token",
            "scopes": {
              "configuration_read": "Access Company Settings",
              "configuration_manage": "Manage Company Settings",
              "company_read": "Access Company Information",
              "recruiter_sources_manage": "Manage Recruiter Sources"
            }
          }
        }
      }
    },
    "schemas": {
      "ErrorResponse": {
        "type": "object",
        "properties": {
          "message": {
            "type": "string"
          },
          "errors": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/Error"
            }
          }
        }
      },
      "Error": {
        "type": "object",
        "required": [
          "code"
        ],
        "properties": {
          "code": {
            "type": "string"
          },
          "message": {
            "type": "string"
          }
        }
      },
      "Actions": {
        "type": "object",
        "additionalProperties": {
          "$ref": "#/components/schemas/Action"
        }
      },
      "Action": {
        "type": "object",
        "required": [
          "url",
          "method"
        ],
        "properties": {
          "url": {
            "type": "string"
          },
          "method": {
            "type": "string",
            "enum": [
              "GET",
              "POST",
              "PUT",
              "PATCH",
              "OPTIONS",
              "DELETE",
              "HEAD",
              "CONNECT"
            ]
          }
        }
      },
      "JobPropertyDefinition": {
        "type": "object",
        "required": [
          "label",
          "category",
          "visible"
        ],
        "properties": {
          "id": {
            "type": "string"
          },
          "label": {
            "type": "string"
          },
          "category": {
            "type": "string",
            "enum": [
              "job",
              "organization"
            ]
          },
          "active": {
            "type": "boolean"
          },
          "visible": {
            "type": "boolean"
          },
          "required": {
            "type": "boolean"
          },
          "key": {
            "type": "string"
          },
          "reference": {
            "$ref": "#/components/schemas/CrossSystemDataReference"
          },
          "actions": {
            "$ref": "#/components/schemas/Actions"
          }
        }
      },
      "JobPropertyDefinitionCreationRequest": {
        "type": "object",
        "required": [
          "label",
          "category",
          "visible"
        ],
        "properties": {
          "label": {
            "type": "string"
          },
          "category": {
            "type": "string",
            "enum": [
              "job",
              "organization"
            ]
          },
          "active": {
            "type": "boolean"
          },
          "visible": {
            "type": "boolean"
          },
          "required": {
            "type": "boolean"
          },
          "key": {
            "type": "string"
          }
        }
      },
      "CrossSystemDataReference": {
        "type": "object",
        "description": "Reference to an external source system. Read-only — not modifiable through SmartRecruiters.",
        "properties": {
          "type": {
            "type": "string",
            "description": "Type of the external entity (e.g. \"picklist\")."
          },
          "code": {
            "type": "string",
            "description": "Code of the external entity (e.g. \"ecPhoneType\")."
          }
        }
      }
    }
  },
  "servers": [
    {
      "url": "https://api.smartrecruiters.com"
    }
  ]
}
```