Create a post

POST /api/member/communities/{communityId}/spaces/{spaceId}/posts. Create a post. Headless LMS Posts API reference.

For anyone who can open the space. mode decides the status: draft, scheduled, or on submit published, or pending when the space requires review and you are not staff. 409 when the space has topics and none is given, or a schedule is missing or in the past.

Path Parameters

communityId*string

spaceId*string

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

title*string

Length1 <= length <= 200

body*string

Lengthlength <= 50000

topicId*|

One of the space's topics. Required when the space has topics, else null

Length1 <= length

extra?unknown

Default{}

coverAssetId*|

A finalized image you uploaded through requestMemberUpload

Length1 <= length

mode*string

draft keeps the post to yourself. submit publishes it, or holds it for review when the space requires review and you are not staff. schedule submits it at scheduledAt.

Value in

"draft"
"submit"
"schedule"

scheduledAt*|

When a scheduled post is submitted. Required, and in the future, when mode is schedule; ignored otherwise.

Match

^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$

Formatdate-time

Response Body

`application/json`

curl -X POST "https://example.com/api/member/communities/string/spaces/string/posts" \  -H "Content-Type: application/json" \  -d '{    "title": "string",    "body": "string",    "topicId": "string",    "coverAssetId": "string",    "mode": "draft",    "scheduledAt": "2019-08-24T14:15:22Z"  }'

{  "orgId": "string",  "id": "string",  "communityId": "string",  "spaceId": "string",  "orgUserId": "string",  "topicId": "string",  "title": "string",  "body": "string",  "extra": null,  "coverAssetId": "string",  "status": "draft",  "scheduledAt": "2019-08-24T14:15:22Z",  "publishedAt": "2019-08-24T14:15:22Z",  "removedBy": "string",  "pinned": true,  "commentsClosed": true,  "reactionsEnabled": true,  "createdAt": "2019-08-24T14:15:22Z",  "updatedAt": "2019-08-24T14:15:22Z",  "coverUrl": "string",  "author": {    "id": "string",    "firstName": "string",    "lastName": "string",    "displayName": "string",    "headline": "string",    "image": "string",    "imageAssetId": "string",    "imageUrl": "string",    "role": "owner"  },  "reactions": {    "property1": 0,    "property2": 0  },  "viewerReaction": "string",  "commentCount": 0,  "following": true,  "bookmarked": true}

{  "error": "string",  "message": "string",  "requestId": "string",  "issues": [    {      "path": "string",      "message": "string"    }  ]}

{  "error": "string",  "message": "string",  "requestId": "string"}

{  "error": "string",  "message": "string",  "requestId": "string"}

{  "error": "string",  "message": "string",  "requestId": "string"}

{  "error": "string",  "message": "string",  "requestId": "string"}

{  "error": "string",  "message": "string",  "requestId": "string"}

Path Parameters

Request Body

Response Body

201application/json

400application/json

401application/json

403application/json

404application/json

409application/json

500application/json

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`