Update lead goal

This endpoint marks a goal as reached or not reached for a specific lead. Rewards linked to the goal are calculated automatically, and your campaign webhooks fire when a goal is reached.

There are 3 possible ways to find the lead.

  1. Using the lead unique identifier: id.
  2. Using the lead unique code: code.
  3. Using the lead email address and campaign identifier: email and campaign_id.

Qualification works the same way: its goal id is the negative campaign id, and marking it qualifies or unqualifies the lead.

Only leads can reach goals, and the goal must belong to the lead's campaign. Sending the state the lead already has changes nothing.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
integer

Unique identifier of the lead.

string

Unique code of the lead.

string

Email address of the lead. Property required with using campaign_id.

integer

Unique identifier of campaign lead related to. Property required with using email.

integer
required

Unique identifier of the goal. For Qualification, use the negative campaign id, for example -36456.

boolean
required
Defaults to true

true marks the goal as reached, false marks it as not reached.

Responses

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json