LoudVoice API \ Discussions \ Update discussion

Resource/URI - Discussions GET POST PUT DELETE
Discussions /loudvoice/discussions.json List all discussions Create a discussion – –
Discussion /loudvoice/discussions/<discussion_token>.json Read a discussion – Update a discussion Delete a discussion
Discussion messages /loudvoice/comments/<discussion_token>/comments.json Read discussion comments – – –
Resource/URI - Authors GET POST PUT DELETE
Authors /loudvoice/authors.json List all authors Create an author – –
Author /loudvoice/authors/<author_token>.json Read an author – Update an author Delete an author
Resource/URI - Author Sessions GET POST PUT DELETE
Author Sessions /loudvoice/authors/sessions.json List all sessions – Create or update a session –
Author Session /loudvoice/authors/sessions/<session_token>.json – – – Delete a session
Resource/URI - Comments GET POST PUT DELETE
Comments /loudvoice/comments.json List all comments Create a comment – –
Comment /loudvoice/comments/<comment_token>.json Read a comment – Update a comment Delete a comment
Resource/URI - Votes GET POST PUT DELETE
Votes /loudvoice/votes.json List all
votes 		– – –
Vote /loudvoice/votes/comments/<comment_token>/authors/<author_token>.json Read a vote – Cast a vote Delete a vote

Workflow

Request: the code to send to the API

Send an API request to one of these endpoints in order to update a discussion:

PUT /loudvoice/discussion/<discussion_token>.json
PUT /loudvoice/discussions/discussion.json?discussion_reference=<discussion_reference>

The <discussion_token> represents the unique identifier of the discussion. The <discussion_reference> is the unique reference that you optionally specified when you created the discussion.

PUT data to include in the request

{
  "request": {
    "discussion": {
      "discussion_reference": "#discussion_reference#",
      "title": "#title#",
      "url": "#url#",
      "is_closed": #is_closed#,
      "is_trashed": #is_trashed#,
      "date_creation": "#date_creation#"
    }
  }
}
Key Description
discussion_reference
string 		This value is used to indicate which discussion needs to be displayed when embedding LoudVoice using our JavaScript API. The value must be unique amongst your discussions. If left empty, the discussion cannot be embedded using the JavaScript API.
Example: PAGE-124
title
string 		The title of the page where the discussion is displayed.
Example: Shop Item 27
url
string 		The URL of the page where the discussion is displayed.
Example: http://www.example.com/shop/item/25/
is_closed
boolean 		Indicates whether the discussion is closed or not. If a discussion is closed, it will still be visible, but no more comments can be left.
Default : false
is_trashed
string 		Indicates whether the discussion has been trashed or not. Thrashed discussion are not displayed and no comments can be left.
Example : false
date_creation
string, RFC 2822
 Date when the discussion was created.
Example: Wed, 14 Mar 2018 14:19:49 +0100

Result: the code returned by the API

The API will either return a HTTP status code 200 on success or an appropriate message body with further details on the error that occured.

Resultset Example

{
    "response": {
        "request": {
            "date": "Thu, 22 Mar 2018 11:59:08 +0100",
            "resource": "/loudvoice/discussions/eaaf4ebc-f75e-4910-a320-fa4975bb0e65.json",
            "status": {
                "flag": "success",
                "code": 200,
                "info": "Your request has been processed successfully"
            }
        },
        "result": {
            "data": {
                "discussion": {
                    "discussion_token": "eaaf4ebc-f75e-4910-a320-fa4975bb0e65",
                    "discussion_reference": "my-discussion-token",
                    "date_creation": "Thu, 22 Mar 2018 11:39:15 +0100",
                    "title": "my discussion title",
                    "url": "http://example.com/discussion-1",
                    "is_closed": false,
                    "is_trashed": false,
                    "num_comments": 0,
                    "date_last_comment": null,
                    "date_last_update": "Thu, 22 Mar 2018 11:59:08 +0100"
                }
            }
        }
    }
}

User Contributed Notes