Pular para o conteúdo principal
POST
Criar automações a partir de receitas

Autorizações

Authorization
string
header
obrigatório

API key criada nas configurações da organização.

Cabeçalhos

Idempotency-Key
string

Chave única da operação. Repetir a mesma chave com o mesmo corpo devolve a resposta original em vez de executar de novo.

Corpo

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

Idioma dos textos gerados. Padrão: o da identidade da marca.

Opções disponíveis:
pt-BR,
es,
es-AR,
en
platform
enum<string>

Plataforma da loja. Obrigatória quando há mais de uma loja conectada.

Opções disponíveis:
nuvemshop,
shopify,
woocommerce
summary
string
Maximum string length: 500
validate_only
boolean
padrão:false

Devolve o plano sem criar nada.

operation_id
string

Identificador único opcional desta chamada, como um UUID. Repita o mesmo valor só para tentar de novo a mesma chamada: a nova tentativa devolve o primeiro resultado em vez de criar de novo. O mesmo valor com outro conteúdo é recusado com 409.

Required string length: 8 - 128

Resposta

Plano das receitas ou implantação criada.

object
string
obrigatório
Allowed value: "recipe_deployment_result"
validate_only
boolean
obrigatório

true quando as receitas foram só planejadas; nada foi salvo.

next_step
string
obrigatório
plan
object

O que as receitas criam. Ausente quando um operation_id repetido devolve uma implantação anterior.

deployment
object