Skip to main content
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

curl -X POST https://api.interchange.io/api/v2/storefront/sponsored-buyers/90377/suspend \
  -H "Authorization: Bearer $SCOPE3_API_KEY"

Parameters

FieldTypeRequiredNotes
buyerIdstring (path)YesThe buyerCustomerId of a buyer your organization sponsors. Must be a positive integer.

Response

200 OK with the updated SponsoredBuyer:
{
  "buyerCustomerId": 90377,
  "buyerName": "Corner Slice",
  "storefrontId": 4012,
  "status": "suspended",
  "posture": "prepay",
  "createdAt": "2026-06-12T09:15:44.901Z"
}

Errors

  • 400 VALIDATION_ERRORbuyerId is 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 already suspended.
See Errors for the full error contract.

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