PATCH
/
job-offers
/
{id}
curl --request PATCH \
  --url https://api.neobrain.io/{version}/job-offers/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "externalId": "ABC",
  "title": "Java Developer (m/f)",
  "briefDescription": "We recruit...",
  "description": "Lorem ipsum dolor sit ament...",
  "descriptionProfile": "Lorem ipsum dolor sit ament...",
  "url": "https://example.com",
  "location": "Paris",
  "isActive": 1,
  "type": "CDI",
  "companyName": "Example",
  "country": "France",
  "locale": "fr",
  "jobId": 1,
  "additionalFields": [
    {
      "externalFieldId": "external_field_code",
      "value": "Technical team"
    }
  ]
}'
{
  "id": 0,
  "externalId": "ABC",
  "title": "Java Developer (m/f)",
  "briefDescription": "We recruit...",
  "description": "Lorem ipsum dolor sit ament...",
  "descriptionProfile": "Lorem ipsum dolor sit ament...",
  "url": "https://example.com",
  "location": "Paris",
  "isActive": 1,
  "type": "CDI",
  "companyName": "Example",
  "country": "France",
  "locale": "fr",
  "jobId": 1,
  "externalJobId": "ABC",
  "additionalFields": [
    {
      "externalFieldId": "external_field_code",
      "name": "Field Name",
      "value": "Technical team"
    }
  ]
}

Authorizations

​
Authorization
string
header
required

API token for the Authorization header parameter.

Headers

​
Accept-Language
string

Language identifier, using the ISO 639-1 specification. If none provided it will use the account default language. For additional info please access /v1/locales

Path Parameters

​
id
integer
required

Resource identifier. It can be an integer or a string having the following format x-EXTERNAL_ID, where EXTERNAL_ID is a alpha numerical string and is related to externalId field value.

Body

application/json
Attributes to be updated
​
title
string
required

Job offer title

Example:

"Java Developer (m/f)"

​
isActive
boolean
required

Job offer status

Example:

1

​
externalId
string

Job offer code reference

Example:

"ABC"

​
briefDescription
string

Job offer brief description

Example:

"We recruit..."

​
description
string

Job offer content

Example:

"Lorem ipsum dolor sit ament..."

​
descriptionProfile
string

Job offer profile description

Example:

"Lorem ipsum dolor sit ament..."

​
url
string

Job offer application URL

Example:

"https://example.com"

​
location
string

Job offer location

Example:

"Paris"

​
type
string

Job offer contract type

Example:

"CDI"

​
companyName
string

Company name

Example:

"Example"

​
country
string

Job offer country

Example:

"France"

​
locale
string

Job offer locale

Example:

"fr"

​
jobId
integer

Job Id (can be Job ID (int) or externalId (string))

Example:

1

​
additionalFields
object[]

Not providing any field reference (eg. fieldId and/or externalFieldId) or no match is made from the provided field reference(s), it will attempt to create a new additional field based on the attributes given.

Response

200
application/json
Success
​
id
integer

Internal reference

Example:

0

​
externalId
string

External reference

Example:

"ABC"

​
title
string

Job offer title

Example:

"Java Developer (m/f)"

​
briefDescription
string

Job offer brief description

Example:

"We recruit..."

​
description
string

Job offer content

Example:

"Lorem ipsum dolor sit ament..."

​
descriptionProfile
string

Job offer profile description

Example:

"Lorem ipsum dolor sit ament..."

​
url
string

Job offer application URL

Example:

"https://example.com"

​
location
string

Job offer location

Example:

"Paris"

​
isActive
boolean

Job offer status

Example:

1

​
type
string

Job offer contract type

Example:

"CDI"

​
companyName
string

Company name

Example:

"Example"

​
country
string

Job offer country

Example:

"France"

​
locale
string

Job offer locale

Example:

"fr"

​
jobId
integer

Internal Job Id

Example:

1

​
externalJobId
string

External Job Id

Example:

"ABC"

​
additionalFields
object[]

Not providing any field reference (eg. fieldId and/or externalFieldId) or no match is made from the provided field reference(s), it will attempt to create a new additional field based on the attributes given.