v1

latestOpenAPI 3.0.02026-07-24212113249.1 KB

Posts

Update text post

patch/posts/text/{id}

Path parameters

idstring required

Headers

organizationstring required

The URL of the end-user web application

Request body

accessstring

Access level determines who can access this post

descriptionstring

Post description

entitlementsstring[]

String array containing IDs of products

featuredAtstring date-time

Date the poost was featured

mediastring

Media ID

pushNotificationstring date-time

Push notification

status'DRAFT' | 'PUBLISHED'

The status of the post. Enum

titlestring

Post title

kindstring

Kind

inFeedboolean

Is this post featured in the feed?

allowCommentsboolean

Are comments allowed for this post?

categoriesstring[]

Category IDs

tagsstring[]

Tag IDs

Example request

{
  "access": "EXCLUSIVE",
  "description": "<p>lorem ipsum dolor sit amet...</p>",
  "entitlements": [
    "5fbed4f6c4f0c56a9b63ad27"
  ],
  "featuredAt": "2023-02-14T12:58:15.043Z",
  "media": "5fbed4f6c4f0c56a9b63ad27",
  "status": "PUBLISHED",
  "title": "Fancy Photo",
  "kind": "paywall",
  "allowComments": true,
  "categories": [
    [
      "6238e25dc5598261ab9eb60e"
    ]
  ],
  "tags": [
    [
      "623c8838883d6ee6dd949262"
    ]
  ]
}

Response

Text post updated.