Update Profile Points
Request
URI
Partners/{partnerID}/Profiles/{entityIDType}/{entityID}/Points?value={value}&description={description}
Description
Add or Removes points from a Profile. A description should be provided describing how or why the points were earned. The response will return the current total number of points the Profile has earned.
API Key Required
Method
POST
Parameters
| Name | Required | Description |
|---|---|---|
| PartnerID | Yes | The numeric identifier for the Partner Account |
| EntityIDType | Yes | The Type of EntityID Provided. (Email) |
| EntityID | Yes | The ID of the Profile whose points need to be updated. (Jason@Example.com) |
| Value | Yes | The number of points to add or remove from the Profile’s Total Points. |
| Description | No | The reason why or how the points were earned or take away. |
Sample Request
http://app.IActionable.com/API/Partners/99999/Profiles/email/Jason@example.com/Points?value=5&description=You are cool
Response
Parameters
| Name | Description |
|---|---|
| AvailablePoints | The profile’s current total points. |
| LastUpdated | The timestamp of when this profile was last updated |
| TotalPoints | The lifetime total points a profile has earned. |
Sample Response
{
"AvailablePoints": 5,
"LastUpdated": "/Date(1278521302499)/",
"TotalPoints": 5
}
Get Profile Points
Request
URI
Partners/{partnerID}/Profiles/{entityIDType}/{entityID}/Points
Description
Retrieves the current total number of points the Profile has earned.
API Key Required
No
Method
GET
Parameters
| Name | Required | Description |
|---|---|---|
| PartnerID | Yes | The numeric identifier for the Partner Account |
| EntityIDType | Yes | The Type of EntityID Provided. (Email) |
| EntityID | Yes | The ID of the Profile of the points requested. (Jason@Example.com) |
Sample Request
http://app.IActionable.com/API/Partners/99999/Profiles/email/Jason@example.com/Points
Response
Parameters
| Name | Description |
|---|---|
| AvailablePoints | The profile’s current total points. |
| LastUpdated | The timestamp of when this profile was last updated |
| TotalPoints | The lifetime total points a profile has earned. |
Sample Response
{
"AvailablePoints": 5,
"LastUpdated": "/Date(1278521302499)/",
"TotalPoints": 5
}
