{"_id":"57a393458d35f91900970c1d","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"},"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"},"__v":2,"user":"54c7fdeae317000d007c2765","parentDoc":null,"updates":["57b6f05a049a3d1700b73c69"],"next":{"pages":[],"description":""},"createdAt":"2016-08-04T19:11:01.323Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[]},"settings":"","auth":"required","params":[],"url":""},"isReference":false,"order":5,"body":"[block:api-header]\n{\n  \"type\": \"get\",\n  \"title\": \"GET /clients/{id}/features\"\n}\n[/block]\n\n[block:parameters]\n{\n  \"data\": {\n    \"0-0\": \"Description\",\n    \"0-1\": \"List features (Download Reports, Custom Theme, SSL Domain Alias, Private Links, Embeds, Public Links, Email Reports and SSO) allocated to a specified client. Users with admin role privileges have access to all clients.\",\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}/features\",\n    \"3-1\": \"id (string) — client id\"\n  },\n  \"cols\": 2,\n  \"rows\": 4\n}\n[/block]\n## Example Request \n\nGET https://app.klipfolio.com/api/1.0/clients/1234c12345e064e6e05c5bfbddd9bdb4/features\n\n## Example Response \n\n```\n{\n  \"meta\": {\n    \"success\": true,\n    \"status\": 200\n  },\n  \"data\": {\n    \"features\": [\n      {\n        \"name\": \"theming\",\n        \"display_name\": \"Custom Theme\",\n        \"enabled\": false\n      },\n      {\n        \"name\": \"domain_cloaking\",\n        \"display_name\": \"SSL Domain Alias\",\n        \"enabled\": false\n      },\n      {\n        \"name\": \"published_dashboards\",\n        \"display_name\": \"Private Links\",\n        \"enabled\": false\n      },\n      {\n        \"name\": \"downloadable_reports\",\n        \"display_name\": \"Download Reports\",\n        \"enabled\": true\n      },\n      {\n        \"name\": \"scheduled_emails\",\n        \"display_name\": \"Email Reports\",\n        \"enabled\": true\n      },\n      {\n        \"name\": \"sso\",\n        \"display_name\": \"SSO\",\n        \"enabled\": true\n      },\n      {\n        \"name\": \"embeds\",\n        \"display_name\": \"Embeds\",\n        \"enabled\": true\n      },\n      {\n        \"name\": \"public_dashboards\",\n        \"display_name\": \"Public Links\",\n        \"enabled\": true\n      }\n    ]\n  }\n}\n```\n\n[block:api-header]\n{\n  \"type\": \"put\",\n  \"title\": \"PUT/clients/{id}/features\"\n}\n[/block]\n\n[block:parameters]\n{\n  \"data\": {\n    \"0-0\": \"Description\",\n    \"0-1\": \"Update the status of the specified feature. Users with admin role privileges have access to all clients.\",\n    \"1-0\": \"Permissions\",\n    \"1-1\": \"client.edit\",\n    \"2-0\": \"Resource URL\",\n    \"2-1\": \"https://app.klipfolio.com/api/1.0/clients/{id}/features\",\n    \"3-0\": \"Fields\",\n    \"3-1\": \"Features: \\ndownloadable_reports, embeds, public_dashboards, scheduled_emails, published_dashboards, theming, domain_cloaking and sso\"\n  },\n  \"cols\": 2,\n  \"rows\": 4\n}\n[/block]\n##Example Request\nPUT https://app.klipfolio.com/api/1.0/clients/1234c12345e064e6e05c5bfbddd9bdb4/features -d {\n    \"features\": [{\"name\":\"domain_cloaking\",\"enabled\":false}]}\n\n##Example Response\n```\n{\n  \"meta\": {\n    \"success\": true,\n    \"status\": 200\n  },\n  \"data\": {}\n}\n```","excerpt":"View and update client features for all client accounts belonging to the requesting company.","slug":"client-features","type":"basic","title":"Client Features"}

Client Features

View and update client features for all client accounts belonging to the requesting company.

[block:api-header] { "type": "get", "title": "GET /clients/{id}/features" } [/block] [block:parameters] { "data": { "0-0": "Description", "0-1": "List features (Download Reports, Custom Theme, SSL Domain Alias, Private Links, Embeds, Public Links, Email Reports and SSO) allocated to a specified client. Users with admin role privileges have access to all clients.", "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}/features", "3-1": "id (string) — client id" }, "cols": 2, "rows": 4 } [/block] ## Example Request GET https://app.klipfolio.com/api/1.0/clients/1234c12345e064e6e05c5bfbddd9bdb4/features ## Example Response ``` { "meta": { "success": true, "status": 200 }, "data": { "features": [ { "name": "theming", "display_name": "Custom Theme", "enabled": false }, { "name": "domain_cloaking", "display_name": "SSL Domain Alias", "enabled": false }, { "name": "published_dashboards", "display_name": "Private Links", "enabled": false }, { "name": "downloadable_reports", "display_name": "Download Reports", "enabled": true }, { "name": "scheduled_emails", "display_name": "Email Reports", "enabled": true }, { "name": "sso", "display_name": "SSO", "enabled": true }, { "name": "embeds", "display_name": "Embeds", "enabled": true }, { "name": "public_dashboards", "display_name": "Public Links", "enabled": true } ] } } ``` [block:api-header] { "type": "put", "title": "PUT/clients/{id}/features" } [/block] [block:parameters] { "data": { "0-0": "Description", "0-1": "Update the status of the specified feature. Users with admin role privileges have access to all clients.", "1-0": "Permissions", "1-1": "client.edit", "2-0": "Resource URL", "2-1": "https://app.klipfolio.com/api/1.0/clients/{id}/features", "3-0": "Fields", "3-1": "Features: \ndownloadable_reports, embeds, public_dashboards, scheduled_emails, published_dashboards, theming, domain_cloaking and sso" }, "cols": 2, "rows": 4 } [/block] ##Example Request PUT https://app.klipfolio.com/api/1.0/clients/1234c12345e064e6e05c5bfbddd9bdb4/features -d { "features": [{"name":"domain_cloaking","enabled":false}]} ##Example Response ``` { "meta": { "success": true, "status": 200 }, "data": {} } ```