{"_id":"563d1d3f9799fb0d0004776a","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"},"__v":7,"user":"54c7fdeae317000d007c2765","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"},"parentDoc":null,"project":"563a252d50bf950d00e09798","updates":[],"next":{"pages":[],"description":""},"createdAt":"2015-11-06T21:35:59.295Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[]},"settings":"","auth":"required","params":[],"url":""},"isReference":false,"order":8,"body":"[block:api-header]\n{\n  \"type\": \"get\",\n  \"title\": \"GET /clients/{id}/settings\"\n}\n[/block]\n\n[block:parameters]\n{\n  \"data\": {\n    \"0-0\": \"Description\",\n    \"0-1\": \"Retrieve a list of settings for a specified client.\",\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}/settings\",\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/settings\n\n##Example Response\n```\n{\n  \"meta\": {\n    \"success\": true,\n    \"status\": 200\n  },\n  \"data\": {\n    \"settings\": {\n      \"brand.parent.enabled\": null,\n      \"datasource.blacklist\": null,\n      \"firstrun.welcomeTour.show\": null,\n      \"firstrun.addDashboardTour.show\": null,\n      \"firstrun.dashboardPanelTour.show\": null,\n      \"firstrun.connectDataTour.show\": null,\n      \"firstrun.addKlipTour.show\": null,\n      \"firstrun.klipGalleryTour.show\": null,\n      \"firstrun.inviteUsersTour.show\": null,\n      \"firstrun.editorTour.show\": null,\n      \"firstrun.editorFormatFormulaTour.show\": null,\n      \"firstrun.mobileBanner.show\": null,\n      \"dpn.env.date.language.tag\": \"fr-FR\"\n    }\n  }\n}\n\n```\n[block:api-header]\n{\n  \"type\": \"post\",\n  \"title\": \"POST /clients/{id}/settings\"\n}\n[/block]\n\n[block:parameters]\n{\n  \"data\": {\n    \"0-0\": \"Description\",\n    \"0-1\": \"Sets the value of one or more company properties.\",\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}/settings\",\n    \"3-1\": \"dpn.env.date.language.tag\\n**List of possible locales supported by this tag:**\\n    ENGLISH = \\\"en\\\"\\n    FRENCH = \\\"fr\\\"\\n    GERMAN = \\\"de\\\"\\n    ITALIAN = \\\"it\\\"\\n    JAPANESE = \\\"ja\\\"\\n    KOREAN = \\\"ko\\\"\\n    CHINESE = \\\"zh\\\"\\n    SIMPLIFIED_CHINESE = \\\"zh-CN\\\"\\n    TRADITIONAL_CHINESE = \\\"zh-TW\\\"\\n    FRANCE = \\\"fr-FR\\\"\\n    GERMANY = \\\"de-DE\\\"\\n    ITALY = \\\"it-IT\\\"\\n    JAPAN = \\\"ja-JP\\\"\\n    KOREA = \\\"ko-KR\\\"\\n    CHINA = SIMPLIFIED_CHINESE\\n    PRC = SIMPLIFIED_CHINESE\\n    TAIWAN = TRADITIONAL_CHINESE\\n    UK = \\\"en-GB\\\"\\n    US = \\\"en-US\\\"\\n    CANADA = \\\"en-CA\\\"\\n    CANADA_FRENCH = \\\"fr-CA\\\"\\n**List of optional tour properties:**\\n**In the dashboard:**\\nfirstrun.welcomeTour.show\\nfirstrun.addDashboardTour.show\\nfirstrun.dashboardPanelTour.show\\nfirstrun.connectDataTour.show\\nfirstrun.addKlipTour.show\\nfirstrun.klipGalleryTour.show\\nfirstrun.inviteUsersTour.show\\nfirstrun.mobileBanner.show\\n**In the editor:**\\nfirstrun.editorTour.show\\nfirstrun.editorFormatFormulaTour.show\"\n  },\n  \"cols\": 2,\n  \"rows\": 4\n}\n[/block]\n**Note:** Clients of White Label partners have the tour properties turned off by default. Clients of partners without White Label have the tours turned on by default.\n\n##Example Request\nPOST https://app.klipfolio.com/api/1/clients/0123456789abcdef0123456789abcdef/settings -d \"{'firstrun.editorTour.show':true}\n\n##Example Response\n```\n{\n  \"meta\": {\n    \"success\": true,\n    \"status\": 200\n  },\n  \"data\": {}\n}\n```","excerpt":"View and set configurations for clients' accounts","slug":"client-settings","type":"basic","title":"Client Settings"}

