Sign in

v1

latestOpenAPI 3.0.32026-07-24156161.2 MB
Leads

Delete Leads

The Delete leads endpoint allows you to mass delete leads by their IDs. You should add the lead id in the request body:

Request Body

  • id (array of integers) - The IDs of the leads to be updated or deleted.

Response

The response will contain an array of objects under the key removedLeads, each object representing a lead that has been removed.

put/leads/mass-delete

Request body

first_namestring[]
idnumber[]

Example request

{
  "first_name": [
    "Vasys"
  ],
  "id": [
    123
  ]
}

Response

Successful operation / Failed operation

Example response

{
  "removedLeads": [
    {
      "address1": "eftesh",
      "address2": null,
      "api_user_id": "1",
      "birthdate": null,
      "city": null,
      "country_id": null,
      "created_at": "2022-08-16 08:22:12",
      "duplicate_of": null,
      "email": null,
      "first_name": "Vasya55",
      "hlr": "0",
      "id": "1",
      "is_deleted": "0",
      "is_do_not_call": "0",
      "is_error_msg": null,
      "is_locked": "0",
      "last_name": "Smith",
      "lat": null,
      "lead_file_id": null,
      "lng": null,
      "loan_amount": null,
      "locked_user_id": null,
      "original_identifier": "1",
      "parsing_state": "0",
      "phone": "****21123",
      "phone2": null,
      "phone_normalized": null,
      "phone_normalized2": null,
      "purchase_amount": "0",
      "purchase_card_digits": "",
      "purchase_card_name": null,
      "purchase_card_type": null,
      "purchase_date": "1970-01-01 00:00:00",
      "purchase_product_name": null,
      "purchase_site": null,
      "remote_adapter_id": "0",
      "state": null,
      "support_site": null,
      "timezone": null,
      "timezone_id": null,
      "updated_at": null,
      "zip": null
    }
  ]
}