---
title: Article
framework: applenewsapi
role: symbol
role_heading: Object
path: applenewsapi/article
---

# Article

See the fields the article endpoints returned.

## Declaration

```data
object Article
```

## Properties

accessoryText: Text that appears alongside article headlines — author name, channel name, subtitle, and so on. Maximum length: 100 characters. Default value: metadata.authors from the Apple News Format article. createdAt: The date and time the article was created. document: The content of the article, as an Apple News Format document. id: The unique identifier of the article. isCandidateToBeFeatured: A Boolean value that indicates whether this article should be considered for featuring in Apple News. Default value: false isPreview: A Boolean value 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 been approved to publish articles in Apple News Format, setting isPreview to false results in an ONLY_PREVIEW_ALLOWED error. Default value: true if your channel hasn’t yet been approved to publish articles in Apple News Format; false if your channel has been approved. isSponsored: A Boolean value 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). Default value: false links: The URL of the channel in which the article appears. maturityRating: A string value that indicates the viewing audience for the content. The types of audiences or ratings are KIDS, MATURE, and GENERAL, or null if unspecified. A MATURE rating indicates explicit content that’s only appropriate for a specific audience. Default value: null modifiedAt: The date and time this article was last modified. revision: The current revision token for the article. You must send the latest revision when issuing a request to Update an 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. Required: Yes shareUrl: The URL to the article within the News app. state: The current state of the article, which can be one of the following: PROCESSING: The article has been published and is processing. LIVE: The article has been published, has finished processing, and is visible in the News app. PROCESSING_UPDATE: A previous version of the article is visible in the News app, and an update is currently in processing. TAKEN_DOWN: The article was previously visible in the News app, but was taken down. FAILED_PROCESSING: The article failed during processing and isn’t visible in the News app. FAILED_PROCESSING_UPDATE: A previous version of the article is visible in the News app, but an update failed during processing. DUPLICATE. The article is a duplicate of another article and isn’t visible in the News app. title: The title of the article, as specified in the Apple News Format document. type: The article. warnings: A list of warning messages indicating nonfatal problems with the article.

## Mentioned in

Publishing an Article

## Relationships

### Inherited By

- [ArticleResponse](applenewsapi/articleresponse.md)

## 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)
- [Update Article Metadata Fields](applenewsapi/update-article-metadata-fields.md)
- [ArticleResponse](applenewsapi/articleresponse.md)
- [ArticleLinksResponse](applenewsapi/articlelinksresponse.md)
- [SearchResponse](applenewsapi/searchresponse.md)
- [Meta](applenewsapi/meta.md)
- [Throttling](applenewsapi/throttling.md)