Client Settings

View and set configurations for clients' accounts

[block:api-header] { "type": "get", "title": "GET /clients/{id}/settings" } [/block] [block:parameters] { "data": { "0-0": "Description", "0-1": "Retrieve a list of settings for a specified client.", "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}/settings", "3-1": "None." }, "cols": 2, "rows": 4 } [/block] ##Example Request GET https://app.klipfolio.com/api/1/clients/0123456789abcdef0123456789abcdef/settings ##Example Response ``` { "meta": { "success": true, "status": 200 }, "data": { "settings": { "brand.parent.enabled": null, "datasource.blacklist": null, "firstrun.welcomeTour.show": null, "firstrun.addDashboardTour.show": null, "firstrun.dashboardPanelTour.show": null, "firstrun.connectDataTour.show": null, "firstrun.addKlipTour.show": null, "firstrun.klipGalleryTour.show": null, "firstrun.inviteUsersTour.show": null, "firstrun.editorTour.show": null, "firstrun.editorFormatFormulaTour.show": null, "firstrun.mobileBanner.show": null, "dpn.env.date.language.tag": "fr-FR" } } } ``` [block:api-header] { "type": "post", "title": "POST /clients/{id}/settings" } [/block] [block:parameters] { "data": { "0-0": "Description", "0-1": "Sets the value of one or more company properties.", "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}/settings", "3-1": "dpn.env.date.language.tag\n**List of possible locales supported by this tag:**\n ENGLISH = \"en\"\n FRENCH = \"fr\"\n GERMAN = \"de\"\n ITALIAN = \"it\"\n JAPANESE = \"ja\"\n KOREAN = \"ko\"\n CHINESE = \"zh\"\n SIMPLIFIED_CHINESE = \"zh-CN\"\n TRADITIONAL_CHINESE = \"zh-TW\"\n FRANCE = \"fr-FR\"\n GERMANY = \"de-DE\"\n ITALY = \"it-IT\"\n JAPAN = \"ja-JP\"\n KOREA = \"ko-KR\"\n CHINA = SIMPLIFIED_CHINESE\n PRC = SIMPLIFIED_CHINESE\n TAIWAN = TRADITIONAL_CHINESE\n UK = \"en-GB\"\n US = \"en-US\"\n CANADA = \"en-CA\"\n CANADA_FRENCH = \"fr-CA\"\n**List of optional tour properties:**\n**In the dashboard:**\nfirstrun.welcomeTour.show\nfirstrun.addDashboardTour.show\nfirstrun.dashboardPanelTour.show\nfirstrun.connectDataTour.show\nfirstrun.addKlipTour.show\nfirstrun.klipGalleryTour.show\nfirstrun.inviteUsersTour.show\nfirstrun.mobileBanner.show\n**In the editor:**\nfirstrun.editorTour.show\nfirstrun.editorFormatFormulaTour.show" }, "cols": 2, "rows": 4 } [/block] **Note:** Clients of White Label partners have the tour properties turned off by default. Clients of partners without White Label have the tours turned on by default. ##Example Request POST https://app.klipfolio.com/api/1/clients/0123456789abcdef0123456789abcdef/settings -d "{'firstrun.editorTour.show':true} ##Example Response ``` { "meta": { "success": true, "status": 200 }, "data": {} } ```