We’ve made the difficult decision to sunset Hire by Google on September 1, 2020. Learn more.

Method: tenants.jobs.patch

Updates a job in Hire.

HTTP request

PATCH https://hire.googleapis.com/v1beta1/{job.name=tenants/*/jobs/*}

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
job.name

string

Output only. Required during jobs.patch.

The resource name of this Job. This is generated by the service when a job is created. Job name takes the form of "tenants/*/jobs/*".

Request body

The request body contains data with the following structure:

JSON representation
{
  "job": {
    "name": string,
    "requisitionId": string,
    "createTime": {
      "seconds": string,
      "nanos": number
    },
    "creatingUser": string,
    "title": string,
    "department": string,
    "employmentType": enum (EmploymentType),
    "timeCommitment": enum (TimeCommitment),
    "description": string,
    "hiringManagers": [
      string
    ],
    "recruiters": [
      string
    ],
    "coordinators": [
      string
    ],
    "state": enum (State),
    "publishState": enum (PublishState),
    "compensationInfo": {
      "frequency": enum (CompensationFrequency),
      "candidateVisible": boolean,

      // Union field compensation_amount can be only one of the following:
      "amount": {
        object (Money)
      },
      "range": {
        object (CompensationRange)
      }
      // End of list of possible types for union field compensation_amount.
    },
    "location": {
      "placeId": string,
      "postalAddress": {
        object (PostalAddress)
      }
    },
    "customFields": {
      "fields": {
        string: value,
        ...
      }
    }
  },
  "updateMask": string
}
Fields
job.requisitionId

string

Output only. Can be set on jobs.create.

Id used to link data with external systems.

job.createTime

string (Timestamp format)

Output only. Date the job was created or the date specified when importing this job.

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

job.creatingUser

string

Optional. Resource name of the user that created the job. It must have the format of "tenants/*/users/*".

job.title

string

Required. The human readable job title.

job.department

string

Optional. Name of the department which the job is under.

job.employmentType

enum (EmploymentType)

Optional. Type of job.

job.timeCommitment

enum (TimeCommitment)

Optional. Time commitment level for the job.

job.description

string

Optional. Description of the job.

job.hiringManagers[]

string

List of resource names of the hiring managers for this job. They must have the format of "tenants/*/users/*".

job.recruiters[]

string

List of resource names of the recruiters for this job. They must have the format of "tenants/*/users/*".

job.coordinators[]

string

List of resource names of the coordinators for this job. They must have the format of "tenants/*/users/*".

job.state

enum (State)

Output only. Job state.

The set of available job states differ depending on job request approvals.

If job request approvals is off, then state can be Job.State.OPEN or Job.State.CLOSED, and all jobs can be edited.

If job request approvals is on, then all states are available. In Job.State.CLOSED, Job.State.DRAFT, and Job.State.APPROVAL_REJECTED states, the job can be edited. In Job.State.OPEN and Job.State.PENDING_APPROVAL states, no job fields can be edited.

Job req approvals can be toggled by a Hire admin at Admin > Approvals.

job.publishState

enum (PublishState)

Output Only.

Publish state of the job.

job.compensationInfo

object (CompensationInfo)

Optional. Compensation info for the job.

job.location

object (Location)

Optional. Location of the job.

job.customFields

object (Struct format)

Optional. Mapping of CustomFieldSpec name to value for all custom fields for this job.

updateMask

string (FieldMask format)

Required. A field mask to specify the job fields to be updated. Only top level fields of Jobs are supported.

Sample updateMask: {"paths": ["job.description", "job.title"]}

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 the following OAuth scope:

  • https://www.googleapis.com/auth/hire.job.readwrite

For more information, see the OAuth 2.0 Overview.