{"_id":"563d1407d8f2d20d00448d3c","__v":5,"category":{"_id":"563a252e50bf950d00e0979c","project":"563a252d50bf950d00e09798","pages":["563a252f50bf950d00e0979e","563a35ac1846790d0089532c","563d1407d8f2d20d00448d3c","563d1d3f9799fb0d0004776a","564509aa2c74cf1900da48c7","56453b7e9f3f550d00fa3c7b","564b498aeed7de0d003672c3","564b523ce5d9d61700d580e0","564b58ea1a8e610d006bfd49","564b59baee12850d00958656","564b6773d969330d00aba984","564b69b2d7b95d0d00ed050f","564b7fa8cc472d0d00da9447","564b905fa8a0ba21002ad6b1","564ba051288b1a2b00b3ae83","564ba6275cc43717009bcff1","564bb2138841060d00abb2e0","564bb74e05c99e1700161dd1","564c8ad60ddedc210051e582","564cca42d0c5b42b002305e8","564cca8ecfa4452b0019926d","564ce34f404ce53500fdb255","564cea76404ce53500fdb272","564cedb77d4d31170028dd2e","564cefc1bc81632100b10468","564cf17d1f42792b00820515","564cf5462248461700bd4017","564ddd49a8671617004e7b90","564ddf9ead1d5217003e2e18","564de1dea8671617004e7b99","564de3c11133043500f4bf96","564de669e39c4435005a1f65","564df3f16eaa3a2100868961","5655d3519347d30d00d7e8e2"],"version":"563a252d50bf950d00e0979b","__v":34,"sync":{"url":"","isSync":false},"reference":false,"createdAt":"2015-11-04T15:33:02.244Z","from_sync":false,"order":9999,"slug":"documentation","title":"Documentation"},"user":"54c7fdeae317000d007c2765","parentDoc":null,"project":"563a252d50bf950d00e09798","version":{"_id":"563a252d50bf950d00e0979b","__v":7,"project":"563a252d50bf950d00e09798","createdAt":"2015-11-04T15:33:01.701Z","releaseDate":"2015-11-04T15:33:01.701Z","categories":["563a252e50bf950d00e0979c","563a2a691846790d008952fe","563a3394daf1c00d00136d9b","563a3467d25e8919005f3f0c","563a347850bf950d00e097b4","570e5cec10aa423200391fb5","5890d358d6cb8e2500a3f311"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":true,"codename":"","version_clean":"1.0.0","version":"1.0"},"updates":[],"next":{"pages":[],"description":""},"createdAt":"2015-11-06T20:56:39.493Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"settings":"","results":{"codes":[]},"auth":"required","params":[],"url":""},"isReference":false,"order":9,"body":"[block:api-header]\n{\n  \"type\": \"get\",\n  \"title\": \"GET /clients/{id}/share-rights\"\n}\n[/block]\n\n[block:parameters]\n{\n  \"data\": {\n    \"0-0\": \"Description\",\n    \"0-1\": \"Get a list of the specified client’s share rights.\",\n    \"1-0\": \"Permissions\",\n    \"2-0\": \"Resource URL\",\n    \"3-0\": \"Parameters\",\n    \"1-1\": \"client.access\",\n    \"2-1\": \"https://app.klipfolio.com/api/1.0/clients/{id}/share-rights\",\n    \"3-1\": \"None.\"\n  },\n  \"cols\": 2,\n  \"rows\": 4\n}\n[/block]\n##Example Request \nGET https://app.klipfolio.com/api/1/clients/0123456789abcdef0123456789abcdef/share-rights\n##Example Response\n```\n{\n   \"data\": {\n       \"share_rights\": [\n    {\n       \"group_id\": \"0123456789abcdef0123456789abcdef\",\n       \"group_name\": \"Example Group\",\n       \"can_manage\": true\n     },\n     ...\n   ]\n   },\n   \"meta\": {\n       \"status\": 200,\n       \"success\": true\n   }\n}\n```\n[block:api-header]\n{\n  \"type\": \"put\",\n  \"title\": \"PUT /clients/{id}/share-rights\"\n}\n[/block]\n\n[block:parameters]\n{\n  \"data\": {\n    \"0-0\": \"Description\",\n    \"0-1\": \"Update the specified client’s share rights. If the client is not already shared with a specified group, a new share right is created, otherwise the existing share right is updated.\",\n    \"1-0\": \"Permissions\",\n    \"2-0\": \"Resource URL\",\n    \"3-0\": \"Parameters\",\n    \"1-1\": \"client.share\",\n    \"2-1\": \"https://app.klipfolio.com/api/1.0/clients/{id}/share-rights\",\n    \"3-1\": \"None.\"\n  },\n  \"cols\": 2,\n  \"rows\": 4\n}\n[/block]\n##Example Request \nPUT https://app.klipfolio.com/api/1/clients/0123456789abcdef0123456789abcdef/share-rights -d \"{'groups':[{'group_id':'fedcba9876543210fedcba9876543210','can_manage':true}]}\"\n\n##Example Response\n```\n{\n   \"data\": {},\n   \"meta\": {\n       \"status\": 200,\n       \"success\": true\n   }\n}\n```\n[block:api-header]\n{\n  \"type\": \"delete\",\n  \"title\": \"DELETE /clients/{id}/share-rights/{group-id}\"\n}\n[/block]\n\n[block:parameters]\n{\n  \"data\": {\n    \"0-0\": \"Description \\nPermissions\\nResource URL \\nParameters\\nResponse codes\",\n    \"0-1\": \"Revoke a group's access to a client\\nclient.share\\nhttps://app.klipfolio.com/api/1.0/clients/{id}/share-rights\\n None.\\n400 — missing group id\\n401 — access denied to users from other companies and users who do not have share rights\\n403 — client is not shared with group\\n404 — {id} or {group-id} not found\",\n    \"1-0\": \"Permissions\",\n    \"2-0\": \"Resource URL\",\n    \"3-0\": \"Parameters\",\n    \"1-1\": \"https://app.klipfolio.com/api/1/clients/{id}/share-rights\",\n    \"2-1\": \"client.share\",\n    \"3-1\": \"None.\"\n  },\n  \"cols\": 2,\n  \"rows\": 4\n}\n[/block]\n##Example Request \nDELETE https://app.klipfolio.com/api/1/clients/0123456789abcdef0123456789abcdef/share-rights/fedcba9876543210fedcba9876543210\n\n##Example Response\n```\n{\n   \"data\": {},\n   \"meta\": {\n       \"status\": 200,\n       \"success\": true\n   }\n}\n```","excerpt":"Change who within the requesting company has access to clients. View, update and manage client share-rights.","slug":"change-who-within-the-requesting-company-has-access-to-clients-view-update-and-manage-client-share-rights","type":"basic","title":"Client Share Rights"}

Client Share Rights

Change who within the requesting company has access to clients. View, update and manage client share-rights.

[block:api-header] { "type": "get", "title": "GET /clients/{id}/share-rights" } [/block] [block:parameters] { "data": { "0-0": "Description", "0-1": "Get a list of the specified client’s share rights.", "1-0": "Permissions", "2-0": "Resource URL", "3-0": "Parameters", "1-1": "client.access", "2-1": "https://app.klipfolio.com/api/1.0/clients/{id}/share-rights", "3-1": "None." }, "cols": 2, "rows": 4 } [/block] ##Example Request GET https://app.klipfolio.com/api/1/clients/0123456789abcdef0123456789abcdef/share-rights ##Example Response ``` { "data": { "share_rights": [ { "group_id": "0123456789abcdef0123456789abcdef", "group_name": "Example Group", "can_manage": true }, ... ] }, "meta": { "status": 200, "success": true } } ``` [block:api-header] { "type": "put", "title": "PUT /clients/{id}/share-rights" } [/block] [block:parameters] { "data": { "0-0": "Description", "0-1": "Update the specified client’s share rights. If the client is not already shared with a specified group, a new share right is created, otherwise the existing share right is updated.", "1-0": "Permissions", "2-0": "Resource URL", "3-0": "Parameters", "1-1": "client.share", "2-1": "https://app.klipfolio.com/api/1.0/clients/{id}/share-rights", "3-1": "None." }, "cols": 2, "rows": 4 } [/block] ##Example Request PUT https://app.klipfolio.com/api/1/clients/0123456789abcdef0123456789abcdef/share-rights -d "{'groups':[{'group_id':'fedcba9876543210fedcba9876543210','can_manage':true}]}" ##Example Response ``` { "data": {}, "meta": { "status": 200, "success": true } } ``` [block:api-header] { "type": "delete", "title": "DELETE /clients/{id}/share-rights/{group-id}" } [/block] [block:parameters] { "data": { "0-0": "Description \nPermissions\nResource URL \nParameters\nResponse codes", "0-1": "Revoke a group's access to a client\nclient.share\nhttps://app.klipfolio.com/api/1.0/clients/{id}/share-rights\n None.\n400 — missing group id\n401 — access denied to users from other companies and users who do not have share rights\n403 — client is not shared with group\n404 — {id} or {group-id} not found", "1-0": "Permissions", "2-0": "Resource URL", "3-0": "Parameters", "1-1": "https://app.klipfolio.com/api/1/clients/{id}/share-rights", "2-1": "client.share", "3-1": "None." }, "cols": 2, "rows": 4 } [/block] ##Example Request DELETE https://app.klipfolio.com/api/1/clients/0123456789abcdef0123456789abcdef/share-rights/fedcba9876543210fedcba9876543210 ##Example Response ``` { "data": {}, "meta": { "status": 200, "success": true } } ```