Add Points

POST https://api.kickofflabs.com/v2/CAMPAIGN_ID/points

Adds custom points to one lead or to a group of leads matched by email.

Required parameters

• api_key: Your account API key.
• points: Number of points to add or subtract. Maximum accepted value is 99999.
• One identifier:
  • email: A single email address.
  • emails: An array of email addresses.
  • kid or social_id: The id of a single lead.

For email-based requests, KickoffLabs matches up to 100 leads.

Optional parameters

• message: A description of why the points were added to the lead.

JSON response

Successful response:

{ "message": "Custom Points added" }

Errors

• Missing points returns 409 with No points value found.
• Points greater than 99999 return 409 with Max Points Exceeded.
• Missing lead identifier returns 409 with Please include a lead id or email.
• No matching leads returns 404 with No leads found.

Additional information

• You can remove points by sending a negative point value.
• Points cannot go below zero.