Manage a client's dashboard
Manage a client's dashboard properties.
GET /clients/{id}/properties
| Description | Retrieve a list of the client's dashboard properties. |
| Permissions | client.access |
| Resource URL | https://app.klipfolio.com/api/1.0/clients/{id}/properties |
| Parameters | None. |
Example Response
{
"meta": { "success": true, "status": 200 },
"data": { "properties": { "alpha": "omega", "gamma": "zeta" } }
}
PUT /clients/{id}/properties
| Description | Add or update a dashboard property in a client's account. |
| Permissions | client.edit |
| Resource URL | https://app.klipfolio.com/api/1.0/clients/{id}/properties |
| Parameters | None. |
Example Post Request
curl https://app.klipfolio.com/api/1/clients/6xxxxxxxx3a29bc1babadc866aec723f/properties -X PUT
-d "{'properties': {'alpha': 'omega', 'gamma': 'zeta'}}" --header "kf-api-key:6xxxxxxxx60c488e9c5c18862a8967df5ab367c6e" -H "Content-Type: application/json"
Example Response
{ "meta": { "success": true, "status": 200 }, "data": { } }
DELETE /clients/{id}/properties
| Description | Delete a dashboard property from a client's account. |
| Permissions | client.edit |
| Resource URL | https://app.klipfolio.com/api/1.0/clients/{id}/properties |
| Fields | name - the name of the property you want to delete |
Example Delete
curl https://app.klipfolio.com/api/1/clients//6xxxxxxxx490ede0876ed71d48cfeee2/properties?name=alpha -X DELETE --header "kf-api-key:/6xxxxxxxx60c488e9c5c18862a8967df5ab367c6e"
Example Response
{ "meta": { "success": true, "status": 200 }, "data": { } }