Leads

Return a lead

Mark a lead as returned, crediting it back.

A lead can be returned once. Returning one already returned answers with an error naming that.

post/lead/return

Request

  • Base URL: https://api.leadprosper.io/public
  • URL: https://api.leadprosper.io/public/lead/return
  • Auth: one of:
    • HTTP bearer
    • API key in query parameter api_token

Request body

lead_idstring required

The lead to return.

reasonstring required

Why it is being returned.

portal_refundboolean

Also refund the buyer in the portal.

Example request

{
  "lead_id": "XT1MM6AB8JeApcHItO8n"
}

Response

Success

statusstring

Always success on a 200.

dataobject

Empty - the return either succeeded or the call failed with an error status.

Changes

No recorded changes to this operation across all 1 revision of this API.