v1

latestOpenAPI 3.0.32026-07-24156161.2 MB

CampaignLeads

Mass assign leads

The Mass assign leads endpoint enables you to mass assign leads to a specific campaign. In the request body you should provide:

remove_from_others - Remove from other campaigns (true - remove, false - skip).
campaign_id - campaign to add leads to
where - array of conditions, can have any of the following fields: id, first_name, last_name, phone, phone2, address1, address2, country, state, city, zip, timezone, original_identifier, support_site, purchase_site, purchase_date, purchase_amount, purchase_product_name, purchase_card_name, purchase_card_type, purchase_card_digits, email, birthdate, loan_amount

put/campaign-leads/mass-assign

Request body

campaign_idnumber

remove_from_othersboolean

Example request

{
  "campaign_id": 12,
  "where": {
    "id": [
      1,
      2,
      3,
      4,
      5
    ]
  }
}

Response

Successful operation

Example response

{
  "leads": [
    {
      "first_name": "test",
      "id": "1",
      "last_name": "Smith22",
      "original_identifier": "1",
      "phone": "****45456",
      "phone_normalized": null
    },
    {
      "first_name": "test",
      "id": "2",
      "last_name": "test",
      "original_identifier": "2",
      "phone": "*******40714",
      "phone_normalized": "*******40713"
    }
  ]
}