v1
latestOpenAPI 3.0.32026-07-24156161.2 MBCampaignLeads
Update Campaign leads
Use this endpoint to update campaign leads fields. You should specify the following parameters in the request body:
Request Body
-
where - allow to update by campaign lead ids
-
update - key/value pairs to update the filtered campaign leads from the were. update separated to cmapaign lead entities and lead entities.
-
lead entities:
first_name, last_name, phone, phone_normalized, phone2, phone_normalized2, address1, address2, state, city, zip, lat, lng, timezone, timezone_id, 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, call_after, call_after_outside_allowed_time -
campaign_lead entities:
status_id, created_at, updated_at, assigned_user_id, assigned_at, assigned_user_permanent, call_after, weight, is_deleted, clone_of, updating_status_started_at, permanent_assignment_expire_at, call_after_outside_allowed_time, no_ratio, calls_count, amd_disabled, outbound_ivr_disabled, override_trunk_id
-
put/campaign-leads/update-campaign-leads
Request body
Example request
{
"update": {
"campaignLead": {
"assigned_at": "0000-00-00 00:00:00",
"assigned_user_id": "10",
"call_after": "0000-00-00 00:00:00",
"call_after_outside_allowed_time": "0000-00-00 00:00:00",
"calls_count": "10",
"clone_of": "123456",
"created_at": "0000-00-00 00:00:00",
"permanent_assignment_expire_at": "0000-00-00 00:00:00",
"status_id": 12,
"updated_at": "0000-00-00 00:00:00",
"updating_status_started_at": "0000-00-00 00:00:00",
"weight": "1000"
},
"lead": {
"address1": "test",
"address2": "test",
"birthdate": "test",
"call_after": "0000-00-00 00:00:00",
"city": "test",
"email": "test",
"first_name": "test",
"last_name": "test",
"loan_amount": "test",
"original_identifier": "test",
"phone": "test",
"phone2": "test",
"phone_normalized": "test",
"phone_normalized2": "test",
"purchase_amount": "test",
"purchase_card_digits": "test",
"purchase_card_name": "test",
"purchase_card_type": "test",
"purchase_date": "test",
"purchase_product_name": "test",
"purchase_site": "test",
"support_site": "test",
"timezone_id": "12"
}
},
"where": {
"id": [
4,
5
]
}
}Response
Successful operation
Example response
{
"data": [
{
"amd_disabled": "0",
"assigned_at": null,
"assigned_user_id": null,
"assigned_user_permanent": "0",
"call_after": "2024-07-22 20:02:35",
"call_after_outside_allowed_time": "0",
"calls_count": "180",
"campaign_id": "2",
"clone_of": null,
"created_at": "2022-09-19 09:25:30",
"is_deleted": "0",
"lead": {
"address1": null,
"address2": null,
"api_user_id": null,
"birthdate": null,
"city": null,
"country_id": "157",
"created_at": "2022-09-19 09:23:05",
"duplicate_of": "0",
"email": "mmacculloch3j@nyu.edu",
"first_name": "test",
"hlr": "0",
"id": "997",
"is_deleted": "0",
"is_do_not_call": "0",
"is_error_msg": null,
"is_locked": "0",
"last_name": "MacCulloch",
"lat": null,
"lead_file_id": "1",
"lng": null,
"loan_amount": null,
"locked_user_id": "0",
"original_identifier": null,
"parsing_state": "2",
"phone": "608-164-9797",
"phone2": null,
"phone_normalized": "6081649797",
"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": "261",
"updated_at": "2024-09-10 14:38:20",
"zip": null
},
"lead_id": "997",
"no_ratio": "0",
"outbound_ivr_disabled": "0",
"override_trunk_id": "-1",
"permanent_assignment_expire_at": "2024-06-20 21:18:04",
"status_id": "26",
"updated_at": "2024-09-10 14:38:20",
"updating_status_started_at": null,
"weight": "1000"
},
{
"amd_disabled": "0",
"assigned_at": null,
"assigned_user_id": null,
"assigned_user_permanent": "0",
"call_after": "2024-07-22 19:39:07",
"call_after_outside_allowed_time": "0",
"calls_count": "162",
"campaign_id": "2",
"clone_of": null,
"created_at": "2022-09-19 09:25:30",
"is_deleted": "0",
"lead": {
"address1": null,
"address2": null,
"api_user_id": null,
"birthdate": null,
"city": null,
"country_id": "181",
"created_at": "2022-09-19 09:23:05",
"duplicate_of": "0",
"email": "wscarf7h@guardian.co.uk",
"first_name": "test",
"hlr": "0",
"id": "996",
"is_deleted": "0",
"is_do_not_call": "0",
"is_error_msg": null,
"is_locked": "0",
"last_name": "Scarf",
"lat": null,
"lead_file_id": "1",
"lng": null,
"loan_amount": null,
"locked_user_id": "0",
"original_identifier": null,
"parsing_state": "2",
"phone": "178-745-1559",
"phone2": null,
"phone_normalized": "11787451559",
"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": "288",
"updated_at": "2024-09-10 14:38:20",
"zip": null
},
"lead_id": "996",
"no_ratio": "0",
"outbound_ivr_disabled": "0",
"override_trunk_id": "-1",
"permanent_assignment_expire_at": "2024-07-01 14:45:16",
"status_id": "26",
"updated_at": "2024-09-10 14:38:20",
"updating_status_started_at": null,
"weight": "1000"
}
],
"messages": []
}