Update Job

Update Job

PUT

Nested custom-field value policy

When the request contains linked parent and child custom fields, use invalid_linked_custom_field_value_policy to control what happens when a child value is hidden by, or does not match, its effective parent value.

Value	Behaviour
`keep`	Preserves invalid child values. This is the default when the property is omitted.
`clear`	Stores invalid non-file child values as `null`. File values are always retained.

The operation completes successfully under either policy. A child-only update is evaluated against the parent value already stored on the record. A parent update also re-evaluates its descendants.

JSON example

{
  "invalid_linked_custom_field_value_policy": "clear",
  "custom_fields": [
    { "id": 12, "value": "EMEA" },
    { "id": 13, "value": "Germany" }
  ]
}

Custom-field request IDs are the public IDs returned as id by GET /v1/custom-field. Use that endpoint to discover each child field's dependency, including the parent field's public parent_field_id, the visible_when values that make the child visible, and any allowed_child_options for dropdown or multiselect child fields.

The response envelope and entity response fields are unchanged; only the resulting child value may be retained or returned as null according to the selected policy.

Update the details of an existing job by their unique slug.

Request

PUT

PUT /v1/job/:slug

Path Parameter

slugstring
Replace :slug with the job's unique slug in the request URL.

Body

position_namestring
>= 1 characters (required)
headcountinteger
it must have positive integer(required)
tagsstring
Allowed Comma-separated values:- [Java,Leadership]
skillsstring
Allowed Comma-separated values:- [Java,PHP,Mysql]
descriptionstring
>= 1 characters
currency_idinteger
talent_funnel_idinteger
minimum_salarynumber
it can have any numeric value
maximum_salarynumber
it can have any numeric value
countrystring
>= 1 characters
frequency_typeinteger
Allowed Values:
1 => Annual,
2 => Monthly,
3 => Weekly,
4 => Daily,
5 => Hourly
job_contract_type_idinteger
Allowed Values:
1 => Full Time,
2 => Part Time,
3 => Contract,
4 => Temporary,
5 => Freelance,
6 => Internship,
7 => Apprenticeship,
8 => Remote,
9 => Contract To Permanent
categorystring
>= 1 characters
qualification_idinteger
specializationstring
>= 1 characters
industry_idinteger
open_datestring
Format: YYYY-MM-DD (e.g., 1990-01-01)
close_datestring
Format: YYYY-MM-DD (e.g., 1990-01-01)
citystring
>= 1 characters
statestring
>= 1 characters
addressstring
>= 1 characters
collaborator_idsstring
Comma-separated values:- [1,2,3]
minimum_experienceinteger
it must have positive integer
maximum_experienceinteger
it must have positive integer
job_descriptionstring
>= 1 characters
job_status_idinteger
primary_contact_slugstring
>= 1 characters
created_byinteger
owner_idinteger
(required)
organization_slugstring
>= 1 characters
enable_job_application_forminteger
Available values: 1 - enable, 0 - disable
xml_feedsstring
Allowed Comma-separated values:- "1,2,3"
Available values:
1: Indeed
2: ZipRecruiter
3: Monster
4: Jora
5: Jooble
6: Adzuna
7: DrJob
8: MyJobHelper
9: PostJobFree
10: CareerJet
custom fields:Array[object]
For Example:
"id": 1,
"value": "textfeild"
invalid_linked_custom_field_value_policystring
Optional. Allowed values: keep, clear. Default: keep. Controls whether invalid linked child custom-field values are retained or cleared.

Response

201

Body

