v1

latestOpenAPI 3.0.02026-07-24212113249.1 KB

Posts

Add text post

post/posts/text

Headers

organizationstring required

The URL of the end-user web application

channelstring required

Channel ID

Request body

titlestring required

Post title

descriptionstring required

Description of the post

entitlementsstring[] required

Entitlemetns. A string array of IDs of products.

featuredAtstring date-time required

Date when this post is featured

mediastring required

Media ID

pushNotificationstring date-time required

Push notification

status'DRAFT' | 'PUBLISHED' required

Post status

accessstring required

Access level of this post

kindstring required

Kind

thumbnailstring

Thumbnail image path

inFeedboolean required

Is this post featured in the feed?

categoriesstring required

Category ID

playlistsstring[]

Playlist IDs

slugstring required

Post slug

tagsstring[]

Tag IDs

Example request

{
  "title": "Fancy Photo",
  "description": "Sample audio post",
  "entitlements": [
    "5fbed4f6c4f0c56a9b63ad27"
  ],
  "featuredAt": "2023-02-14T12:58:15.037Z",
  "media": "5fbed4f6c4f0c56a9b63ad27",
  "status": "PUBLISHED",
  "access": "EXCLUSIVE",
  "kind": "paywall",
  "categories": "6232183414b03e621acc03dd",
  "playlists": [
    "619d5fa9cd9a88bf3b38b35b",
    "619d5fa9cd9a88bf3b38b35a"
  ],
  "tags": [
    [
      "623c8838883d6ee6dd949262"
    ]
  ]
}

Response

Text post created.