Search Storyblok's Documentation
  1. Create a Comment

Create a Comment

This endpoint allows the creation of a comment in a particular discussion using the ID.

https://mapi.storyblok.com/v1/spaces/:space_id/discussions/:discussion_id/comments

Path Parameters

  • :space_id

    required number

    Numeric ID of a space

  • :discussion_id

    required number

    The ID of the discussion

Request Body Properties

  • comment

    The Comments Object
    • message

      null or string

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

    • message_json

      required object

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

      • text

        required string

        The text part

      • type

        required string

        The type

      • attrs

        required object

        Attributes

Response Properties

  • comment

    The Comments Object
    • 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

      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

    • user_id

      number

      User/numeric id of collaborator

    • uuid

      string

      Generated UUID string

Request
curl "https://mapi.storyblok.com/v1/spaces/606/discussions/456/comments" \
  -X POST \
  -H "Content-Type: application/json" \
  -H "Authorization: YOUR_OAUTH_TOKEN" \
  -d "{\"comment\": {\"message_json\": [{\"type\": \"text\",\"text\": \"Hello new comment\"}]}}"
Request
// Using the Universal JavaScript Client:
// https://github.com/storyblok/storyblok-js-client
Storyblok.post('/spaces/606/discussions/456/comments', {
    "comment": {
        "message_json": [
            {
                "type": "text",
                "text": "Hello new comment"
            }
        ]
    }
})
  .then(response => {
    console.log(response)
  }).catch(error => { 
    console.log(error)
  })
Request
$client = new \Storyblok\ManagementClient('YOUR_OAUTH_TOKEN');

$payload = [
    "comment" =>  [
        "message_json" =>  [
            [
                "type" =>  "text",
                "text" =>  "Hello new comment"
            ]
        ]
    ]
];

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

payload = {
    "comment" =>  {
        "message_json" =>  [
            {
                "type" =>  "text",
                "text" =>  "Hello new comment"
            }
        ]
    }
}

client.post('/spaces/606/discussions/456/comments', payload)
Request
HttpResponse<String> response = Unirest.post("https://mapi.storyblok.com/v1/spaces/606/discussions/456/comments")
  .header("Content-Type", "application/json")
  .header("Authorization", "YOUR_OAUTH_TOKEN")
  .body("{\"comment\": {\"message_json\": [{\"type\": \"text\",\"text\": \"Hello new comment\"}]}}")
  .asString();
Request
var client = new RestClient("https://mapi.storyblok.com/v1/spaces/606/discussions/456/comments");
var request = new RestRequest(Method.POST);

request.AddHeader("Content-Type", "application/json");
request.AddHeader("Authorization", "YOUR_OAUTH_TOKEN");
request.AddParameter("application/json", "{\"comment\": {\"message_json\": [{\"type\": \"text\",\"text\": \"Hello new comment\"}]}}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);
Request
import Foundation

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

let postData = NSData(data: "{\"comment\": {\"message_json\": [{\"type\": \"text\",\"text\": \"Hello new comment\"}]}}".data(using: String.Encoding.utf8)!)
let request = NSMutableURLRequest(url: NSURL(string: "https://mapi.storyblok.com/v1/spaces/606/discussions/456/comments")! 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/discussions/456/comments"

querystring = {}

payload = "{\"comment\": {\"message_json\": [{\"type\": \"text\",\"text\": \"Hello new comment\"}]}}"
headers = {
  'Content-Type': "application/json",
  'Authorization': "YOUR_OAUTH_TOKEN"
}

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

print(response.text)