Sign in

v1

latestOpenAPI 3.1.02026-07-2617125852.3 KB
Lead

Update the interest status of a lead

Update the interest status of a lead

post/api/v2/leads/update-interest-status

Request body

lead_emailstring required

The email of the lead to update the interest status of.

interest_valuenumber nullable required

Set this field to "null" to reset the lead value to "Lead". This is the same as moving the lead to the "Lead" status in the web app. Please check the lt_interest_status field for the list of possible values.

campaign_idstring

The ID of the campaign to update the interest status of.

ai_interest_valuenumber

The AI interest value to set for the lead.

disable_auto_interestboolean

Whether to disable the auto interest.

list_idstring

The ID of the list to update the interest status of.

Example request

{
  "lead_email": "test@test.com",
  "interest_value": 1,
  "campaign_id": "019f94cd-aeec-7678-878d-25005c7f650f",
  "ai_interest_value": 1,
  "disable_auto_interest": true,
  "list_id": "019f94cd-aeec-7678-878d-250117351f25"
}

Response

Default Response

messagestring

Example response

{
  "message": "Lead interest status update background job submitted"
}