PATCH `/v1/ai/recipes/{recipeId}`

Edit an AI posting recipe.

Autenticação

Envie uma chave de API como um token de portador. A chave deve ter a permissão links.edit; uma chave sem ela é recusada com 403, e não 404.

Onde vai o ID da sua organização

Este endpoint aceita org_id como um campo no corpo JSON.

O ID da sua organização está na tela de chaves de API no seu painel, ao lado da própria chave. É o mesmo ID em todas as chamadas que você fizer.

Experimente

Substitua qualquer item entre colchetes por seus próprios valores e o espaço reservado para a chave por uma chave do seu painel.

curl -X PATCH https://api.zinndigital.com/v1/ai/recipes/{recipeId} \
  -H "Authorization: Bearer zdk_live_…" \
  -H "Content-Type: application/json" \
  -d '{ "name": <string> }'

Conectado? O console da API no seu painel preenche o ID da sua organização real e a sua própria chave, e executa a requisição contra a API de produção para que você possa ver a resposta real. Abra este endpoint no console da API

Detalhes

Partial update. The schedule is recomputed on every write rather than by a nightly job — a recipe saved with a cadence and no next run is a recipe that never runs and shows no error anywhere. Requires `links.edit`.

Parâmetros

Nome	Tipo	Obrigatório	O que é
`recipeId (path)`	`Uuid`	Sim	—

Corpo da requisição

Nome	Tipo	Obrigatório	O que é
`name`	`string`	Sim	—
`is_enabled`	`boolean`	Não	—
`brief`	`string`	Não	—
`tone`	`string`	Não	—
`word_count`	`integer`	Não	—
`language`	`string`	Não	—
`posts_per_run`	`integer`	Não	—
`provider`	`string`	Não	—
`model_id`	`string`	Não	—
`model_family`	`string`	Não	—
`anchors`	`AiAnchor[]`	Não	—
`anchor_policy`	`string<none, every_post, rotate>`	Não	—
`link_set_id`	`string`	Não	The reusable link set this recipe draws its links from, or `null` to use the recipe's own `anchors`. When set it replaces `anchors` rather than adding to them — two sources…
`cadence`	`string<manual, daily, weekly, monthly>`	Não	—
`cadence_hour_utc`	`integer`	Não	—
`cadence_dow`	`integer`	Não	—
`cadence_dom`	`integer`	Não	—
`target_kind`	`string<none, sites, site_group, cms_targets>`	Não	—
`target_sites`	`string[]`	Não	—
`target_site_group_id`	`object`	Não	—
`target_cms_target_ids`	`string[]`	Não	—
`target_category`	`string`	Não	—
`requires_capabilities`	`string[]`	Não	—
`capability_policy`	`string<refuse, degrade, ask>`	Não	—
`image_provider`	`string`	Não	—
`image_model`	`string`	Não	—
`featured_image`	`boolean`	Não	—
`inline_image_count`	`integer`	Não	—
`inline_placement`	`string<after_intro, between_sections, end>`	Não	—
`image_style`	`string`	Não	—
`publish_mode`	`string<draft, schedule, publish>`	Não	—
`schedule_offset_hours`	`integer`	Não	—
`schedule_stagger_minutes`	`integer`	Não	—
`org_id`	`Uuid`	Não	UUIDv7 identifier — sortable by creation time (docs/02 §8).

Resposta

Nome	Tipo	Obrigatório	O que é
`id`	`Uuid`	Sim	UUIDv7 identifier — sortable by creation time (docs/02 §8).
`name`	`string`	Sim	—
`is_enabled`	`boolean`	Sim	—
`brief`	`string`	Não	—
`tone`	`string`	Não	—
`word_count`	`integer`	Não	—
`language`	`string`	Não	BCP-47, or empty for "the language the brief is written in".
`posts_per_run`	`integer`	Não	⛔ Capped at 10. Two hundred articles from one brief are two hundred near-identical articles, which is a footprint — the exact thing the Footprint-Free line is sold to avoid.
`provider`	`string`	Não	Blank = whatever the funding route resolves to.
`model_id`	`string`	Não	Blank = the newest verified model in the family.
`model_family`	`string`	Não	—
`anchors`	`AiAnchor[]`	Não	—
`anchor_policy`	`string<none, every_post, rotate>`	Não	—
`link_set_id`	`string`	Não	The reusable link set this recipe draws its links from, or `null` to use the recipe's own `anchors`. When set it replaces `anchors` rather than adding to them — two sources…
`cadence`	`string<manual, daily, weekly, monthly>`	Sim	—
`cadence_hour_utc`	`integer`	Não	—
`cadence_dow`	`integer`	Não	0 = Monday.
`cadence_dom`	`integer`	Não	⛔ Never 29-31: a monthly recipe set to the 31st would skip February silently, and a schedule that stops without an error is the failure this feature prevents.
`next_run_at`	`object`	Não	—
`last_run_at`	`object`	Não	—
`target_kind`	`string<none, sites, site_group, cms_targets>`	Não	—
`target_sites`	`string[]`	Não	—
`target_site_group_id`	`object`	Não	—
`target_cms_target_ids`	`string[]`	Não	—
`target_category`	`string`	Não	—
`requires_capabilities`	`string[]`	Não	Capability ids the target must support, e.g. `cms_target:featured_image`. Enforced on every run: each site's capabilities are read from its CMS target and any shortfall is handl…
`capability_policy`	`string<refuse, degrade, ask>`	Não	What to do when a target cannot do something the recipe requires. Default `refuse` — silently dropping a requested field is the failure this exists to stop. `refuse` skips that…
`image_provider`	`string`	Não	—
`image_model`	`string`	Não	—
`featured_image`	`boolean`	Não	—
`inline_image_count`	`integer`	Não	—
`inline_placement`	`string<after_intro, between_sections, end>`	Não	—
`image_style`	`string`	Não	—
`publish_mode`	`string<draft, schedule, publish>`	Sim	⚖️ Owner ruling 2026-08-20: a per-recipe switch defaulting to `draft`. `draft` writes into the library and schedules nothing; `schedule` queues placements the customer can s…
`schedule_offset_hours`	`integer`	Não	—
`schedule_stagger_minutes`	`integer`	Não	Minutes between consecutive posts in one run. ⛔ Not cosmetic: a network whose articles all appear in the same minute is a footprint.
`blocking_providers`	`string[]`	Não	Providers this recipe needs a working key for and does not have. Empty means it can run now. ⚖️ A recipe naming no provider is never blocked — credits are the default route and…
`created_at`	`string`	Sim	—
`updated_at`	`string`	Não	—

Erros que este endpoint pode retornar

401 · 403 · 404 · 422 · 429