Sign in

v1

latestOpenAPI 3.0.0Creative Commons Attribution 3.02026-07-131650101.2 KB
projects

Updates specified company.

patch/v4/{+name}

Path parameters

namestring required

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/{project_id}/tenants/{tenant_id}/companies/{company_id}", for example, "projects/foo/tenants/bar/companies/baz".

Query parameters

updateMaskstring

Strongly recommended for the best service experience. If update_mask 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.

Request body

size'COMPANY_SIZE_UNSPECIFIED' | 'MINI' | 'SMALL' | 'SMEDIUM' | 'MEDIUM' | 'BIG' | 'BIGGER' | 'GIANT'

The employer's company size.

imageUristring

A URI that hosts the employer's company logo.

careerSiteUristring

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

eeoTextstring

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.

websiteUristring

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.

suspendedboolean

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.

headquartersAddressstring

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.

externalIdstring

Required. Client side company identifier, used to uniquely identify the company. The maximum number of allowed characters is 255.

namestring

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/{project_id}/tenants/{tenant_id}/companies/{company_id}", for example, "projects/foo/tenants/bar/companies/baz".

keywordSearchableJobCustomAttributesstring[]

This field is deprecated. Please set the searchability of the custom attribute in the Job.custom_attributes going forward. A list of keys of filterable Job.custom_attributes, whose corresponding string_values are used in keyword searches. Jobs with string_values 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.

displayNamestring

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

hiringAgencyboolean

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

Response

Successful response