Skip to main content
PUT /api/v2/storefront/inventory-sources/{sourceId} Updates an AGENT inventory source. Updates are partial — send any subset of fields. Status transitions manage the linked agent lifecycle. MANAGED_SALES_AGENT, LINKED_STOREFRONT, and MODULAR_SOURCE lifecycles use their dedicated flows instead.

​
Request

curl -X PUT https://api.interchange.io/api/v2/storefront/inventory-sources/retail-network-agent \
  -H "Authorization: Bearer $SCOPE3_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Retail Network Agent (Primary)",
    "status": "ACTIVE",
    "description": "On-site display and CTV inventory"
  }'

​
Parameters

FieldTypeRequiredNotes
sourceIdstring (path)YesStorefront-scoped inventory source ID
namestringNoDisplay name (1–255 chars)
executionTypeenumNoAGENT only
statusenumNoPENDING, ACTIVE, or DISABLED
descriptionstringNoAgent description (max 2000)
endpointUrlstring (uri)NoAgent endpoint URL (max 2048)
protocolenumNoMCP or A2A
authenticationTypeenumNoAPI_KEY, JWT, BASIC_AUTH, NO_AUTH, or OAUTH
authobjectNoUpdating auth rotates the stored credential. Omit to keep existing credentials. Same API-key / Basic / JWT shapes as create
Allowed status transitions: PENDING → ACTIVE, PENDING → DISABLED, and ACTIVE ↔ DISABLED. A source cannot transition back to PENDING. Setting status: ACTIVE requires the backing agent to be authenticated and passing AAO compliance.

​
Response

200 OK with the updated InventorySourceResponse: 
{
  "id": "900123456789",
  "sourceId": "retail-network-agent",
  "name": "Retail Network Agent (Primary)",
  "executionType": "AGENT",
  "status": "ACTIVE",
  "agentId": "agent_01HX...",
  "type": "SALES",
  "endpointUrl": "https://agent.retail-network.example.com/mcp",
  "protocol": "MCP",
  "authenticationType": "API_KEY",
  "authConfigured": true,
  "isAdapterSource": false,
  "createdAt": "2026-04-25T12:05:00Z",
  "updatedAt": "2026-05-02T09:14:00Z"
}

​
Errors

  • 400 VALIDATION_ERROR — invalid status transition, malformed auth, or no fields supplied.
  • 401 UNAUTHORIZED — missing or invalid API key.
  • 404 NOT_FOUND — no source with this sourceId on your storefront.
See Errors for the full error contract.

Inventory source tasks

All operations

Inventory sources overview

Concepts and lifecycle

Get inventory source

Read one source by ID

Delete inventory source

Remove a source