Remove a reward from a referral

Removes a reward and voids any of its invoices that are still draft or payment-ready. Refused with invoice_locked when one of its invoices is already finalized or paid, since that money is committed. Check removable on the list endpoint first.

Address the reward by its Lasso id (default) or by the external_identifier you created it with, using ?reward_by=external_identifier. Requires payment_write permission.

delete/leads/{lead_identifier}/rewards/{id}

Request

Base URL: https://api.lassotech.com/api/v1/rest
URL: https://api.lassotech.com/api/v1/rest/leads/{lead_identifier}/rewards/{id}
Auth: API key in header x-lasso-access-token

Path parameters

lead_identifierstring required

Referral identifier (slug by default, or value matching by param)

idstring required

Reward id, or the reward's external_identifier when reward_by=external_identifier

Query parameters

reward_by'id' | 'external_identifier'

How to address the reward within the referral

by'slug' | 'id' | 'email' | 'company_name' | 'external'

How to read the referral identifier in the path. See Resource Lookup.

external_system_typestring

Required when by=external. e.g. HUBSPOT, SALESFORCE, PIPEDRIVE

external_object_typestring

Required when by=external (optional for a Salesforce partner). e.g. company, deal, opportunity, account

Response

Reward removed. The response shows the resulting invoice states.

Example response

{
  "lead_reward": {
    "name": "Tier 1 Call Held Bonus",
    "invoices": [
      {
        "status": "draft"
      }
    ]
  }
}

Changes

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