POST /api/v2/storefront/sponsored-buyers/{buyerId}/suspend
Suspends a sponsored buyer, moving it to suspended. A suspended buyer cannot create or edit media buys against your storefront. You can suspend a buyer that is either pending or active.
Suspending blocks new media buys and edits. It does not pause in-flight delivery on media buys that are already running.
Request
Parameters
| Field | Type | Required | Notes |
|---|---|---|---|
buyerId | string (path) | Yes | The buyerCustomerId of a buyer your organization sponsors. Must be a positive integer. |
Response
200 OK with the updated SponsoredBuyer:
Errors
400 VALIDATION_ERROR—buyerIdis not a positive integer.401 UNAUTHORIZED— missing or invalid API key.403 CUSTOMER_ROLE_DENIED— the API key is not a seller account; only sellers manage sponsored buyers.404 NOT_FOUND— no sponsored buyer with this id under your organization.409 CONFLICT— the buyer is alreadysuspended.
Related
Sponsored-buyer tasks
All operations
Reactivate sponsored buyer
Resume a suspended buyer
List sponsored buyers
Find a buyer’s id and status
Errors
Shared error contract