{"_id":"56c41d602e75e0170098605c","category":{"_id":"56c4184754b6030d00ec29a1","__v":5,"version":"56bc8e689afb8b0d00d62dd2","pages":["56c41d423d30210d00ea851d","56c41d4954b6030d00ec29ae","56c41d602e75e0170098605c","56c41d684040602b0064ceaa","56c41d6f106c12170020dba8"],"project":"56bc8e679afb8b0d00d62dcf","sync":{"url":"","isSync":false},"reference":true,"createdAt":"2016-02-17T06:50:47.963Z","from_sync":false,"order":5,"slug":"messages","title":"Messages"},"parentDoc":null,"user":"56b98db7bb36440d0001f492","version":{"_id":"56bc8e689afb8b0d00d62dd2","project":"56bc8e679afb8b0d00d62dcf","__v":18,"createdAt":"2016-02-11T13:36:40.146Z","releaseDate":"2016-02-11T13:36:40.146Z","categories":["56bc8e689afb8b0d00d62dd3","56c3c837bc41330d009f25ed","56c3c83e521f350d00d348eb","56c3c8452d97560d00e23cd8","56c3c85234df460d00c2beb8","56c4180d70187b17005f43b4","56c418162d97560d00e23cf6","56c4181cc4796b0d007ef039","56c4182370187b17005f43b5","56c418292e75e01700986052","56c4183328bd680d005e7ac6","56c4183bbb64720d00552b88","56c418414040602b0064cea0","56c4184754b6030d00ec29a1","56c4184c28bd680d005e7ac7","56c4185370187b17005f43b6","56c4185b6063071700500cfc","582a98b6f8c0a0190053d7a5"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":true,"codename":"","version_clean":"1.0.0","version":"1.0"},"githubsync":"","__v":4,"project":"56bc8e679afb8b0d00d62dcf","updates":[],"next":{"pages":[],"description":""},"createdAt":"2016-02-17T07:12:32.661Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"settings":"","results":{"codes":[]},"auth":"required","params":[],"url":""},"isReference":false,"order":2,"body":"[block:api-header]\n{\n  \"type\": \"patch\",\n  \"title\": \"/messages/{id}\"\n}\n[/block]\nUpdates the \"isNew\" flag for a message to indicate that the message has been read.\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"var options = {\\n\\tisNew: false\\n};\\n\\nBuddy.patch('/messages/my_id',\\n\\t\\toptions,\\n\\t\\tfunction(err, result) {\\n\\t\\t\\t \\n\\t\\t\\tif (result.success) {\\n\\t\\t\\t\\t// Do something with the result!\\n\\t\\t\\t} else { \\n\\t\\t\\t\\t// Otherwise log the error\\n\\t\\t\\t\\tconsole.log(err); \\n\\t\\t\\t} \\n\\t\\t}\\n\\t);\",\n      \"language\": \"javascript\"\n    },\n    {\n      \"code\": \"NSDictionary *params = :::at:::{\\n\\t\\t\\[email protected]\\\"isNew\\\": false\\n\\t\\t};\\n\\n[Buddy PATCH:@\\\"/messages/my_id\\\" parameters:params class:[BPMessage class] callback:^(id obj, NSError *error) {\\n\\t// Your callback code here\\n}];\",\n      \"language\": \"objectivec\",\n      \"name\": \"iOS\"\n    },\n    {\n      \"code\": \"Map<String, Object> parameters = new HashMap<String, Object>();\\nparameters.put(\\\"isNew\\\", false);\\n\\nBuddy.<Message>patch(\\\"/messages/my_id\\\", parameters, new BuddyCallback<Message>(Message.class) {\\n\\[email protected]\\n\\tpublic void completed(BuddyResult<Message> result) {\\n\\t\\t// Your callback code here\\n\\t}\\n});\",\n      \"language\": \"java\",\n      \"name\": \"Android\"\n    },\n    {\n      \"code\": \"var options = new {\\n\\t\\t\\tisNew = false\\n\\t\\t};\\n\\nvar result = await Buddy.PatchAsync<Message>(\\\"/messages/my_id\\\", options);\",\n      \"language\": \"csharp\",\n      \"name\": \".NET\"\n    }\n  ],\n  \"sidebar\": true\n}\n[/block]\n###Path Parameters\n\nThese parameters should be specified as part of the HTTP path.\n[block:parameters]\n{\n  \"data\": {\n    \"0-0\": \"id\",\n    \"0-1\": \"The ID of the existing message to update.\",\n    \"0-2\": \"buddyId\",\n    \"0-3\": \"Required\"\n  },\n  \"cols\": 4,\n  \"rows\": 1\n}\n[/block]\n###Body Parameters\n\nThese parameters should be specified as part of the request body.\n[block:parameters]\n{\n  \"data\": {\n    \"0-0\": \"isNew\",\n    \"0-1\": \"Set to true to indicate that the message is new, otherwise set to \\\"false\\\".\",\n    \"0-2\": \"string\",\n    \"0-3\": \"Required\"\n  },\n  \"cols\": 4,\n  \"rows\": 1\n}\n[/block]\n\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{\\n  \\\"status\\\": 200,\\n  \\\"result\\\": {\\n    \\\"subject\\\": \\\"Test Message\\\",\\n    \\\"type\\\": \\\"Sent\\\",\\n    \\\"recipients\\\": [\\n      \\\"bv.kChbvshdHnDn\\\"\\n    ],\\n    \\\"isNew\\\": true,\\n    \\\"sent\\\": \\\"2014-07-15T20:05:36.867Z\\\",\\n    \\\"thread\\\": \\\"b014a556-ed94-47ea-98d8-b5f8c43ffd12\\\",\\n    \\\"from\\\": \\\"bv.kChbvshdHnDn\\\",\\n    \\\"fromName\\\": \\\"\\\",\\n    \\\"toName\\\": \\\"\\\",\\n    \\\"to\\\": \\\"bv.kChbvshdHnDn\\\",\\n    \\\"id\\\": \\\"gb.FHhbbzkMvxxp\\\",\\n    \\\"created\\\": \\\"2014-07-15T20:05:36.867Z\\\",\\n    \\\"lastModified\\\": \\\"2014-07-15T20:15:30.750Z\\\"\\n  },\\n  \\\"request_id\\\": \\\"53c58be2b32fad0f9c61bc2a\\\",\\n  \\\"success\\\": true\\n} \",\n      \"language\": \"json\",\n      \"name\": \"Response\"\n    }\n  ],\n  \"sidebar\": true\n}\n[/block]","excerpt":"","slug":"update-message","type":"basic","title":"Update Message"}
[block:api-header] { "type": "patch", "title": "/messages/{id}" } [/block] Updates the "isNew" flag for a message to indicate that the message has been read. [block:code] { "codes": [ { "code": "var options = {\n\tisNew: false\n};\n\nBuddy.patch('/messages/my_id',\n\t\toptions,\n\t\tfunction(err, result) {\n\t\t\t \n\t\t\tif (result.success) {\n\t\t\t\t// Do something with the result!\n\t\t\t} else { \n\t\t\t\t// Otherwise log the error\n\t\t\t\tconsole.log(err); \n\t\t\t} \n\t\t}\n\t);", "language": "javascript" }, { "code": "NSDictionary *params = @{\n\t\t\[email protected]\"isNew\": false\n\t\t};\n\n[Buddy PATCH:@\"/messages/my_id\" parameters:params class:[BPMessage class] callback:^(id obj, NSError *error) {\n\t// Your callback code here\n}];", "language": "objectivec", "name": "iOS" }, { "code": "Map<String, Object> parameters = new HashMap<String, Object>();\nparameters.put(\"isNew\", false);\n\nBuddy.<Message>patch(\"/messages/my_id\", parameters, new BuddyCallback<Message>(Message.class) {\n\[email protected]\n\tpublic void completed(BuddyResult<Message> result) {\n\t\t// Your callback code here\n\t}\n});", "language": "java", "name": "Android" }, { "code": "var options = new {\n\t\t\tisNew = false\n\t\t};\n\nvar result = await Buddy.PatchAsync<Message>(\"/messages/my_id\", options);", "language": "csharp", "name": ".NET" } ], "sidebar": true } [/block] ###Path Parameters These parameters should be specified as part of the HTTP path. [block:parameters] { "data": { "0-0": "id", "0-1": "The ID of the existing message to update.", "0-2": "buddyId", "0-3": "Required" }, "cols": 4, "rows": 1 } [/block] ###Body Parameters These parameters should be specified as part of the request body. [block:parameters] { "data": { "0-0": "isNew", "0-1": "Set to true to indicate that the message is new, otherwise set to \"false\".", "0-2": "string", "0-3": "Required" }, "cols": 4, "rows": 1 } [/block] [block:code] { "codes": [ { "code": "{\n \"status\": 200,\n \"result\": {\n \"subject\": \"Test Message\",\n \"type\": \"Sent\",\n \"recipients\": [\n \"bv.kChbvshdHnDn\"\n ],\n \"isNew\": true,\n \"sent\": \"2014-07-15T20:05:36.867Z\",\n \"thread\": \"b014a556-ed94-47ea-98d8-b5f8c43ffd12\",\n \"from\": \"bv.kChbvshdHnDn\",\n \"fromName\": \"\",\n \"toName\": \"\",\n \"to\": \"bv.kChbvshdHnDn\",\n \"id\": \"gb.FHhbbzkMvxxp\",\n \"created\": \"2014-07-15T20:05:36.867Z\",\n \"lastModified\": \"2014-07-15T20:15:30.750Z\"\n },\n \"request_id\": \"53c58be2b32fad0f9c61bc2a\",\n \"success\": true\n} ", "language": "json", "name": "Response" } ], "sidebar": true } [/block]