Skip to main content
PATCH
Update modular source module config

Authorizations

Authorization
string
header
required

API key or access token

Path Parameters

sourceId
string
required

Inventory source ID

Minimum string length: 1
moduleInstanceId
string
required

Seller-local module instance id

Minimum string length: 1

Body

application/json

Update non-secret configuration for a module on a modular inventory source.

config
object
required

Non-secret module configuration values to write. Nested objects are deep-merged by default.

merge
boolean
default:true

When true, deep-merge config into the existing module config. When false, replace the module config.

status
enum<string>

Optional manual module status update. ACTIVE is derived by execution/readiness workflows and cannot be set through this config endpoint. Omit to leave status unchanged.

Available options:
CONFIGURING,
DISABLED,
ERROR

Response

Update modular source module config

Operator-facing setup-state projection for a modular inventory source.

inventorySource
object
required
modules
object[]
required
lifecycleSummary
object[]
required
openWorkItemCount
integer
required
Required range: 0 <= x <= 9007199254740991
activeAvailCount
integer
required
Required range: 0 <= x <= 9007199254740991