Skip to main content
PUT /api/v2/buyer/advertisers/{advertiserId}/accounts/{linkId}/reporting-bucket Sets or clears the offline reporting_bucket configuration on a linked partner account, then notifies the seller via sync_accounts. The bucket is where sales agents write offline delivery reports.

Request

curl -X PUT https://api.interchange.io/api/v2/buyer/advertisers/12345/accounts/42/reporting-bucket \
  -H "Authorization: Bearer $SCOPE3_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "reporting_bucket": {
      "protocol": "gcs",
      "bucket": "acme-adcp-reports",
      "prefix": "reports/",
      "region": "us-east-1",
      "format": "jsonl",
      "compression": "gzip",
      "file_retention_days": 30
    }
  }'

Parameters

FieldTypeRequiredNotes
advertiserIdstring (path)YesUnique identifier for the advertiser
linkIdstring (path)YesNumeric ID of the advertiser-account link row
reporting_bucketobject | nullYesBucket config, or null to clear
reporting_bucket.protocolenumYes*s3, gcs, or azure_blob
reporting_bucket.bucketstringYes*Bucket name (3–63 chars; lowercase alphanumerics, dots, hyphens)
reporting_bucket.file_retention_daysintegerYes*Days the buyer retains report files (min 1)
reporting_bucket.prefixstringNoObject key prefix within the bucket
reporting_bucket.regionstringNoStorage region (e.g. us-east-1)
reporting_bucket.formatenumNojsonl (default), csv, parquet, avro, or orc
reporting_bucket.compressionenumNogzip (default) or none
reporting_bucket.setup_instructionsstring (URL)NoHTTPS URL pointing to setup instructions for granting the agent access to the bucket
* Required only when reporting_bucket is an object.

Response

{
  "linkId": "42",
  "accountId": "acc_example_pinnacle",
  "name": "Example Corp c/o Pinnacle",
  "advertiser": "Example Corp",
  "billingProxy": null,
  "house": null,
  "billing": "advertiser",
  "sources": [{ "storefrontId": 42, "storefrontName": "Example Publisher", "sourceId": "src_main", "sourceName": "Main Feed" }],
  "advertiserId": "12345",
  "status": "active",
  "createdAt": "2025-01-15T10:30:00Z",
  "updatedAt": "2025-01-20T14:45:00Z"
}
Returns the updated linked account. The seller is notified of the bucket change automatically.

Errors

  • 400 VALIDATION_ERROR — malformed bucket name, unsupported protocol, or missing file_retention_days.
  • 404 NOT_FOUNDadvertiserId or linkId does not exist or is not visible.
See Errors for the full error contract.

Advertiser tasks

All advertiser operations

Advertiser overview

Linked accounts model

List available accounts

Find the account to configure

Revalidate delivery credential

Re-probe delivery access