Update Article - Placewise API

Request

Path Params

integer

required

ID of the record

>= 1

Example:

3004

Query Params

dry_run

boolean

optional

When true, the request doesn't persist record on success

Header Params

Content-Type

enum<string>

required

Details

Allowed value:

application/json

Default:

application/json

X-User-Agent

string

required

Arbitrary identifier of your client. Details

Default:

X-Product-Name

string

required

API Product for API context. Details

Default:

X-Loyalty-Club-Slug

string

required

LoyaltyClub for API context. Details

Default:

X-Customer

string

required

Customer for API context. Details

Default:

Authorization

string

required

Member or User Authorization.

Default:

Bearer {{_OAUTH_TOKEN}}

X-Client-Authorization

string

optional

Default:

Body Params application/json

article

object (Article)

required

locales

required

products

required

status

enum<string>

required

Determines visibility in Public API

Allowed values:

draftpublishedunpublished

Example:

published

visible_since

required

visible_until

required

visible_in_list

boolean

required

Should record be returned on lists of CMS Public API

Default:

true

Example:

true

topic_relevant_until

required

Date until the topic of article is "relevant" to users

sorting_priority

integer

required

Priority of the record during sorting in CMS Public API. Currently read-only.

Example:

title

required

slug

required

teaser

required

body

required

headline

required

published_at

required

Article's publication date presented in CMS Public API. By default, visible_since is returned

image

required

Must be uploaded as a file of type: cms_article_image

url

string

required

Address of the entity page on website

Example:

path/to/:id

prototype_id

required

ContentPrototype that serves as a master for this record. Manually it can be only unset

external_master

string

required

When present, the record is being synced from given external source

Example:

scraper

us_legacy_data

object | null

required

tag_ids

required

archived_at

required

Example

{
  "article": {
    "locales": [
      "en"
    ],
    "products": [
      "website"
    ],
    "status": "draft",
    "visible_since": "2022-11-09T16:25:58.099512Z",
    "visible_until": "2022-11-15T16:25:58.099512Z",
    "visible_in_list": true,
    "topic_relevant_until": "2022-11-09T16:25:58.099512Z",
    "sorting_priority": 0,
    "title": {
      "en": "Text"
    },
    "slug": {
      "en": "Text"
    },
    "teaser": {
      "en": "Text"
    },
    "body": {
      "en": "Text"
    },
    "headline": {
      "en": "Text"
    },
    "published_at": "2022-11-09T16:25:58.099512Z",
    "url": "path/to/:id",
    "external_master": "scraper",
    "us_legacy_data": {},
    "tag_ids": [
      1
    ]
  }
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Responses

🟢200Success

application/json

Body

article

object (Article)

required

integer <uint64>

read-onlyrequired

Example:

customer_id

integer <uint64>

read-onlyrequired

Customer the record is assigned to

Example:

447

locales

required

products

required

status

enum<string>

required

Determines visibility in Public API

Allowed values:

draftpublishedunpublished

Example:

published

visible_since

required

visible_until

required

visible_in_list

boolean

required

Should record be returned on lists of CMS Public API

Default:

true

Example:

true

topic_relevant_until

required

Date until the topic of article is "relevant" to users

sorting_priority

integer

required

Priority of the record during sorting in CMS Public API. Currently read-only.

Example:

title

required

slug

required

teaser

required

body

required

headline

required

published_at

required

Article's publication date presented in CMS Public API. By default, visible_since is returned

image

required

Must be uploaded as a file of type: cms_article_image

url

string

required

Address of the entity page on website

Example:

path/to/:id

prototype_id

required

ContentPrototype that serves as a master for this record. Manually it can be only unset

publication_status

enum<string>

read-onlyrequired

Visibility status of the record in CMS Public API that takes into the consideration status, visible_since and visible_until dates

Allowed values:

publisheddraftexpiredscheduled

Example:

published

external_master

string

required

When present, the record is being synced from given external source

Example:

scraper

us_legacy_data

object | null

required

tag_ids

required

created_at

string <date-time>

read-onlyrequired

Time of record creation

Example:

2022-11-05T16:25:58.099512Z

updated_at

string <date-time>

read-onlyrequired

Time of the last record update

Example:

2022-11-15T16:25:58.099512Z

archived_at

required

Example

{
  "article": {
    "id": 1,
    "customer_id": 447,
    "locales": [
      "en"
    ],
    "products": [
      "website"
    ],
    "status": "draft",
    "visible_since": "2022-11-09T16:25:58.099512Z",
    "visible_until": "2022-11-15T16:25:58.099512Z",
    "visible_in_list": true,
    "topic_relevant_until": "2022-11-09T16:25:58.099512Z",
    "sorting_priority": 0,
    "title": {
      "en": "Text"
    },
    "slug": {
      "en": "Text"
    },
    "teaser": {
      "en": "Text"
    },
    "body": {
      "en": "Text"
    },
    "headline": {
      "en": "Text"
    },
    "published_at": "2022-11-09T16:25:58.099512Z",
    "image": {
      "url": "https://example.com/image.png",
      "identifier": "1",
      "mime_type": "image/jpeg",
      "created_at": "2022-11-09T15:46:00.252860Z",
      "updated_at": "2022-11-09T15:46:00.252860Z",
      "image_details": {
        "width": 1,
        "height": 1
      }
    },
    "url": "path/to/:id",
    "prototype_id": 1,
    "publication_status": "published",
    "external_master": "scraper",
    "us_legacy_data": {},
    "tag_ids": [
      1
    ],
    "created_at": "2022-11-05T16:25:58.099512Z",
    "updated_at": "2022-11-15T16:25:58.099512Z",
    "archived_at": "2022-11-15T16:25:58.099512Z"
  }
}

🟠404Record Not Found

🟠422Invalid Parameters