Leads

Update Lead

Update the fields of a single lead.

When to use. Change one lead you already know by id. To update many leads at once, use PUT /leads/mass-update.

Parameters. id (path) is the lead to update.

Request body. A JSON object with the fields to change. Any subset is accepted, for example first_name, phone, address fields, email, call_after, and a customFields object of your own field name and value pairs. Changing phone re-processes the number and clears the do-not-call flag on the lead.

Returns. 204 No Content on success. If part of the update could not be applied, 200 OK is returned with a messages array explaining what was skipped, for example a timezone_id that does not match the lead's country.

Example. PUT /api/leads/1 with body { "first_name": "John", "call_after": "2026-01-01 09:00:00" }

put/{sub_domain}/api/leads/{id}

Request

  • Base URL
    https://api.commpeak.com/dialer
  • URL
    https://api.commpeak.com/dialer/{sub_domain}/api/leads/{id}
  • Auth
    API key in header Authorization

Path parameters

idinteger required

Lead ID.

sub_domainstring required

Dialer Name (subdomain)

Request body

first_namestring nullable

First name.

last_namestring nullable

Last name.

phonestring nullable

Phone.

phone2string nullable

Phone2.

address1string nullable

Address1.

address2string nullable

Address2.

countrystring nullable

Country name / ISO / ISO3.

statestring nullable

State.

citystring nullable

City.

zipstring nullable

Zip.

latnumber nullable

Latitude.

lngnumber nullable

Longitude.

timezonestring nullable

Timezone.

timezone_idinteger nullable

Timezone ID.

original_identifierstring nullable

Original identifier.

support_sitestring nullable

Support site.

purchase_sitestring nullable

Purchase site.

purchase_datestring nullable

Purchase date.

purchase_amountstring nullable

Purchase amount.

purchase_product_namestring nullable

Purchase product name.

purchase_card_namestring nullable

Purchase card name.

purchase_card_typestring nullable

Purchase card type.

purchase_card_digitsstring nullable

Purchase card digits.

emailstring nullable

Email.

birthdatestring nullable

Birthdate.

loan_amountstring nullable

Loan amount.

call_afterstring nullable

Call After (freeze) time to be set on the lead.

call_after_outside_allowed_timeinteger nullable

Whether calling the lead outside call hours is allowed.

customFieldsobject nullable

Custom field name/value pairs.

Response

Successful Response

messagesstring[] required

Changes

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