Kartra Documentation TECHNICAL DOCUMENTATION

Action: Remove points from lead

The API system will search in your account for the lead subscribed under that specific email, and it will deduct the specified points from his or her profile.

 

Type Parameters Values
POST cmd* remove_points_from_lead
POST points* integer

* Required fields

Here is an example:

'lead' => [
    'email' => 'example@email.com'
],
'actions' => [
    '0' => [
        'cmd' => 'remove_points_from_lead',
        'points' => 1
    ]
]

Success message:

{
  "status": "Success",
  "message": "{points} points were removed from lead",
  "type": "106"
}

Error Cases:

Type Number Message Cause
228 points is not a number. Nothing done
  • ‘points’ parameter needs to be a numeric value.
217 points cannot be empty. Nothing done
  • ‘points’ parameter it is mandatory and cannot be empty.

An example of an error message:

{
  "status": "Error",
  "message": "points cannot be empty. Nothing done",
  "type": "217"
}

© 2021 Kartra All Rights Reserved