Create a Discussion

POST

https://mapi.storyblok.com/v1/spaces/space_id/stories/story_id/discussions

This endpoint creates a new discussion.

Path parameters

• :space_id required number

  Numeric ID of a space

• :story_id required number

  ID of the story

Request body properties

• comment required object

  The comment is an object in the discussion that contains a message_json array object.

  Show message_json properties

  The message_json property is an array containing JSON objects representing the comments’ messages.

  • text string

    The text part

  • type string

    The type

  • attrs object

    Attributes

• lang string

  Language code to add the discussion to.

• title required string

  Title of the discussion field.

• fieldname string

  Technical name of the discussion field

• block_uid required string

  The ID of discussion block.

• component string

  The component/block name to which the discussion belongs to

Response properties

• discussion The Discussions Object

  The discussions object

Examples

cURL

curl "https://mapi.storyblok.com/v1/spaces/288868932106293/stories/12367/discussions" \
  -X POST \
  -H "Authorization: YOUR_PERSONAL_ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d "{\"discussion\":{\"block_uid\":\"f7bd92e3-b309-4441-a8a0-654e499fefc8\",\"comment\":{\"message_json\":[{\"text\":\"this is a comment \",\"type\":\"text\"},{\"attrs\":{\"id\":99734,\"label\":\"Fortune Ikechi\"},\"type\":\"mention\"}]},\"component\":\"feature\",\"fieldname\":\"name\",\"lang\":\"default\",\"title\":\"Name\"}}"

JS

// storyblok-js-client@>=7, node@>=18
import Storyblok from "storyblok-js-client";

const storyblok = new Storyblok({
  oauthToken: "YOUR_PERSONAL_ACCESS_TOKEN",
});

try {
  const response = await storyblok.post('spaces/288868932106293/stories/12367/discussions', {
    "discussion": {
      "block_uid": "f7bd92e3-b309-4441-a8a0-654e499fefc8",
      "comment": {
        "message_json": [
          {
            "text": "this is a comment ",
            "type": "text"
          },
          {
            "attrs": {
              "id": 99734,
              "label": "Fortune Ikechi"
            },
            "type": "mention"
          }
        ]
      },
      "component": "feature",
      "fieldname": "name",
      "lang": "default",
      "title": "Name"
    }
  })
  console.log({ response })
} catch (error) {
  console.log(error)
}

PHP

$client = new \Storyblok\ManagementClient('YOUR_PERSONAL_ACCESS_TOKEN');

$payload = ["discussion" => ["block_uid" => "f7bd92e3-b309-4441-a8a0-654e499fefc8","comment" => ["message_json" => [["text" => "this is a comment ","type" => "text"],["attrs" => ["id" => 99734,"label" => "Fortune Ikechi"],"type" => "mention"]]],"component" => "feature","fieldname" => "name","lang" => "default","title" => "Name"]];

$client->post('spaces/288868932106293/stories/12367/discussions', $payload)->getBody();

Java

HttpResponse<String> response = Unirest.post("https://mapi.storyblok.com/v1/spaces/288868932106293/stories/12367/discussions")
  .header("Content-Type", "application/json")
  .header("Authorization", "YOUR_PERSONAL_ACCESS_TOKEN")
  .body({"discussion":{"block_uid":"f7bd92e3-b309-4441-a8a0-654e499fefc8","comment":{"message_json":[{"text":"this is a comment ","type":"text"},{"attrs":{"id":99734,"label":"Fortune Ikechi"},"type":"mention"}]},"component":"feature","fieldname":"name","lang":"default","title":"Name"}})
  .asString();

C#

var client = new RestClient("https://mapi.storyblok.com/v1/spaces/288868932106293/stories/12367/discussions");
var request = new RestRequest(Method.POST);

request.AddHeader("Content-Type", "application/json");
request.AddHeader("Authorization", "YOUR_PERSONAL_ACCESS_TOKEN");
request.AddParameter("application/json", "{\"discussion\":{\"block_uid\":\"f7bd92e3-b309-4441-a8a0-654e499fefc8\",\"comment\":{\"message_json\":[{\"text\":\"this is a comment \",\"type\":\"text\"},{\"attrs\":{\"id\":99734,\"label\":\"Fortune Ikechi\"},\"type\":\"mention\"}]},\"component\":\"feature\",\"fieldname\":\"name\",\"lang\":\"default\",\"title\":\"Name\"}}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);

Python

import requests

url = "https://mapi.storyblok.com/v1/spaces/288868932106293/stories/12367/discussions"

querystring = {}

payload = {"discussion":{"block_uid":"f7bd92e3-b309-4441-a8a0-654e499fefc8","comment":{"message_json":[{"text":"this is a comment ","type":"text"},{"attrs":{"id":99734,"label":"Fortune Ikechi"},"type":"mention"}]},"component":"feature","fieldname":"name","lang":"default","title":"Name"}}
headers = {
  'Content-Type': "application/json",
  'Authorization': "YOUR_PERSONAL_ACCESS_TOKEN"
}

response = requests.request("POST", url, data=payload, headers=headers, params=querystring)

print(response.text)

Ruby

require 'storyblok'
client = Storyblok::Client.new(oauth_token: 'YOUR_PERSONAL_ACCESS_TOKEN')

payload = {"discussion" => {"block_uid" => "f7bd92e3-b309-4441-a8a0-654e499fefc8","comment" => {"message_json" => [{"text" => "this is a comment ","type" => "text"},{"attrs" => {"id" => 99734,"label" => "Fortune Ikechi"},"type" => "mention"}]},"component" => "feature","fieldname" => "name","lang" => "default","title" => "Name"}}

client.post('spaces/288868932106293/stories/12367/discussions', payload)

Swift

let storyblok = URLSession(storyblok: .mapi(accessToken: .personal("YOUR_PERSONAL_ACCESS_TOKEN")))
var request = URLRequest(storyblok: storyblok, path: "spaces/288868932106293/stories/12367/discussions")
request.httpMethod = "POST"
request.httpBody = try JSONSerialization.data(withJSONObject: [
    "discussion": [
        "block_uid": "f7bd92e3-b309-4441-a8a0-654e499fefc8",
        "comment": [
            "message_json": [
                [
                    "text": "this is a comment ",
                    "type": "text",
                ],
                [
                    "attrs": [
                        "id": 99734,
                        "label": "Fortune Ikechi",
                    ],
                    "type": "mention",
                ],
            ],
        ],
        "component": "feature",
        "fieldname": "name",
        "lang": "default",
        "title": "Name",
    ],
])
let (data, _) = try await storyblok.data(for: request)
print(try JSONSerialization.jsonObject(with: data))

Kotlin

val client = HttpClient {
    install(Storyblok(MAPI)) {
        accessToken = Personal("YOUR_PERSONAL_ACCESS_TOKEN")
    }
}

val response = client.post("spaces/288868932106293/stories/12367/discussions") {
    setBody(buildJsonObject {
        putJsonObject("discussion") {
            put("block_uid", "f7bd92e3-b309-4441-a8a0-654e499fefc8")
            putJsonObject("comment") {
                putJsonArray("message_json") {
                    addJsonObject {
                        put("text", "this is a comment ")
                        put("type", "text")
                    }
                    addJsonObject {
                        putJsonObject("attrs") {
                            put("id", 99734)
                            put("label", "Fortune Ikechi")
                        }
                        put("type", "mention")
                    }
                }
            }
            put("component", "feature")
            put("fieldname", "name")
            put("lang", "default")
            put("title", "Name")
        }
    })
}

println(response.body<JsonElement>())

You will receive a discussions object as a response.