Object

Update Article Metadata Fields

See the metadata fields for the update article request.

Properties

accessoryText
string

The text to include below the article excerpt in the channel view, such as a byline or category label.

isCandidateToBeFeatured
boolean

A Boolean that indicates whether this article should be considered for featuring in News.

isHidden
boolean

A Boolean that indicates whether the article should be temporarily hidden from display in the News feed.

isPreview
boolean

A Boolean that indicates whether this article should be public (live) or should be a preview that is 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 has not yet been approved to publish articles in Apple News Format, setting isPreview to false results in an ONLY_PREVIEW_ALLOWED error.

isSponsored
boolean

A Boolean that indicates whether this article consists of sponsored content for promotional purposes. Sponsored content must be marked as such; channels that do not follow this policy may be suspended.

When using isSponsored, if you do not want the sponsored article to appear in your channel’s feed, set sections to [] (an empty array).

links
ArticleLinksRequest
ArticleLinks

The section links for the article.

maturityRating
string

A string that indicates the viewing audience for the content. A MATURE rating indicates explicit content that is only appropriate for a specific audience.

revision
string
(Required)

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 would result in data loss.

targetTerritoryCountryCodes
[string]

The target country codes required for publishing the updated article.

If targetTerritoryCountryCodes is not specified in Create Article Metadata Fields, or in Update Article Metadata Fields, the updated article is visible in all of your channel's territories.

If targetTerritoryCountryCodes is specified 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 targetTerritoryCountryCodes is specified 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 is not defined in your channel's territories, the ARTICLE_TERRITORY_NOT_ALLOWED error is generated. If you specify an invalid country code, the INVALID_ARTICLE_TERRITORY error is generated.

See Also

Articles

Create an Article

Publish an article to your channel.

Read Article Information

Retrieve information about an article, such as the revision number and maturity rating.

Search Articles in a Channel

See a list of all articles in a channel that match the specified search criteria.

Search Articles in a Section

See a list of all articles in a section that match the specified search criteria.

Update an Article

Update an existing article in your channel.

Delete an Article

Delete the specified article from your channel.

object Create Article Metadata Fields

See the optional metadata fields for the create article request.

object ArticleLinksRequest

See the required field for the create article request.

object Article

See the fields returned by the article endpoints.

object ArticleResponse

See which objects make up the create article, read article, and update article responses.

object ArticleLinksResponse

See the links returned by the article endpoints.

object SearchResponse

See the fields returned by the search article endpoints.

object Meta

See the object that wraps the throttling information that's returned for the create article and read article endpoints.

object Throttling

See the object that wraps the throttling information that's returned for the create article and update article endpoints.