View and update client features for all client accounts belonging to the requesting company.
GET /clients/{id}/features
Description | 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. |
Permissions | client.access |
Resource URL | https://app.klipfolio.com/api/1.0/clients/{id}/features |
Parameters | id (string) — client id |
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
}
]
}
}
PUT/clients/{id}/features
Description | Update the status of the specified feature. Users with admin role privileges have access to all clients. |
Permissions | client.edit |
Resource URL | https://app.klipfolio.com/api/1.0/clients/{id}/features |
Fields | Features: downloadable_reports, embeds, public_dashboards, scheduled_emails, published_dashboards, theming, domain_cloaking and sso |
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": {}
}