PUT /api/topics/:topic_id

update a topic

Success Response Code: 200

Params

Param name Description
topic_id
optional

id of topic to update


Value: Must be a Integer
topic
optional

Value: Must be a Hash
topic[name]
required

name of topic


Value: Must be a String
topic[description]
optional

topic's description


Value: Must be a String
topic[url]
required

url to interact with topic


Value: Must be a String
profile_photo
optional

Value: Must be a Hash
profile_photo[data]
optional

set the profile picture to a file upload from the local file path


Value: Must be a File

Response Fields

topic[id] id of topic Integer
topic[name] name of topic String
topic[description] topic's description String
topic[html_description] topic's description with markdown applied, if applicable String
topic[url] url to interact with topic String
topic[avatars] set of images of various sizes to represent a topic Array<Avatars>

Example Curl Commands

curl -X PUT -v --basic -u "emily@socialcast.com:demo" -H"Content-Type: application/json" "https://demo.socialcast.com/api/topics/reference.json" -d'{"topic":{"description":"Keep this information handy! You might need it."}}'