Autenticación
Envía una clave de API como token de portador. La clave debe tener el permiso links.edit; una clave que no lo tenga se rechazará con un código 403, no 404.
Donde va el ID de tu organización
Este endpoint toma org_id como un campo en el cuerpo JSON.
El id de tu organización se encuentra en la pantalla de claves de API en tu panel de control, junto a la propia clave. Es el mismo id en cada llamada que realices.
Pruébalo
Reemplaza cualquier elemento entre corchetes angulares por tus propios valores, y el marcador de posición key con una clave de tu panel de control.
curl -X PATCH https://api.zinndigital.com/v1/ai/recipes/{recipeId} \
-H "Authorization: Bearer zdk_live_…" \
-H "Content-Type: application/json" \
-d '{ "name": <string> }'¿Has iniciado sesión? La consola de la API en tu panel de control rellena el ID de tu organización real y tu propia clave, y ejecuta la solicitud contra la API en vivo para que puedas ver la respuesta real. Abre este endpoint en la consola de la API
Detalles
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
| Nombre | Tipo | Obligatorio | ¿Qué es esto? |
|---|---|---|---|
recipeId (path) | Uuid | Sí | — |
Cuerpo de la solicitud
| Nombre | Tipo | Obligatorio | ¿Qué es esto? |
|---|---|---|---|
name | string | Sí | — |
is_enabled | boolean | No | — |
brief | string | No | — |
tone | string | No | — |
word_count | integer | No | — |
language | string | No | — |
posts_per_run | integer | No | — |
provider | string | No | — |
model_id | string | No | — |
model_family | string | No | — |
anchors | AiAnchor[] | No | — |
anchor_policy | string<none, every_post, rotate> | No | — |
link_set_id | string | No | 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> | No | — |
cadence_hour_utc | integer | No | — |
cadence_dow | integer | No | — |
cadence_dom | integer | No | — |
target_kind | string<none, sites, site_group, cms_targets> | No | — |
target_sites | string[] | No | — |
target_site_group_id | object | No | — |
target_cms_target_ids | string[] | No | — |
target_category | string | No | — |
requires_capabilities | string[] | No | — |
capability_policy | string<refuse, degrade, ask> | No | — |
image_provider | string | No | — |
image_model | string | No | — |
featured_image | boolean | No | — |
inline_image_count | integer | No | — |
inline_placement | string<after_intro, between_sections, end> | No | — |
image_style | string | No | — |
publish_mode | string<draft, schedule, publish> | No | — |
schedule_offset_hours | integer | No | — |
schedule_stagger_minutes | integer | No | — |
org_id | Uuid | No | UUIDv7 identifier — sortable by creation time (docs/02 §8). |
Respuesta
| Nombre | Tipo | Obligatorio | ¿Qué es esto? |
|---|---|---|---|
id | Uuid | Sí | UUIDv7 identifier — sortable by creation time (docs/02 §8). |
name | string | Sí | — |
is_enabled | boolean | Sí | — |
brief | string | No | — |
tone | string | No | — |
word_count | integer | No | — |
language | string | No | BCP-47, or empty for "the language the brief is written in". |
posts_per_run | integer | No | ⛔ 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 | No | Blank = whatever the funding route resolves to. |
model_id | string | No | Blank = the newest verified model in the family. |
model_family | string | No | — |
anchors | AiAnchor[] | No | — |
anchor_policy | string<none, every_post, rotate> | No | — |
link_set_id | string | No | 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> | Sí | — |
cadence_hour_utc | integer | No | — |
cadence_dow | integer | No | 0 = Monday. |
cadence_dom | integer | No | ⛔ 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 | No | — |
last_run_at | object | No | — |
target_kind | string<none, sites, site_group, cms_targets> | No | — |
target_sites | string[] | No | — |
target_site_group_id | object | No | — |
target_cms_target_ids | string[] | No | — |
target_category | string | No | — |
requires_capabilities | string[] | No | 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> | No | 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 | No | — |
image_model | string | No | — |
featured_image | boolean | No | — |
inline_image_count | integer | No | — |
inline_placement | string<after_intro, between_sections, end> | No | — |
image_style | string | No | — |
publish_mode | string<draft, schedule, publish> | Sí | ⚖️ 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 | No | — |
schedule_stagger_minutes | integer | No | 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[] | No | 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 | Sí | — |
updated_at | string | No | — |
Errores que este endpoint puede devolver
401 · 403 · 404 · 422 · 429