COcommpeak
Leads

Create Lead

Create one or more leads in a single request.

When to use. Import leads into your account in bulk. To change existing leads, use PUT /leads/{id} for one lead or PUT /leads/mass-update for many.

Request body. A JSON array of lead objects. Only phone is required on each lead. Other fields are optional, including first_name, last_name, phone2, address fields, purchase details, email, birthdate, loan_amount, and a customFields object of your own field name and value pairs.

Returns. { "leads": [ ... ] } containing the created leads, each with its assigned id and any customFields.

Example. POST /api/leads with body [ { "phone": "12125551234", "first_name": "John" } ]

post/{sub_domain}/api/leads

Request

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

Path parameters

sub_domainstring required

Dialer Name (subdomain)

Request body

first_namestring nullable

First name.

last_namestring nullable

Last name.

phonestring required

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.

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.

customFieldsobject nullable

Custom field name/value pairs.

Response

Successful Response

total_leadsinteger nullable

Total number of leads in the response.

Example response

{
  "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"
    }
  ]
}

Changes

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