Skip to main content
POST
Create automations from recipes

Authorizations

Authorization
string
header
required

API key created in the organization settings.

Headers

Idempotency-Key
string

Unique key for the operation. Repeating the same key with the same body returns the original response instead of running it again.

Body

application/json
recipes
object[]
required
Required array length: 1 - 7 elements
locale
enum<string>

Language of the generated copy. Defaults to the brand identity's.

Available options:
pt-BR,
es,
es-AR,
en
platform
enum<string>

Store platform. Required when more than one store is connected.

Available options:
nuvemshop,
shopify,
woocommerce
summary
string
Maximum string length: 500
validate_only
boolean
default:false

Returns the plan without creating anything.

operation_id
string

Optional unique id for this call, such as a UUID. Reuse the same value only to retry the same call: the retry returns the first result instead of creating again. The same value with a different body is rejected with 409.

Required string length: 8 - 128

Response

Recipe plan or created deployment.

object
string
required
Allowed value: "recipe_deployment_result"
validate_only
boolean
required

true when the recipes were only planned; nothing was saved.

next_step
string
required
plan
object

What the recipes create. Missing when a repeated operation_id returns an earlier deployment.

deployment
object