LoudVoice API \ Authors \ Update author

Resource/URI - Discussions GET POST PUT DELETE
Discussions /loudvoice/discussions.json List all discussions Create a discussion
Discussion /loudvoice/discussions/<discussion_token>.json /loudvoice/discussions/discussion.json?
discussion_reference=<discussion_reference>
Read a discussion Update a discussion Delete a discussion
Discussion messages /loudvoice/comments/<discussion_token>/comments.json /loudvoice/discussions/discussion/comments.json?
discussion_reference=<discussion_reference>
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 /loudvoice/authors/author.json?
author_reference=<author_reference>
Read an author Update an author Delete an author
Resource/URI - Author Sessions GET POST PUT DELETE
Author Sessions /loudvoice/authors/sessions.json Create/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 comment
Comment /loudvoice/comments/<comment_token>.json Read a comment Update comment Delete a comment

Workflow

Request: the code to send to the API

Send a PUT request with the data below to the endpoint /loudvoice/authors/<author_token>.json to update an author. The <author_token> has to be replaced by the unique token of an existing author.

You can also update the author using it's reference and the following endpoint: /loudvoice/authors/author.json?author_reference=<author_reference>.

Only the fields specified in the request are updated, the other fields remain unchanged.

PUT data to include in the request

{
        "request":{
            "author":{
              "author_reference": "#author_reference#",
              "name": "#name#",              
              "email": "#email#",
              "description": "#description#",
              "picture_url": "#picture_url#",
              "website_url": "#website_url#"              
        }
    }
    
Node Description
author_reference
string
Your custom reference for this author, e.g. the unique id of the user in your system. The value must be unique amongst all authors.
Example : 123456
name
string
Author name
Example: John Doe
email
string
Author email address
Example: john.doe@example.com
description
string, email
Author description
Example: A writer by day and a reader by night
picture_url
string, uri
The fully qualified URL of the author's avatar
Example: https://graph.facebook.com/12789/picture?type=small
website_url
string, uri
The fully qualified URL of the author's website
Example: http://www.example.com/

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 14:01:13 +0100",
            "resource": "/loudvoice/authors/39931bb2-15a8-488b-bcac-dccd9952ae90.json",
            "status": {
                "flag": "success",
                "code": 200,
                "info": "Your request has been processed successfully"
            }
        },
        "result": {
            "data": {
                "author": {
                    "author_token": "39931bb2-15a8-488b-bcac-dccd9952ae90",
                    "author_reference": "ref",
                    "date_creation": "Thu, 22 Mar 2018 13:59:53 +0100",
                    "name": "name",
                    "email": "email_address",
                    "description": "desc",
                    "picture_url": "image",
                    "website_url": "web",
                    "num_comments": "0",
                    "date_last_comment": null,
                    "date_last_update": "Thu, 22 Mar 2018 14:01:13 +0100"
                }
            }
        }
    }
}
        

User Contributed Notes