/articles/{id}

patch https://example.com/articles/{id}

Update an article record

Path Params

int64

required

ID of the article to update

Body Params

Update an Article.

title

string

required

The title of the content. It should always be provided

subtitle

string | null

strapline

string | null

footer

string | null

Content footer.

body

array of objects

body

category_id

string

required

published_at

string | null

published_until

string | null

status

string | null

Slug of a valid status for this content type

type

string | null

Valid slug of a type for this content type

live

boolean

important

boolean

comment_policy_id

string | null

ID of a valid comment policy for this content type

origin_id

string | null

ID of a valid origin for this content type

run_ads

boolean

authors

array of strings

Array of author IDs. If no author is provided upon content creation, we select the default one (if available)

authors

custom_author

string | null

A field for one-time author

image_id

string | null

Use main_media object to relate images to content

image_description

string | null

Use main_media object to relate images to content

additional_categories

array of strings

additional_categories

is_adult_content

boolean

is_sensitive_content

boolean

betting_content

boolean

<<<<<<< HEAD

generic

object

JSON field with no validation. Should be used for migrated/unsupported content that is no longer needed but needs to be available for legacy reasons.

external_url

string | null

A URL that is going to be used for redirects. If you want a piece of content to take you to a specific page, you should put that address here.

canonical_url

string | null

public_url_desktop

string | null

public_url_mobile

string | null

public_url_amp

string | null

urls

object

seo

object

main_media

object

published_regions

array of strings

published_regions

published_channels

array of strings

An array of valid IDs for Distribution Channels

published_channels

language

string | null

Language of the resource. Required if the project is multi-lingual, optional otherwise. Has to be project supported language.

translation_group_id

string | null

The ID of an existing translation group

Response

Response body

object

data

object

string

entity_type

string

title

string

subtitle

string | null

strapline

string | null

footer

string | null

body

array of objects

Body is composed as Array of Json objects generated by the 'Blocky' component from the CMS

body

object

published_at

string | null

published_until

string | null

status

string | null

type

string | null

live

boolean

important

boolean

run_ads

boolean

betting_content

boolean

custom_author

string | null

comments

object

origin

object

adult_content

boolean

sensitive_content

boolean

generic

object

Has additional fields

urls

object

seo

object

created_at

string | null

updated_at

string | null

language

string | null

created_by

object

category

object

additional_categories

array of objects

additional_categories

object

string

entity_type

string | null

title

string

description

string | null

active

boolean

parent_id

string | null

weight

integer | null

generic

array of objects

generic

object

seo

object

urls

object

created_at

string | null

updated_at

string | null

subs

array of objects

List of sub categories

subs

object

main_media

array of objects

main_media

object

resource_id

string | null

resource_type

string | null

image video gallery widget embed

resource_subtype

string | null

default main_image vertical_image eye_catcher odds compare_odds player_profile team_profile standings match fixtures top_scorers team_players

provider

string | null

description

string | null

data

object

Free-form JSON object/array, containing resource's configuration

Has additional fields

created_by

object

published_regions

array of objects

published_regions

object

string

slug

string

name

string

default

boolean

description

string | null

created_at

string | null

updated_at

string | null

created_by

object

published_channels

array of objects

published_channels

object

string

slug

string

name

string

default

boolean

description

string | null

created_at

string | null

updated_at

string | null

created_by

object

authors

array of objects

authors

object

string

entity_type

string | null

name

string

bio

string | null

active

boolean

default

boolean

avatar_url

string | null

generic

object

Has additional fields

created_at

string | null

updated_at

string | null

weight

integer

seo

object

created_by

object

main_media

array of objects

main_media

object

resource_id

string | null

resource_type

string | null

image video gallery widget embed

resource_subtype

string | null

default main_image vertical_image eye_catcher odds compare_odds player_profile team_profile standings match fixtures top_scorers team_players

provider

string | null

description

string | null

data

object

Free-form JSON object/array, containing resource's configuration

Has additional fields

translation_group

object

sports_related

object

Language

Credentials


xxxxxxxxxx
1
curl --request PATCH \
2
     --url https://example.com/articles/id \
3
     --header 'accept: application/json' \
4
     --header 'content-type: application/json'

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200The updated article data