Kartra Documentation TECHNICAL DOCUMENTATION

Action: Give points to lead

You can add points to a lead’s profile, along with the expiration deadline in days. Once the expiration is reached, these exact points will be automatically deducted again.

Note that the lead must have been previously added to your account.

Parameters Values
cmd* give_points_to_lead
points* integer
expiration** integer

* Required fields

** 0 or not sending the parameter at all will mean that the points have no expiration date.

Here is an example:

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

Success message:

{
  "status": "Success",
  "message": "{points} points were added to lead",
  "type": "105"
}

Error Cases:

Type Number Message Cause
227 points is not a number. Nothing done
  • ‘points’ parameter needs to be a numeric value.
215 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": "215"
}

© 2021 Kartra All Rights Reserved