Create a Discussion

This endpoint creates a new discussion.

https://mapi.storyblok.com/v1/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

comment
object

The comment is an object in the discussion that contains a message_json array object. Required
- message_json
  object
  
  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
string

Title of the discussion field. Required
fieldname
string

Technical name of the discussion field
block_uid
string

The ID of discussion block. Required
component
string

The component/block name to which the discussion belongs to

Response Properties

discussion
The Discussions Object

The discussions object
- id
  number
  
  The numeric ID of the discussion
- title
  string
  
  Title of the discussion field
- block_uid
  string
  
  The ID of discussion block
- fieldname
  string
  
  Technical name of the discussion field
- solved_at
  string
  
  The time a discussion is resolved. (Format: YYYY-mm-dd HH:MM)
- component
  string
  
  The component/block name to which the discussion belongs to
- lang
  string
  
  Language code in which the discussion is present.
- uuid
  string
  
  Generated UUID string
- last_comment
  object
  
  The last_comment is an object that contains the details about the last comment of that discussion.
  - id
    number
    
    The numeric ID
  - 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)
  - message
    null or string
    
    The message of a comment, with the datatype of null or a string.
  - message_json
    object
    
    An array with properties of the message such as type , text and attrs.
  - user_id
    number
    
    User/numeric id of collaborator
  - uuid
    string
    
    Generated UUID string

Select a Language

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\ManagementClient('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)->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.

Prev Retrieve Idea Discussions Comments

Next Resolve a Discussion