Method: projects.jobs.patch

Updates specified job.

Typically, updated contents become visible in search results within 10 seconds, but it may take up to 5 minutes.

HTTP request

PATCH https://jobs.googleapis.com/v3p1beta1/{job.name=projects/*/jobs/*}

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
job.name

string

Required during job update.

The resource name for the job. This is generated by the service when a job is created.

The format is "projects/{project_id}/jobs/{job_id}", for example, "projects/api-test-project/jobs/1234".

Use of this field in job queries and API calls is preferred over the use of requisitionId since this value is unique.

Request body

The request body contains data with the following structure:

JSON representation
{
  "job": {
    "name": string,
    "companyName": string,
    "requisitionId": string,
    "title": string,
    "description": string,
    "addresses": [
      string
    ],
    "applicationInfo": {
      "emails": [
        string
      ],
      "instruction": string,
      "uris": [
        string
      ]
    },
    "jobBenefits": [
      enum (JobBenefit)
    ],
    "compensationInfo": {
      "entries": [
        {
          object (CompensationEntry)
        }
      ],
      "annualizedBaseCompensationRange": {
        object (CompensationRange)
      },
      "annualizedTotalCompensationRange": {
        object (CompensationRange)
      }
    },
    "customAttributes": {
      "key": string,
      "value": {
        object (CustomAttribute)
      }
    },
    "degreeTypes": [
      enum (DegreeType)
    ],
    "department": string,
    "employmentTypes": [
      enum (EmploymentType)
    ],
    "incentives": string,
    "languageCode": string,
    "jobLevel": enum (JobLevel),
    "promotionValue": number,
    "qualifications": string,
    "responsibilities": string,
    "postingRegion": enum (PostingRegion),
    "visibility": enum (Visibility),
    "jobStartTime": {
      "seconds": string,
      "nanos": number
    },
    "jobEndTime": {
      "seconds": string,
      "nanos": number
    },
    "postingPublishTime": {
      "seconds": string,
      "nanos": number
    },
    "postingExpireTime": {
      "seconds": string,
      "nanos": number
    },
    "postingCreateTime": {
      "seconds": string,
      "nanos": number
    },
    "postingUpdateTime": {
      "seconds": string,
      "nanos": number
    },
    "companyDisplayName": string,
    "derivedInfo": {
      "locations": [
        {
          object (Location)
        }
      ],
      "jobCategories": [
        enum (JobCategory)
      ]
    },
    "processingOptions": {
      "disableStreetAddressResolution": boolean,
      "htmlSanitization": enum (HtmlSanitization)
    }
  },
  "updateMask": string
}
Fields
job.companyName

string

Required. The resource name of the company listing the job, such as "projects/api-test-project/companies/foo".

job.requisitionId

string

Required. The requisition ID, also referred to as the posting ID, assigned by the client to identify a job. This field is intended to be used by clients for client identification and tracking of postings. A job is not allowed to be created if there is another job with the same [companyName], languageCode and requisitionId.

The maximum number of allowed characters is 255.

job.title

string

Required. The title of the job, such as "Software Engineer"

The maximum number of allowed characters is 500.

job.description

string

Required. The description of the job, which typically includes a multi-paragraph description of the company and related information. Separate fields are provided on the job object for responsibilities, qualifications, and other job characteristics. Use of these separate job fields is recommended.

This field accepts and sanitizes HTML input, and also accepts bold, italic, ordered list, and unordered list markup tags.

The maximum number of allowed characters is 100,000.

job.addresses[]

string

Optional but strongly recommended for the best service experience.

Location(s) where the employer is looking to hire for this job posting.

Specifying the full street address(es) of the hiring location enables better API results, especially job searches by commute time.

At most 50 locations are allowed for best search performance. If a job has more locations, it is suggested to split it into multiple jobs with unique requisitionIds (e.g. 'ReqA' becomes 'ReqA-1', 'ReqA-2', etc.) as multiple jobs with the same companyName, languageCode and requisitionId are not allowed. If the original requisitionId must be preserved, a custom field should be used for storage. It is also suggested to group the locations that close to each other in the same job for better search experience.

The maximum number of allowed characters is 500.

job.applicationInfo

object (ApplicationInfo)

Required. At least one field within ApplicationInfo must be specified.

Job application information.

job.jobBenefits[]

enum (JobBenefit)

Optional. The benefits included with the job.

job.compensationInfo

object (CompensationInfo)

Optional. Job compensation information.

job.customAttributes

map (key: string, value: object (CustomAttribute))

Optional. A map of fields to hold both filterable and non-filterable custom job attributes that are not covered by the provided structured fields.

The keys of the map are strings up to 64 bytes and must match the pattern: [a-zA-Z][a-zA-Z0-9_]*. For example, key0LikeThis or KEY_1_LIKE_THIS.

At most 100 filterable and at most 100 unfilterable keys are supported. For filterable stringValues, across all keys at most 200 values are allowed, with each string no more than 255 characters. For unfilterable stringValues, the maximum total size of stringValues across all keys is 50KB.

An object containing a list of "key": value pairs. Example: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

job.degreeTypes[]

enum (DegreeType)

Optional. The desired education degrees for the job, such as Bachelors, Masters.

job.department

string

Optional. The department or functional area within the company with the open position.

The maximum number of allowed characters is 255.

job.employmentTypes[]

enum (EmploymentType)

Optional. The employment type(s) of a job, for example, full time or part time.

job.incentives

string

Optional. A description of bonus, commission, and other compensation incentives associated with the job not including salary or pay.

The maximum number of allowed characters is 10,000.

job.languageCode

string

Optional. The language of the posting. This field is distinct from any requirements for fluency that are associated with the job.

