Method: opportunities.patch

Updates an existing Opportunity resource.

  • DRAFT/REJECTED: All fields for a DRAFT or REJECTED Opportunity can be edited.
  • SUBMITTED: You can't make further updates to a SUBMITTED Opportunity.
  • ACCEPTED: You can update some, but not all, of the fields for an ACCEPTED opportunity.

Possible error codes:

  • PERMISSION_DENIED: The user making the request isn't allowed to update the opportunity.
  • INVALID_ARGUMENT: Required request parameters are missing or invalid.
  • NOT_FOUND: No Opportunity resource found for the name in the request.

Return value: The updated Opportunity resource.

HTTP request

PATCH https://cloudchannel.googleapis.com/v1alpha1/{opportunity.name=opportunities/*}

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
opportunity.name

string

Identifier. Resource name of an Opportunity in the form: opportunities/{opportunity_id}. Available in Limited view.

Query parameters

Parameters
updateMask

string (FieldMask format)

Required. The list of fields to update.

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

string

Required. Provide the Partner Id for which the Opportunity is being updated. Format: partner = partners/{id}

Request body

The request body contains an instance of Opportunity.

Response body

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

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/apps.order

For more information, see the Authentication Overview.