updateAutomationConfiguration

Updates an existing automation configuration. This is a full replacement operation using PUT semantics; you must provide the complete desired state, including automationDisplayName, automationStatus, and marketplaceAutomations. The marketplaceAutomations entries you provide replace all of the configuration's existing Amazon store entries; any store that you omit is removed from the configuration. To deactivate a configuration, send its complete current state with automationStatus set to DEACTIVATED.

Path Params
string
required

The unique identifier of the automation configuration to update.

Query Params
marketplaceIds
array of strings
required

A comma-delimited list of Amazon store identifiers for the request. Required for store-scoped operations and authorization. Your application must have permission to operate in the specified stores before processing the request body.

marketplaceIds*
Body Params

The request body for updating an automation configuration.

The request body for updating an existing automation configuration.

string
required
length between 1 and 500
^[\p{L}\p{N}\s_-]+$

An updated display name for the automation configuration. To keep the current name, provide the existing value.

string
enum
required

The current status of the automation configuration. A configuration is ACTIVE as soon as it is created. The auto-response text is validated when you create a configuration or update it with automationStatus set to ACTIVE. A request that contains text that is not permitted is rejected with a 422 error. Set the status to DEACTIVATED to stop the configuration from activating without deleting it, and reset it to ACTIVE to resume it.

Show Details
ACTIVEThe automation configuration is active and processing buyer messages.
DEACTIVATEDThe automation configuration has been deactivated by the seller.
Allowed:
marketplaceAutomations
array of objects
required
length ≥ 1

The complete list of store-specific automation entries for the configuration. This list replaces all existing entries; any store you omit is removed from the configuration.

marketplaceAutomations*

The store-specific entry within an automation configuration. A seller can have multiple automation configurations, and each configuration can contain entries for one or more Amazon stores. Each store entry defines the automation response content (for example, the auto-response text) and the trigger conditions (for example, specific buyer contact topics or ASINs) for that specific store.

string
required
automationDetails
object
required

The details of the automated action.

triggerConditions
object
required

The conditions that determine when an automation configuration activates for a given store. All conditions must be met simultaneously using AND logic. Within list-based conditions (such as buyerContactTopics or asinList), any single match satisfies that condition using OR logic. For example, if buyerContactTopics contains SHIPPING and WHERES_MY_STUFF, the automation triggers when the buyer's inquiry matches either topic. Trigger conditions cannot overlap with another active automation configuration in the same store; if any combination of ASIN, buyer contact topic, and buyer contact type is already covered by another active configuration, the request is rejected with a 409 error.

Responses

Language
LoadingLoading…
Response
Choose an example:
application/json