In addition to the bulk loading API features, Pure CallerID also provides a simple mechanism for uploading single lead record. The API is secured by using an API token that can be created and managed within your workspace.
Single Lead loading is typically reserved for real time lead generation workflows often referred to Web To Call, Form To Phone, Web To Lead, etc. Leads loaded using the single lead API are processed synchronously and provide response codes confirm the lead was successfully Accepted or Rejected based on the campaign configurations.
URL: https://core.purecallerid.app/api/public/lead/load
Method: POST
Content-Type: application/json
Security: A custom HTTP header must be included in the POST request. The Header name is "X-API-KEY" and the value passed within this header is one of the encrypted API keys associated with your workspace.
{
"campaignId": "65ae6e4b6bf35b2344b109e5",
"dialerListId": "demoList001",
"listName": "Real Time Leads - Jan 2024",
"fields": [
{
"value": "55555551212",
"dialerField": "number1",
"type": "Phone"
},
{
"value": "12345",
"dialerField": "zip",
"type": "Zip"
},
{
"value": "John",
"dialerField": "first_name"
},
{
"value": "Doe",
"dialerField": "last_name"
},
{
"value": "123 Any Street",
"dialerField": "street"
},
{
"value": "New York",
"dialerField": "city"
},
{
"value": "NY",
"dialerField": "state"
},
{
"value": "you@email.com",
"dialerField": "email"
}
]
}
- campaignId - Unique Id of the Pure CallerID campaign the lead will be loaded against. This value can be found when editing a campaign.
- dialerListId - Must match the Identifier of the list within your dialer instance associated with the campaign.
- listName - The organizational list name in Pure CallerID that the leads will be loaded into. Note, that this is internal to Pure CallerID and is not related to the dialer list.
-
fields: An array of Field objects that define the lead data
- field.value - the value of the field. Typically this is the actual name, phone number, zip code, address, etc of the lead.
- field.dialerField - The dialer column that the field value is to be mapped to
- field.type: Possible values are "Phone", "Zip", "City", "State", "VeriskLeadId", "TrustedFormCert". A valid Phone is required on all leads. Zip is optional, but recommended and allows the Community CallerID module to map a geographically relevant phone number to the lead. In the event that Zip is not provided, City and State will be used instead. Verisk LeadID or Trusted Form Cert can be used to define a lead generation marketing token that can be verified and validated with the corresponding third party platform(s). If the data is not a Phone, Zip, City, State, or Token, the type value can be left out of the field element.
A synchronous response will be returned to inform the calling party of the outcome of the list load process.
{
"status": "Accepted",
"reason": null,
"message": "OK"
}
- status - one of Accepted or Rejected
-
reason - if the lead is Rejected a reason code will be given
- INACTIVE - Phone number was inactive
- INVALID - Phone number was malformed or invalid
- DNC - Phone number is on federal or state Do-Not-Call list
- TCPA_FLAG - Phone number is associated with a high TCPA risk
- INVALID_TOKEN - Provided lead token is invalid or missing
- FAILED - Unknown processing failure
- SUPPRESSED - Number is suppressed and cannot be dialed
- message - Descriptive message to add more detail to the reject reason.
Dialer Specific Required Fields
The dialer field value supplied in the request body must match the dialer's expected values. Below are specific examples along with the required fields.
APN
Required: Phone
Dialer fields security_phrase and vendor_lead_code are reserved for this integration and cannot be mapped to supplied values.
{
"campaignId": "65ae6e4b6bf35b2344b109e5",
"dialerListId": "demoList001",
"listName": "Real Time Leads - Jan 2024",
"fields": [
{
"value": "55555551212",
"dialerField": "phone_number",
"type": "Phone"
},
{
"value": "12345",
"dialerField": "postal_code",
"type": "Zip"
},
{
"value": "New York",
"dialerField": "city",
"type": "City"
},
{
"value": "NY",
"dialerField": "state",
"type": "State"
}
]
}
Five9
Required: Phone
Dialer fields configured for the Workspace as Reserved Caller ID Field and Reserved Unique ID Field are required for this integration and cannot be mapped to supplied values.
{
"campaignId": "65ae6e4b6bf35b2344b109e5",
"dialerListId": "demoList001",
"listName": "Real Time Leads - Jan 2024",
"fields": [
{
"value": "55555551212",
"dialerField": "number1",
"type": "Phone"
},
{
"value": "12345",
"dialerField": "zip",
"type": "Zip"
},
{
"value": "New York",
"dialerField": "city",
"type": "City"
},
{
"value": "NY",
"dialerField": "state",
"type": "State"
}
]
}
Note: Existing leads matching the Reserved Unique ID Field will be updated with newly supplied lead information. All records added via this API will be inserted into the Five9 dialer platform without duplicate checking and will be prioritized for dialing immediately.
NICE CXOne
Required: Phone
Dialer field values must match the Calling List Data Definitions. The following definitions are required for this integration:
- Phone Number: Phone Number
- Zip: Zip
- External ID: PCID_ID
- Caller ID: callerId
Dialer fields PCID_ID and callerId are required for this integration and cannot be mapped to supplied values.
{
"campaignId": "65ae6e4b6bf35b2344b109e5",
"dialerListId": "demoList001",
"listName": "Real Time Leads - Jan 2024",
"fields": [
{
"value": "55555551212",
"dialerField": "Phone Number",
"type": "Phone"
},
{
"value": "12345",
"dialerField": "Zip",
"type": "Zip"
},
{
"value": "New York",
"dialerField": "City",
"type": "City"
},
{
"value": "NY",
"dialerField": "State",
"type": "State"
}
]
}
RingCX
Required: Dedupe, externId, and phone
Dedupe is a list level setting and may be supplied one of the following values:
- RING_REMOVE_ALL_EXISTING
- RING_REMOVE_FROM_LIST
- RING_RETAIN_ALL
Dialer fields callerId and auxData1 are reserved for this integration and cannot be mapped to supplied values.
{
"campaignId": "65ae6e4b6bf35b2344b109e5",
"dialerListId": "10000013",
"listName": "Real Time Leads - Jan 2024",
"dedupe": "RING_RETAIN_ALL",
"fields": [
{
"value": "55555551212",
"dialerField": "leadPhone",
"type": "Phone"
},
{
"value": "12345",
"dialerField": "zip",
"type": "Zip"
},
{
"value": "New York",
"dialerField": "city",
"type": "City"
},
{
"value": "NY",
"dialerField": "state",
"type": "State"
},
{
"value": "55555551212",
"dialerField": "externId"
}
]
}
Amazon Pinpoint
Required: Phone, Zip
- dialerListId is not required for this integration
Dialer field values must match the Attributes configured for the Workspace. Dialer fields configured for the Workspace as Reserved Caller ID Field is required for this integration and cannot be mapped to supplied values.
{
"campaignId": "65ae6e4b6bf35b2344b109e5",
"listName": "Real Time Leads - Jan 2024",
"fields": [
{
"value": "55555551212",
"dialerField": "number1",
"type": "Phone"
},
{
"value": "12345",
"dialerField": "zip",
"type": "Zip"
},
{
"value": "New York",
"dialerField": "City",
"type": "City"
},
{
"value": "NY",
"dialerField": "State",
"type": "State"
}
]
}