Method: projects.tenants.companies.patch

Updates specified company.

HTTP request

PATCH https://jobs.googleapis.com/v4beta1/{company.name=projects/*/tenants/*/companies/*}

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
company.name

string

Required during company update.

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

The format is "projects/{projectId}/tenants/{tenantId}/companies/{company_id}", for example, "projects/foo/tenants/bar/companies/baz".

If tenant id is unspecified, the default tenant is used. For example, "projects/foo/companies/bar".

Request body

The request body contains data with the following structure:

JSON representation 
{
  "company": {
    "name": string,
    "displayName": string,
    "externalId": string,
    "size": enum (CompanySize),
    "headquartersAddress": string,
    "hiringAgency": boolean,
    "eeoText": string,
    "websiteUri": string,
    "careerSiteUri": string,
    "imageUri": string,
    "keywordSearchableJobCustomAttributes": [
      string
    ],
    "derivedInfo": {
      "headquartersLocation": {
        object (Location)
      }
    },
    "suspended": boolean
  },
  "updateMask": string
}
Fields
company.displayName

string

Required. The display name of the company, for example, "Google LLC".
company.externalId

string

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

The maximum number of allowed characters is 255.
company.size

enum (CompanySize)

The employer's company size.
company.headquartersAddress

string

The street address of the company's main headquarters, which may be different from the job location. The service attempts to geolocate the provided address, and populates a more specific location wherever possible in DerivedInfo.headquarters_location.
company.hiringAgency

boolean

Set to true if it is the hiring agency that post jobs for other employers.

Defaults to false if not provided.
company.eeoText

string

Equal Employment Opportunity legal disclaimer text to be associated with all jobs, and typically to be displayed in all roles.

The maximum number of allowed characters is 500.
company.websiteUri

string

The URI representing the company's primary web site or home page, for example, "https://www.google.com".

The maximum number of allowed characters is 255.
company.careerSiteUri

string

The URI to employer's career site or careers page on the employer's web site, for example, "https://careers.google.com".
company.imageUri

string

A URI that hosts the employer's company logo.
company.keywordSearchableJobCustomAttributes[]

string

A list of keys of filterable Job.custom_attributes, whose corresponding stringValues are used in keyword searches. Jobs with stringValues under these specified field keys are returned if any of the values match the search keyword. Custom field values with parenthesis, brackets and special symbols are not searchable as-is, and those keyword queries must be surrounded by quotes.
company.derivedInfo

object (DerivedInfo)

Output only. Derived details about the company.
company.suspended

boolean

Output only. Indicates whether a company is flagged to be suspended from public availability by the service when job content appears suspicious, abusive, or spammy.
updateMask

string (FieldMask format)

Strongly recommended for the best service experience.

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

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

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.