Rotate ad-server credentials

PUT /api/v2/storefront/inventory-sources/{sourceId}/adapter-config Rotates credentials on an already-provisioned ad-server source without re-provisioning. Products, principals, and sync history survive the rotation. Use this for FreeWheel and SpringServe, whose credentials rotate — Google Ad Manager rotation uses Replace ad-server config since Scope3 manages those credentials.

Request

curl -X PUT https://api.interchange.io/api/v2/storefront/inventory-sources/retail-fw/adapter-config \
  -H "Authorization: Bearer $SCOPE3_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "type": "freewheel",
    "clientId": "fw-client-id",
    "clientSecret": "<NEW_FREEWHEEL_CLIENT_SECRET>",
    "environment": "production"
  }'

{
  "type": "springserve",
  "email": "ops@retail-network.example.com",
  "password": "<NEW_SPRINGSERVE_PASSWORD>",
  "environment": "production"
}

Parameters

Same AdServerConfig body as Replace ad-server config. The type discriminator selects the adapter; supply the rotated credentials for that adapter.

Field	Type	Required	Notes
`sourceId`	string (path)	Yes	Storefront-scoped inventory source ID
`type`	enum	Yes	`google_ad_manager`, `freewheel`, or `springserve`

New clientSecret, password, and apiToken values are forwarded to the managed ad-server source and never persisted by Scope3. Treat them as production secrets — never log or commit them.

Response

200 OK with the updated EsaConnection (same shape as Get ad-server connection):

{
  "id": "550200",
  "customerId": 4210,
  "tenantId": "tnt_retail_fw",
  "adServer": {
    "type": "freewheel",
    "clientId": "fw-client-id",
    "username": null,
    "environment": "production",
    "defaultAdvertiserId": null
  },
  "serviceAccountEmail": null,
  "lastError": null,
  "lastErrorCode": null,
  "lastTestedAt": "2026-05-02T09:30:00Z",
  "updatedAt": "2026-05-02T09:30:00Z"
}

Errors

400 VALIDATION_ERROR — unknown type or missing credentials for the adapter.
401 UNAUTHORIZED — missing or invalid API key.
404 NOT_FOUND — no ad-server-backed source with this sourceId.

See Errors for the full error contract.

Inventory source tasks

All operations

Replace ad-server config

Set the full config (and GAM rotation)

Test connection

Verify the rotated credentials

Get ad-server connection

Connection state

Replace ad-server config Test connection

⌘I

​Request

​Parameters

​Response

​Errors

​Related

Inventory source tasks

Replace ad-server config

Test connection

Get ad-server connection

Request

Parameters

Response

Errors

Related