View, create, update and manage user properties.
GET /users/{id}/properties
Description | Get a list of the user’s properties. |
Permissions | user.manage |
Resource URL | |
Parameters | user id={id} |
Example Request
GET https://app.klipfolio.com/api/1/users/fedcba9876543210fedcba9876543210/properties
Example Response
{
"data": {
"properties":{}
},
"meta": {
"status": 200,
"success": true
}
}PUT /users/{id}/properties
Description | Create or update properties for this user. If the specified property does not already exist, it is created. If the property currently exists, it is updated. |
Permissions | user.manage |
Resource URL | |
Fields | properties |
Example Request
PUT https://app.klipfolio.com/api/1/users/fedcba9876543210fedcba9876543210/properties -d
{
"properties": {
"kfTestCountry": "Canada",
"TestValue": "abc1234",
"City": "Ottawa"
}
}Example Response
{
"data": {},
"meta": {
"status": 200,
"success": true
}
}DELETE /users/{id}/properties
Description | Delete properties associated with a user. |
Permissions | user.manage |
Resource URL | |
Parameters | None. |
Example Request
DELETE https://app.klipfolio.com/api/1/users/0123456789abc/properties?name=Stuff
Example Response
{
"meta": {
"status": 200,
"success": true
}
}