Update multiple leads that match a filter, applying the same changes to each.

When to use. Change many leads in one request. To update a single known lead, use PUT /leads/{id}.

Request body. A JSON object with two keys:

• where: the filter selecting which leads to update. Each key is a lead field, a scalar matches by equality and an array matches any of the listed values.
• update: the fields and new values to apply, optionally including a customFields object of your own field name and value pairs.

Returns. { "leads": [ ... ] } with the updated leads. If some values could not be applied, a messages array describes what was skipped.

Example. PUT /api/leads/mass-update with body { "where": { "id": [ 1, 2 ] }, "update": { "first_name": "John" } }

{
  "leads": [
    {
      "address1": "1st Avenue 111",
      "city": "New York",
      "country_id": 840,
      "created_at": "2024-08-13 18:22:46",
      "customFields": {
        "Age": "",
        "NoteA": "",
        "Street": ""
      },
      "first_name": "John",
      "hlr": 0,
      "id": 594652,
      "is_deleted": 0,
      "is_do_not_call": 0,
      "is_locked": 0,
      "last_name": "Doe",
      "lead_file_id": 1609,
      "phone": "12125551234",
      "phone_normalized": "12125551234",
      "purchase_amount": 0,
      "purchase_site": "DemoStore",
      "support_site": "DemoSupport",
      "timezone_id": 274,
      "updated_at": "2024-08-13 18:22:50"
    }
  ]
}