Language codes must be in BCP-47 format, such as "en-US" or "sr-Latn". For more information, see Tags for Identifying Languages{: class="external" target="_blank" }.

If this field is unspecified and Job.description is present, detected language code based on Job.description is assigned, otherwise defaults to 'en_US'.

job.jobLevel

enum (JobLevel)

Optional. The experience level associated with the job, such as "Entry Level".

job.promotionValue

number

Optional. A promotion value of the job, as determined by the client. The value determines the sort order of the jobs returned when searching for jobs using the featured jobs search call, with higher promotional values being returned first and ties being resolved by relevance sort. Only the jobs with a promotionValue >0 are returned in a FEATURED_JOB_SEARCH.

Default value is 0, and negative values are treated as 0.

job.qualifications

string

Optional. A description of the qualifications required to perform the job. The use of this field is recommended as an alternative to using the more general description field.

This field accepts and sanitizes HTML input, and also accepts bold, italic, ordered list, and unordered list markup tags.

The maximum number of allowed characters is 10,000.

job.responsibilities

string

Optional. A description of job responsibilities. The use of this field is recommended as an alternative to using the more general description field.

This field accepts and sanitizes HTML input, and also accepts bold, italic, ordered list, and unordered list markup tags.

The maximum number of allowed characters is 10,000.

job.postingRegion

enum (PostingRegion)

Optional. The job PostingRegion (for example, state, country) throughout which the job is available. If this field is set, a LocationFilter in a search query within the job region finds this job posting if an exact location match isn't specified. If this field is set to PostingRegion.NATION or PostingRegion.ADMINISTRATIVE_AREA, setting job Job.addresses to the same location level as this field is strongly recommended.

job.visibility
(deprecated)

enum (Visibility)

Deprecated. The job is only visible to the owner.

The visibility of the job.

Defaults to Visibility.ACCOUNT_ONLY if not specified.

job.jobStartTime

string (Timestamp format)

Optional. The start timestamp of the job in UTC time zone. Typically this field is used for contracting engagements. Invalid timestamps are ignored.

A timestamp in RFC3339 UTC "Zulu" format, accurate to nanoseconds. Example: "2014-10-02T15:01:23.045123456Z".

job.jobEndTime

string (Timestamp format)

Optional. The end timestamp of the job. Typically this field is used for contracting engagements. Invalid timestamps are ignored.

A timestamp in RFC3339 UTC "Zulu" format, accurate to nanoseconds. Example: "2014-10-02T15:01:23.045123456Z".

job.postingPublishTime

string (Timestamp format)

Optional. The timestamp this job posting was most recently published. The default value is the time the request arrives at the server. Invalid timestamps are ignored.

A timestamp in RFC3339 UTC "Zulu" format, accurate to nanoseconds. Example: "2014-10-02T15:01:23.045123456Z".

job.postingExpireTime

string (Timestamp format)

Optional but strongly recommended for the best service experience.

The expiration timestamp of the job. After this timestamp, the job is marked as expired, and it no longer appears in search results. The expired job can't be deleted or listed by the [jobs.delete][] and [jobs.list][] APIs, but it can be retrieved with the [jobs.get][] API or updated with the [jobs.patch][] API. An expired job can be updated and opened again by using a future expiration timestamp. Updating an expired job fails if there is another existing open job with same companyName, languageCode and requisitionId.

The expired jobs are retained in our system for 90 days. However, the overall expired job count cannot exceed 3 times the maximum of open jobs count over the past week, otherwise jobs with earlier expire time are cleaned first. Expired jobs are no longer accessible after they are cleaned out.

Invalid timestamps are ignored, and treated as expire time not provided.

Timestamp before the instant request is made is considered valid, the job will be treated as expired immediately.

If this value is not provided at the time of job creation or is invalid, the job posting expires after 30 days from the job's creation time. For example, if the job was created on 2017/01/01 13:00AM UTC with an unspecified expiration date, the job expires after 2017/01/31 13:00AM UTC.

If this value is not provided on job update, it depends on the field masks set by UpdateJobRequest.update_mask. If the field masks include [expiry_time][], or the masks are empty meaning that every field is updated, the job posting expires after 30 days from the job's last update time. Otherwise the expiration date isn't updated.

A timestamp in RFC3339 UTC "Zulu" format, accurate to nanoseconds. Example: "2014-10-02T15:01:23.045123456Z".

job.postingCreateTime

string (Timestamp format)

Output only. The timestamp when this job posting was created.

A timestamp in RFC3339 UTC "Zulu" format, accurate to nanoseconds. Example: "2014-10-02T15:01:23.045123456Z".

job.postingUpdateTime

string (Timestamp format)

Output only. The timestamp when this job posting was last updated.

A timestamp in RFC3339 UTC "Zulu" format, accurate to nanoseconds. Example: "2014-10-02T15:01:23.045123456Z".

job.companyDisplayName

string

Output only. Display name of the company listing the job.

job.derivedInfo

object (DerivedInfo)

Output only. Derived details about the job posting.

job.processingOptions

object (ProcessingOptions)

Optional. Options for job processing.

updateMask

string (FieldMask format)

Optional but strongly recommended to be provided for the best service experience.

If updateMask is provided, only the specified fields in job are updated. Otherwise all the fields are updated.

A field mask to restrict the fields that are updated. Only top level fields of Job are supported.

A comma-separated list of fully qualified names of fields. Example: "user.displayName,photo".

Response body

If successful, the response body contains an instance of Job.

Authorization Scopes

Requires one of the following OAuth scopes:

  • https://www.googleapis.com/auth/jobs
  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

Try it!