idnumber
Example: 19
position_namestring
Example: SS
headcountnumber
Example: 1
slugstring
Example: job_82f997b417b262392261
tagsstring
Example: [frontend, developer, javascript]
descriptionstring
Example: Experienced software engineer with a focus on frontend development.
currencyobject
Example:
"id": 1,
"country": "usa",
"code": "ALL",
"currency": "dollar",
"symbol": "$"
talent_funnel_idinteger
Example: 3
contract_details_idinteger
Example: 1
minimum_salarynumber
Example: 0
maximum_salarynumber
Example: 0
countrystring
Example: india
frequency_typeinteger
Example: 1
categorystring
Example: web designing
qualificationobject
Example:
"id": 1,
"name": "btech",
specializationstring
Example: Artificial intelligence
industryobject
Example:
"id": 1,
"name": "btech",
open_datestring
Example: 1990-04-04
close_datestring
Example: 1990-04-04
citystring
Example: rewa
statestring
Example: M.P.
addressstring
Example: pipariya
skillsstring
Example:[java,php]
collaboratorsobject
Example:
"id": 1,
"email": "Rohan@abc.com",
"first_name": "Rohan",
"last_name": "Sharma",
"full_name": "Rohan Sharma",
"role": "Admin",
"phone": null
job_statusobject
Example:
"id": 1,
"label": "open",
organizationsobject
Example:
"id": 1
contactsobject
Example:
"id": 1
created_atstring (ISO 8601 date)
Example: 2015-05-15T00:00:00Z
updated_atstring (ISO 8601 date)
Example: 2015-05-15T00:00:00Z
created_byobject
Example:
"id": 1,
"email": "Rohan@abc.com",
"first_name": "Rohan",
"last_name": "Sharma",
"full_name": "Rohan Sharma",
"role": "Admin",
"phone": null
updated_byobject
Example:
"id": 1,
"email": "Rohan@abc.com",
"first_name": "Rohan",
"last_name": "Sharma",
"full_name": "Rohan Sharma",
"role": "Admin",
"phone": null
owner_idobject
Example:
"id": 1,
"email": "Rohan@abc.com",
"first_name": "Rohan",
"last_name": "Sharma",
"full_name": "Rohan Sharma",
"role": "Admin",
"phone": null
custom fields:object
Example:
"id": 1,
"field_name": "textfeild",
"field_type": "string",
"value": "anjali"

401

Body

unauthorised

400

Body

Unprocessable Entity

Response Example

{
    "id": 12,
    "position_name": "Test job for custommfields ",
    "headcount": 1,
    "slug": "job_2433eb46dd7056e36998",
    "tags": "java,python,c,c++",
    "description": "<p>desc </p>",
    "currency": null,
    "talent_funnel_id": 3,
    "contract_details_id": 1,
    "minimum_salary": 0,
    "maximum_salary": 0,
    "country": "",
    "frequency_type": 1,
    "category": "",
    "qualification": {
        "id": 1
    },
    "specialization": "",
    "industry": null,
    "open_date": "",
    "close_date": "",
    "city": "",
    "state": "",
    "address": "",
    "skills": "java,python,c,c++,dot net",
    "collaborators": [
        {
            "id": 1,
            "email": "Rohan@abc.com",
            "first_name": "Rohan",
            "last_name": "Sharma",
            "full_name": "Rohan Sharma",
            "role": "Admin",
            "phone": null
        }
    ],
    "job_status": {
        "id": 1,
        "label": "Open"
    },
    "organization": {
        "id": 5
    },
    "contact": {
        "id": 8
    },
    "created_at": "2024-06-27T17:43:17.000Z",
    "updated_at": "2024-06-28T01:05:34.000Z",
    "created_by": {
        "id": 1,
        "email": "Rohan@abc.com",
        "first_name": "Rohan",
        "last_name": "Sharma",
        "full_name": "Rohan Sharma",
        "role": "Admin",
        "phone": null
    },
    "updated_by": {
        "id": 1,
        "email": "Rohan@abc.com",
        "first_name": "Rohan",
        "last_name": "Sharma",
        "full_name": "Rohan Sharma",
        "role": "Admin",
        "phone": null
    },
    "owner_id": {
         "id": 1,
        "email": "Rohan@abc.com",
        "first_name": "Rohan",
        "last_name": "Sharma",
        "full_name": "Rohan Sharma",
        "role": "Admin",
        "phone": null
    },
    "custom_fields": [
        {
            "id": 1,
            "field_name": "Job DD",
            "field_type": "dropdown",
            "value": "2"
        }
    ]
}

Nested custom-field value policy

Request​

PUT

Path Parameter

Body

Response​

Body

Body

Body

Response Example​

Request

Response

Response Example