Sign in

v1

latestOpenAPI 3.0.0Creative Commons Attribution 3.02026-07-1350108168.1 KB
accounts

Update given deals to pause serving. This method will set the DealServingMetadata.DealPauseStatus.has_buyer_paused bit to true for all listed deals in the request. Currently, this method only applies to PG and PD deals. For PA deals, call accounts.proposals.pause endpoint. It is a no-op to pause already-paused deals. It is an error to call PauseProposalDeals for deals which are not part of the proposal of proposal_id or which are not finalized or renegotiating.

post/v2beta1/accounts/{accountId}/finalizedProposals/{proposalId}:pause

Path parameters

accountIdstring required

Account ID of the buyer.

proposalIdstring required

The proposal_id of the proposal containing the deals.

Request body

externalDealIdsstring[]

The external_deal_id's of the deals to be paused. If empty, all the deals in the proposal will be paused.

reasonstring

The reason why the deals are being paused. This human readable message will be displayed in the seller's UI. (Max length: 1000 unicode code units.)

Response

Successful response