---
title: Update Article Metadata Fields
framework: applenewsapi
role: symbol
role_heading: Object
path: applenewsapi/update-article-metadata-fields
---

# Update Article Metadata Fields

See the metadata fields for the Update an Article request.

## Declaration

```data
object Update Article Metadata Fields
```

## Properties

revision: The current revision token for the article. The value of this field must match the latest revision from an earlier Create, Read, or Update Article call. This field prevents multiple users from updating an article simultaneously, which results in data loss. accessoryText: The text to include below the article excerpt in the channel view, such as a byline or category label. isCandidateToBeFeatured: A Boolean that indicates whether this article should be considered for featuring in Apple News. isHidden: A Boolean that indicates whether the article should be temporarily hidden from display in the News feed. Note that a hidden article is accessible if you have a direct link to the article. isPreview: A Boolean that indicates whether this article should be public (live) or should be a preview that’s only visible to members of your channel. Set isPreview to false to publish the article immediately and make it visible to all News users. If your channel hasn’t yet been approved to publish articles in Apple News Format, setting isPreview to false results in an ONLY_PREVIEW_ALLOWED error. isSponsored: A Boolean that indicates whether this article consists of sponsored content for promotional purposes. You must mark sponsored content as such; channels that don’t follow this policy may be suspended. When using isSponsored, if you don’t want the sponsored article to appear in your channel’s feed, set sections to [] (an empty array). links: The section links for the article. maturityRating: A string that indicates the viewing audience for the content. MATURE indicates explicit content that’s only appropriate for a specific audience. By default, the article inherits the value you set for your channel in News Publisher. targetTerritoryCountryCodes: The target country codes required for publishing the updated article. If you don’t specify the targetTerritoryCountryCodes in Create Article Metadata Fields, or in Update Article Metadata Fields, the updated article is visible in all of your channel’s territories. If you specify targetTerritoryCountryCodes in Create Article Metadata Fields and no targetTerritoryCountryCodes is specified in Update Article Metadata Fields, the article is visible in all the countries specified in Create Article Metadata Fields. If you specify targetTerritoryCountryCodes in Create Article Metadata Fields, and a subset of country codes are specified in Update Article Metadata Fields, the article is visible only in the subset of countries specified in Update Article Metadata Fields. Country codes must be in ISO 3166-1 alpha-2 code format; for example, AU for Australia. For a complete list of ISO country codes, see App Store Territories. If you specify a country code that isn’t not defined in your channel’s territories, the  ARTICLE_TERRITORY_NOT_ALLOWED error is generated by the server. If you specify an invalid country code, the server generates an INVALID_ARTICLE_TERRITORY error.

## Mentioned in

Apple News API Release Notes

## See Also

### Articles

- [Create an Article](applenewsapi/post-channels-_channelid_-articles.md)
- [Read Article Information](applenewsapi/get-articles-_articleid_.md)
- [Search Articles in a Channel](applenewsapi/get-channels-_channelid_-articles.md)
- [Search Articles in a Section](applenewsapi/get-sections-_sectionid_-articles.md)
- [Update an Article](applenewsapi/post-articles-_articleid_.md)
- [Delete an Article](applenewsapi/delete-articles-_articleid_.md)
- [Create Article Metadata Fields](applenewsapi/create-article-metadata-fields.md)
- [ArticleLinksRequest](applenewsapi/articlelinksrequest.md)
- [Article](applenewsapi/article.md)
- [ArticleResponse](applenewsapi/articleresponse.md)
- [ArticleLinksResponse](applenewsapi/articlelinksresponse.md)
- [SearchResponse](applenewsapi/searchresponse.md)
- [Meta](applenewsapi/meta.md)
- [Throttling](applenewsapi/throttling.md)