Method: projects.tenants.companies.patch

Stay organized with collections Save and categorize content based on your preferences.

Updates specified company.

HTTP request


The URL uses gRPC Transcoding syntax.

Path parameters



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".

Query parameters


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.

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

Request body

The request body contains an instance of Company.

Response body

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

Authorization Scopes

Requires one of the following OAuth scopes:


For more information, see the Authentication Overview.