{"_id":"5695230adcaf0d1700cb86b9","user":"563cc6fa8894d20d00014ea3","editedParams":true,"version":{"_id":"563cc7119799fb0d00047688","__v":17,"project":"563cc7119799fb0d00047685","createdAt":"2015-11-06T15:28:17.683Z","releaseDate":"2015-11-06T15:28:17.683Z","categories":["563cc7129799fb0d00047689","566f37f37ffa002300c3cd5b","56914e9bd47b020d002225ac","5692b19ffe72e00d00e4f0a8","56940bc2d8c04d1700e5adb6","56940bc83e9d080d00f064f0","56951b2dfcb1032d0089df7a","569522aecaa32519009c410c","569523ce562335190016da97","569523fddcaf0d1700cb86bf","56980e4a8560a60d00e2c3c3","569921a41693520d002e1305","5699323b7465970d00650b82","569e6cc4fbee990d0072d927","56a2768a0aefae0d00b7fe66","5862e862b8b7fa23009665b7","592835c7bc8bca0f000cc9ff"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":true,"codename":"Model T","version_clean":"1.0.0","version":"1"},"category":{"_id":"569522aecaa32519009c410c","pages":["569522cfcaa32519009c410f","569522e02e5eb41700901a79","569522f4caa32519009c4112","5695230adcaf0d1700cb86b9"],"project":"563cc7119799fb0d00047685","version":"563cc7119799fb0d00047688","__v":4,"sync":{"url":"","isSync":false},"reference":true,"createdAt":"2016-01-12T15:58:38.926Z","from_sync":false,"order":10,"slug":"settings","title":"Settings"},"editedParams2":true,"__v":10,"parentDoc":null,"project":"563cc7119799fb0d00047685","updates":[],"next":{"pages":[],"description":""},"createdAt":"2016-01-12T16:00:10.202Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[{"status":200,"language":"json","code":"{\n    \"key\": \"watchList\",\n    \"value\": \"[\\\"AAPL\\\",\\\"TSLA\\\",\\\"BAC\\\",\\\"BIDU\\\",\\\"FB\\\",\\\"GOOG\\\",\\\"KO\\\",\\\"MCD\\\",\\\"SAN\\\",\\\"SHW\\\"]\"\n}","name":""}]},"settings":"","examples":{"codes":[{"language":"http","code":"POST /v1/users/02e57c7d-d071-4c63-b491-1194a9939ea5/settings/ HTTP/1.1\nHost: api.drivewealth.io\nAccept: application/json\nContent-Type: application/json\nx-mysolomeo-session-key: 02e57c7d-d071-4c63-b491-1194a9939ea5.2016-01-13T22:34:53.101Z\n\n{\n  \"key\": \"watchList\",\n  \"value\": \"[\\\"AAPL\\\",\\\"TSLA\\\",\\\"BAC\\\",\\\"BIDU\\\",\\\"FB\\\",\\\"GOOG\\\",\\\"KO\\\",\\\"MCD\\\",\\\"SAN\\\",\\\"SHW\\\"]\"\n}"},{"code":"curl -X POST -H \"Accept: application/json\" -H \"Content-Type: application/json\" -H \"x-mysolomeo-session-key: 02e57c7d-d071-4c63-b491-1194a9939ea5.2016-01-13T22:34:53.101Z\" -d '{\n  \"key\": \"watchList\",\n  \"value\": \"[\\\"AAPL\\\",\\\"TSLA\\\",\\\"BAC\\\",\\\"BIDU\\\",\\\"FB\\\",\\\"GOOG\\\",\\\"KO\\\",\\\"MCD\\\",\\\"SAN\\\",\\\"SHW\\\"]\"\n}' 'https://api.drivewealth.io/v1/users/02e57c7d-d071-4c63-b491-1194a9939ea5/settings/'","language":"curl"}]},"method":"post","auth":"required","params":[{"_id":"5696da8b59a6692d003fad2b","ref":"","in":"path","required":true,"desc":"User ID.","default":"02e57c7d-d071-4c63-b491-1194a9939ea5","type":"string","name":"userID"},{"_id":"56991a9e1693520d002e12ec","ref":"","in":"body","required":true,"desc":"Key.","default":"watchList","type":"string","name":"key"},{"_id":"56991a9e1693520d002e12eb","ref":"","in":"body","required":true,"desc":"Persistent free form string.","default":"[\"AAPL\",\"TSLA\",\"BAC\",\"BIDU\",\"FB\",\"GOOG\",\"KO\",\"MCD\",\"SAN\",\"SHW\"]","type":"string","name":"value"}],"url":"/users/:userID/settings"},"isReference":true,"order":2,"body":"[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Response\"\n}\n[/block]\nThe response will be an user setting object. Every user setting object has a default set of attributes.\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Attribute\",\n    \"h-1\": \"Description\",\n    \"0-0\": \"`key`\",\n    \"1-0\": \"`value`\",\n    \"1-1\": \"Free form string paired with `key`.\",\n    \"0-1\": \"Key name and identifier.\"\n  },\n  \"cols\": 2,\n  \"rows\": 2\n}\n[/block]","excerpt":"Save a new user setting key or update an existing one for a user.","slug":"create-settings","type":"endpoint","title":"Create Settings"}

postCreate Settings

Save a new user setting key or update an existing one for a user.

Definition

{{ api_url }}{{ page_api_url }}

Parameters

Path Params

userID:
required
string02e57c7d-d071-4c63-b491-1194a9939ea5
User ID.

Body Params

key:
required
stringwatchList
Key.
value:
required
string["AAPL","TSLA","BAC","BIDU","FB","GOOG","KO","MCD","SAN","SHW"]
Persistent free form string.

Examples


Result Format


Documentation

[block:api-header] { "type": "basic", "title": "Response" } [/block] The response will be an user setting object. Every user setting object has a default set of attributes. [block:parameters] { "data": { "h-0": "Attribute", "h-1": "Description", "0-0": "`key`", "1-0": "`value`", "1-1": "Free form string paired with `key`.", "0-1": "Key name and identifier." }, "cols": 2, "rows": 2 } [/block]

User Information

Try It Out

post
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}