ai

PATCH /v1/ai/recipes/{recipeId}

Edit an AI posting recipe.

Все эндпоинты ai

Аутентификация

Отправьте ключ API в качестве токена носителя (bearer token). Ключ должен иметь разрешение links.edit; ключ без него отклоняется с кодом 403, а не 404.

Идентификатор вашей организации

Этот эндпоинт принимает org_id в качестве поля в теле JSON.

Идентификатор вашей организации находится на экране ключей API в вашей панели управления, рядом с самим ключом. Это один и тот же идентификатор для каждого вашего запроса.

Попробовать

Замените всё в угловых скобках на собственные значения, а плейсхолдер ключа — на ключ из вашей панели управления.

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

Вошли в систему? Консоль API в вашей панели управления автоматически подставляет реальный идентификатор вашей организации и ваш собственный ключ, а также выполняет запрос к работающему API, чтобы вы могли увидеть актуальный ответ. Откройте эту конечную точку в API-консоли

Подробнее

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`.

Параметры

ИмяТипОбязательноЧто это
recipeId (path)UuidДа

Тело запроса

ИмяТипОбязательноЧто это
namestringДа
is_enabledbooleanНет
briefstringНет
tonestringНет
word_countintegerНет
languagestringНет
posts_per_runintegerНет
providerstringНет
model_idstringНет
model_familystringНет
anchorsAiAnchor[]Нет
anchor_policystring<none, every_post, rotate>Нет
link_set_idstringНет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…
cadencestring<manual, daily, weekly, monthly>Нет
cadence_hour_utcintegerНет
cadence_dowintegerНет
cadence_domintegerНет
target_kindstring<none, sites, site_group, cms_targets>Нет
target_sitesstring[]Нет
target_site_group_idobjectНет
target_cms_target_idsstring[]Нет
target_categorystringНет
requires_capabilitiesstring[]Нет
capability_policystring<refuse, degrade, ask>Нет
image_providerstringНет
image_modelstringНет
featured_imagebooleanНет
inline_image_countintegerНет
inline_placementstring<after_intro, between_sections, end>Нет
image_stylestringНет
publish_modestring<draft, schedule, publish>Нет
schedule_offset_hoursintegerНет
schedule_stagger_minutesintegerНет
org_idUuidНетUUIDv7 identifier — sortable by creation time (docs/02 §8).

Ответ

ИмяТипОбязательноЧто это
idUuidДаUUIDv7 identifier — sortable by creation time (docs/02 §8).
namestringДа
is_enabledbooleanДа
briefstringНет
tonestringНет
word_countintegerНет
languagestringНетBCP-47, or empty for "the language the brief is written in".
posts_per_runintegerНет⛔ 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.
providerstringНетBlank = whatever the funding route resolves to.
model_idstringНетBlank = the newest verified model in the family.
model_familystringНет
anchorsAiAnchor[]Нет
anchor_policystring<none, every_post, rotate>Нет
link_set_idstringНет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…
cadencestring<manual, daily, weekly, monthly>Да
cadence_hour_utcintegerНет
cadence_dowintegerНет0 = Monday.
cadence_domintegerНет⛔ 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_atobjectНет
last_run_atobjectНет
target_kindstring<none, sites, site_group, cms_targets>Нет
target_sitesstring[]Нет
target_site_group_idobjectНет
target_cms_target_idsstring[]Нет
target_categorystringНет
requires_capabilitiesstring[]Нет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_policystring<refuse, degrade, ask>Нет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_providerstringНет
image_modelstringНет
featured_imagebooleanНет
inline_image_countintegerНет
inline_placementstring<after_intro, between_sections, end>Нет
image_stylestringНет
publish_modestring<draft, schedule, publish>Да⚖️ 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_hoursintegerНет
schedule_stagger_minutesintegerНетMinutes between consecutive posts in one run. ⛔ Not cosmetic: a network whose articles all appear in the same minute is a footprint.
blocking_providersstring[]Нет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_atstringДа
updated_atstringНет

Ошибки, которые может возвращать этот эндпоинт

401 · 403 · 404 · 422 · 429