Update article cover alt text
update_article_cover_alt_textReplaces the alt text of an article's cover image. The alt text is stored once per article and used for every locale. An empty string clears it, in which case the headline is used. Inline images keep their alt text in the markdown body (): edit it with update_article_content. Free. Editing an article that is already published (or published in draft) marks it Out of Sync until it is synced with sync_article_to_cms or published again. Pass website_id when the account has several websites (see get_account).
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| alt_text | Yes | Alt text of the cover image (max 200 characters): what the image shows, for search engines and screen readers. Shared by every locale of the article and sent to the CMS with the image. | |
| article_id | Yes | Article id from list_articles. | |
| website_id | No | Website id from get_account. Optional when the account has a single website. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| slug | Yes | ||
| locale | Yes | Translation locale the change applied to; null for the default-language article or a field shared by every locale. The other fields always describe the default-language article. | |
| status | Yes | Raw status; status_label is the human reading. | |
| message | Yes | What changed, e.g. "Headline updated for the fr version." | |
| headline | Yes | ||
| article_id | Yes | ||
| created_at | Yes | ||
| preview_text | Yes | First 200 characters of the body. | |
| published_at | Yes | ||
| status_label | Yes | Status as shown in the app, e.g. Published, Draft on CMS, Failed to publish. | |
| is_out_of_sync | Yes | Edited since the last push to the CMS; sync_article_to_cms clears it. | |
| main_image_url | Yes | Cover image URL. | |
| target_keyword | Yes | ||
| meta_description | Yes |