createAutomationConfiguration

Creates a new automation configuration for automated buyer-seller messaging. The configuration is ACTIVE as soon as it is created. The response returns the full automation configuration resource, including the server-generated automationId.

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 creating an automation configuration.

The request body for creating a new automation configuration. A seller can have up to 10 automation configurations, including deactivated configurations.

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

A display name for the automation configuration. The name must be unique (case-insensitive) among the seller's automation configurations.

string
enum
required

The primary category of the automation configuration. Determines the kind of automated action performed when trigger conditions are met.

Show Details
AUTO_RESPONSEAn automated response sent to buyers when they contact the seller.
Allowed:
string
enum

The sub-type of automation configuration. Used in combination with automationType to support future automation categories (for example, different types of auto-responses or refund automations). Currently, the only supported value is AUTO_RESPONSE.

Show Details
AUTO_RESPONSEAn automated response sent to buyers when they contact the seller.
Allowed:
marketplaceAutomations
array of objects
required
length ≥ 1

A list of store-specific automation entries. Each entry specifies the store, the response content, and the trigger conditions for that store.

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