Method: projects.tenants.profiles.applications.patch

Updates specified application.

HTTP request

PATCH https://jobs.googleapis.com/v4beta1/{application.name=projects/*/tenants/*/profiles/*/applications/*}

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
application.name

string

Required during application update.

Resource name assigned to an application by the API.

The format is "projects/{project_id}/tenants/{tenantId}/profiles/{profile_id}/applications/{application_id}", for example, "projects/api-test-project/tenants/foo/profiles/bar/applications/baz".

Request body

The request body contains data with the following structure:

JSON representation
{
  "application": {
    "name": string,
    "externalId": string,
    "profile": string,
    "job": string,
    "company": string,
    "applicationDate": {
      object (Date)
    },
    "stage": enum (ApplicationStage),
    "state": enum (ApplicationState),
    "interviews": [
      {
        object (Interview)
      }
    ],
    "referral": boolean,
    "createTime": string,
    "updateTime": string,
    "outcomeNotes": string,
    "outcome": enum (Outcome),
    "isMatch": boolean,
    "jobTitleSnippet": string
  },
  "updateMask": string
}
Fields
application.externalId

string

Required. Client side application identifier, used to uniquely identify the application.

The maximum number of allowed characters is 255.

application.profile

string

Output only. Resource name of the candidate of this application.

The format is "projects/{project_id}/tenants/{tenantId}/profiles/{profile_id}", for example, "projects/api-test-project/tenants/foo/profiles/bar".

application.job

string

One of either a job or a company is required.

Resource name of the job which the candidate applied for.

The format is "projects/{project_id}/tenants/{tenantId}/jobs/{job_id}", for example, "projects/api-test-project/tenants/foo/jobs/bar".

application.company

string

One of either a job or a company is required.

Resource name of the company which the candidate applied for.

The format is "projects/{project_id}/tenants/{tenantId}/companies/{company_id}", for example, "projects/api-test-project/tenants/foo/companies/bar".

application.applicationDate

object (Date)

Optional. The application date.

application.stage

enum (ApplicationStage)

Required. What is the most recent stage of the application (that is, new, screen, send cv, hired, finished work)? This field is intentionally not comprehensive of every possible status, but instead, represents statuses that would be used to indicate to the ML models good / bad matches.

application.state

enum (ApplicationState)

Optional. The application state.

application.interviews[]

object (Interview)

Optional. All interviews (screen, onsite, and so on) conducted as part of this application (includes details such as user conducting the interview, timestamp, feedback, and so on).

application.referral

boolean

Optional. If the candidate is referred by a employee.

application.createTime

string (Timestamp format)

Required. Reflects the time that the application was created.

application.updateTime

string (Timestamp format)

Optional. The last update timestamp.

application.outcomeNotes

string

Optional. Free text reason behind the recruitement outcome (for example, reason for withdraw / reject, reason for an unsuccessful finish, and so on).

Number of characters allowed is 100.

application.outcome

enum (Outcome)

Optional. Outcome positiveness shows how positive the outcome is.

application.isMatch

boolean

Output only. Indicates whether this job application is a match to application related filters. This value is only applicable in profile search response.

application.jobTitleSnippet

string

Output only. Job title snippet shows how the job title is related to a search query. It's empty if the job title isn't related to the search query.

updateMask

string (FieldMask format)

Optional but strongly recommended for the best service experience.

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

A field mask to specify the application fields to be updated. Only top level fields of Application 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 Application.

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!

Var denne siden nyttig? Si fra hva du synes:

Send tilbakemelding om ...

Job search documentation
Trenger du hjelp? Gå til brukerstøttesiden vår.