Update a Comment

Update comments in a particular discussion using the discussion ID and comment ID

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

Path Parameters

:space_id
required number

Numeric ID of a space
:discussion_id
required number

The ID of the discussion
:comment_id
required number

The ID for a specific comment in a discussion

Request Body Properties

comment
The Comments Object

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

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

Select a Language

Request

curl "https://mapi.storyblok.com/v1/spaces/606/discussions/2345/comments/456" \ 
  -X PUT \
  -H "Authorization: YOUR_OAUTH_TOKEN" \
  -H "Content-Type: application/json" \
  -d "{\"comment\": {\"message_json\": [{\"type\": \"text\",\"text\": \"Updated Comment \"}]}}"

Request

// Using the Universal JavaScript Client:
// https://github.com/storyblok/storyblok-js-client
Storyblok.put('/spaces/606/discussions/2345/comments/456', {
    "comment": {
        "message_json": [
            {
                "type": "text",
                "text": "Updated 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" =>  "Updated Comment "
            ]
        ]
    ]
];

$client->put('/spaces/606/discussions/2345/comments/456', $payload)->getBody();

Request

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

payload = {
    "comment" =>  {
        "message_json" =>  [
            {
                "type" =>  "text",
                "text" =>  "Updated Comment "
            }
        ]
    }
}

client.put('/spaces/606/discussions/2345/comments/456', payload)

Request

HttpResponse<String> response = Unirest.put("https://mapi.storyblok.com/v1/spaces/606/discussions/2345/comments/456")
  .header("Content-Type", "application/json")
  .header("Authorization", "YOUR_OAUTH_TOKEN")
  .body("{\"comment\": {\"message_json\": [{\"type\": \"text\",\"text\": \"Updated Comment \"}]}}")
  .asString();

Request

var client = new RestClient("https://mapi.storyblok.com/v1/spaces/606/discussions/2345/comments/456");
var request = new RestRequest(Method.PUT);

request.AddHeader("Content-Type", "application/json");
request.AddHeader("Authorization", "YOUR_OAUTH_TOKEN");
request.AddParameter("application/json", "{\"comment\": {\"message_json\": [{\"type\": \"text\",\"text\": \"Updated 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\": \"Updated Comment \"}]}}".data(using: String.Encoding.utf8)!)

let request = NSMutableURLRequest(url: NSURL(string: "https://mapi.storyblok.com/v1/spaces/606/discussions/2345/comments/456")! as URL, cachePolicy: .useProtocolCachePolicy, timeoutInterval: 10.0)
request.method = "PUT"
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/2345/comments/456"

querystring = {}

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

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

print(response.text)

Prev Create a Comment

Next Delete a Comment