1. Create a Discussion

Create a Discussion

/spaces/space_id/stories/story_id/discussions

Path Parameters

  • :space_id

    required number

    Numeric id of a space

  • :story_id

    required number

    Id of the story

Request Body Properties

  • discussions

    The Discussions Object
    • id

      number

      The numeric ID

    • title

      string

      Title of the discussion field

    • block_uid

      string

      id of discussion block component

    • solved_at

      string

      The time a discussion is resolved. (Format: YYYY-mm-dd HH:MM)

    • fieldname

      string

      Technical name of the discussion field

    • component

      string

      The component of the discussion

    • lang

      string

      Language code of the current language (can be requested with the language API parameter)

    • last_comment

      object

      The last_comment is an object in the discussion that contains the user_id, id, message and message_json

      • user_id

        number

        User/numeric id of collaborator

      • id

        number

        The numeric ID

      • message

        null or string

        The message of a comment, with the datatype of null or a string.

      • message_json

        object

        An array with text and type properties of type strings.

      • created_at

        string

        Creation date (Format: yyyy-MM-dd'T'HH:mm:ssZ)

      • updated_at

        string

        Latest update date (Format: yyyy-MM-dd'T'HH:mm:ssZ)

Response Properties

  • discussions

    The Discussions Object
    • id

      number

      The numeric ID

    • title

      string

      Title of the discussion field

    • block_uid

      string

      id of discussion block component

    • solved_at

      string

      The time a discussion is resolved. (Format: YYYY-mm-dd HH:MM)

    • fieldname

      string

      Technical name of the discussion field

    • component

      string

      The component of the discussion

    • lang

      string

      Language code of the current language (can be requested with the language API parameter)

    • last_comment

      object

      The last_comment is an object in the discussion that contains the user_id, id, message and message_json

      • user_id

        number

        User/numeric id of collaborator

      • id

        number

        The numeric ID

      • message

        null or string

        The message of a comment, with the datatype of null or a string.

      • message_json

        object

        An array with text and type properties of type strings.

      • created_at

        string

        Creation date (Format: yyyy-MM-dd'T'HH:mm:ssZ)

      • updated_at

        string

        Latest update date (Format: yyyy-MM-dd'T'HH:mm:ssZ)

Request
curl "https://mapi.storyblok.com/v1/spaces/606/stories/12367/discussions" \
  -X POST \
  -H "Content-Type: application/json" \
  -H "Authorization: YOUR_OAUTH_TOKEN" \
  -d "{\"discussion\": {\"comment\": {\"message_json\": [{\"type\": \"text\",\"text\": \"this is a comment \"},{\"type\": \"mention\",\"attrs\": {\"id\": 99734,\"label\": \"Fortune Ikechi\"}}]},\"lang\": \"default\",\"title\": \"Name\",\"fieldname\": \"name\",\"block_uid\": \"f7bd92e3-b309-4441-a8a0-654e499fefc8\",\"component\": \"feature\"}}"
Request
// Using the Universal JavaScript Client:
// https://github.com/storyblok/storyblok-js-client
Storyblok.post('/spaces/606/stories/12367/discussions', {
  "discussion": {
    "comment": {
      "message_json": [
        {
          "type": "text",
          "text": "this is a comment "
        },
        {
          "type": "mention",
          "attrs": {
            "id": 99734,
            "label": "Fortune Ikechi"
          }
        }
      ]
    },
    "lang": "default",
    "title": "Name",
    "fieldname": "name",
    "block_uid": "f7bd92e3-b309-4441-a8a0-654e499fefc8",
    "component": "feature"
  }
})
  .then(response => {
    console.log(response)
  }).catch(error => { 
    console.log(error)
  })
Request
$client = new \Storyblok\Client('YOUR_STORYBLOK_SPACE_ACCESS_TOKEN');

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

$client->post('/spaces/606/stories/12367/discussions', $payload)->getBody();
Request
require 'storyblok'
client = Storyblok::Client.new(oauth_token: 'YOUR_OAUTH_TOKEN')

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

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

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

let headers = [
  "Content-Type": "application/json",
  "Authorization": "YOUR_OAUTH_TOKEN"
]

let postData = NSData(data: "{\"discussion\": {\"comment\": {\"message_json\": [{\"type\": \"text\",\"text\": \"this is a comment \"},{\"type\": \"mention\",\"attrs\": {\"id\": 99734,\"label\": \"Fortune Ikechi\"}}]},\"lang\": \"default\",\"title\": \"Name\",\"fieldname\": \"name\",\"block_uid\": \"f7bd92e3-b309-4441-a8a0-654e499fefc8\",\"component\": \"feature\"}}".data(using: String.Encoding.utf8)!)
let request = NSMutableURLRequest(url: NSURL(string: "https://mapi.storyblok.com/v1/spaces/606/stories/12367/discussions")! as URL, cachePolicy: .useProtocolCachePolicy, timeoutInterval: 10.0)

request.method = "POST"
request.allHTTPHeaderFields = headers
request.httpBody = postData as Data

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
Request
import requests

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

querystring = {}

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

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

print(response.text)

You will receive a discussions object as a response.