Upload lead records
Authorization
x-api-key API key required for authentication.
Keys begin with 'cc_' prefix. Get your API key from the Developer Dashboard.
In: header
Request Body
application/json
POST /v2/leads/upload Request body
TypeScript Definitions
Use the request body type in TypeScript.
Array of lead records to upload (1-200)
Customer phone number (required). Accepts: +1XXXXXXXXXX, XXXXXXXXXX, (XXX) XXX-XXXX
Customer first name
Customer last name
Customer postal code. Required if timezone is not provided (for TCPA compliance).
Customer timezone. Required if postalCode is not provided (for TCPA compliance). Accepts IANA format (America/New_York) or abbreviations (EST, CST, MST, PST).
Customer date of birth. Format: MM-DD-YYYY or MM/DD/YYYY
Carrier-assigned customer ID
Health Sherpa customer ID
Medicare Beneficiary Identifier
Your external system identifier for this customer
Custom field values (max 50) Your Custom Field keys can be found here in your settings
Custom field key (e.g., 'lead_source', 'utm_campaign')
Value for the custom field
Response Body
application/json
application/json
application/json
application/json
application/json
application/json
application/json
application/json
curl -X POST "https://api.carecycle.ai/v2/leads/upload" \ -H "Content-Type: application/json" \ -d '{ "records": [ { "phoneNumber": "string" } ] }'{
"succeeded": 0,
"failed": 0,
"errors": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"externalId": "string",
"error": "string"
}
]
}{
"message": "string",
"code": "string"
}{
"message": "string",
"code": "string"
}{
"message": "string",
"code": "string"
}{
"message": "string",
"code": "string"
}{
"message": "string",
"code": "VALIDATION_ERROR",
"errors": [
{
"path": [
"string"
],
"message": "string",
"expected": "string",
"received": "string",
"code": "string"
}
]
}{
"message": "string",
"code": "string",
"retryAfter": 0
}{
"message": "string",
"code": "string"
}