Customers
Create customer
Add a new customer. Each customer needs a phone number that no other customer in your organization has.
post/v2/customers
Request
- Base URLhttps://api.carecycle.ai
- URLhttps://api.carecycle.ai/v2/customers
- AuthAPI key in header x-api-key
Request body
clientCustomerIdstring nullable
status'Lead' | 'Active' | 'Inactive' | 'null' nullable
qualificationStatus'Qualified' | 'Disqualified' | 'Pending Review' | 'Needs Information' | 'In Progress' | 'null' nullable
intent'High' | 'Medium' | 'Low' | 'Unknown' | 'null' nullable
isDecisionMakerboolean nullable
disqualificationReasonstring nullable
productIntereststring nullable
productFamilystring nullable
salutationstring nullable
suffixstring nullable
firstNamestring nullable
middleNamestring nullable
lastNamestring nullable
preferredNamestring nullable
lineType'landline' | 'mobile' | 'fixedVoip' | 'nonFixedVoip' | 'personal' | 'tollFree' | 'premium' | 'sharedCost' | 'uan' | 'voicemail' | 'pager' | 'unknown' | 'null' nullable
emailstring nullable
languagestring nullable
ethnicitystring nullable
gender'Male' | 'Female' | 'Non-Binary' | 'Other' | 'Prefer Not to Say' | 'null' nullable
maritalStatus'Single' | 'Married' | 'Divorced' | 'Widowed' | 'Separated' | 'Domestic Partnership' | 'null' nullable
heightInchesinteger nullable
weightPoundsinteger nullable
smokerStatusboolean nullable
postalCodestring nullable
timezonestring nullable
statestring nullable
citystring nullable
countystring nullable
countyFipsstring nullable
addressstring nullable
address2string nullable
mbiNumberstring nullable
medicareCardboolean nullable
medicaidboolean nullable
medicaidNumberstring nullable
socialSecurityDisabilityboolean nullable
veteranboolean nullable
vaNumberstring nullable
healthSherpaCustomerIdstring nullable
householdIncomeinteger nullable
annualIncomeinteger nullable
filingStatusstring nullable
dependentCountinteger nullable
subsidyAmountinteger nullable
subsidyEligibleboolean nullable
existingCoverage'None' | 'Medicare Advantage' | 'Original Medicare' | 'Medicaid' | 'Employer' | 'Marketplace/ACA' | 'Other' | 'null' nullable
existingCoveragePlanNamestring nullable
existingCoverageCarrierstring nullable
currentSourceIdstring uuid nullable
originalSourceIdstring uuid nullable
agentNamestring nullable
agentNpninteger nullable
memberIdstring uuid nullable
carrierNamestring nullable
planNamestring nullable
planCodestring nullable
carrierAssignedCustomerIdstring nullable
doNotCallboolean nullable
doNotSMSboolean nullable
doNotEmailboolean nullable
doNotMailboolean nullable
testCustomerboolean
phoneNumberstring required
Customer phone number. Accepts common formats and is normalized to E.164 (e.g. +14155550123); must be unique within your organization.
Response
POST /v2/customers Positive response
idstring uuid required
createdAtstring date-time nullable required
Customer creation time. ISO 8601 timestamp
createdBystring uuid nullable required
updatedAtstring date-time nullable required
Customer last update time. ISO 8601 timestamp
updatedBystring uuid nullable required
clientIdstring uuid required
clientCustomerIdstring nullable required
status'Lead' | 'Active' | 'Inactive' | 'null' nullable required
qualificationStatus'Qualified' | 'Disqualified' | 'Pending Review' | 'Needs Information' | 'In Progress' | 'null' nullable required
intent'High' | 'Medium' | 'Low' | 'Unknown' | 'null' nullable required
isDecisionMakerboolean nullable required
disqualificationReasonstring nullable required
productIntereststring nullable required
productFamilystring nullable required
salutationstring nullable required
suffixstring nullable required
firstNamestring nullable required
middleNamestring nullable required
lastNamestring nullable required
preferredNamestring nullable required
callerIdstring required
isPhonePrimaryboolean required
lineType'landline' | 'mobile' | 'fixedVoip' | 'nonFixedVoip' | 'personal' | 'tollFree' | 'premium' | 'sharedCost' | 'uan' | 'voicemail' | 'pager' | 'unknown' | 'null' nullable required
emailstring nullable required
dateOfBirthstring date nullable required
Customer date of birth. Canonical format: YYYY-MM-DD
languagestring nullable required
ethnicitystring nullable required
gender'Male' | 'Female' | 'Non-Binary' | 'Other' | 'Prefer Not to Say' | 'null' nullable required
maritalStatus'Single' | 'Married' | 'Divorced' | 'Widowed' | 'Separated' | 'Domestic Partnership' | 'null' nullable required
heightInchesinteger nullable required
weightPoundsinteger nullable required
smokerStatusboolean nullable required
postalCodestring nullable required
timezonestring nullable required
statestring nullable required
citystring nullable required
countystring nullable required
countyFipsstring nullable required
addressstring nullable required
address2string nullable required
mbiNumberstring nullable required
medicareCardboolean nullable required
medicarePartADatestring date nullable required
Medicare Part A effective date. Canonical format: YYYY-MM-DD
medicarePartBDatestring date nullable required
Medicare Part B effective date. Canonical format: YYYY-MM-DD
medicaidboolean nullable required
medicaidNumberstring nullable required
socialSecurityDisabilityboolean nullable required
veteranboolean nullable required
vaNumberstring nullable required
healthSherpaCustomerIdstring nullable required
householdIncomeinteger nullable required
annualIncomeinteger nullable required
filingStatusstring nullable required
dependentCountinteger nullable required
subsidyAmountinteger nullable required
subsidyEligibleboolean nullable required
existingCoverage'None' | 'Medicare Advantage' | 'Original Medicare' | 'Medicaid' | 'Employer' | 'Marketplace/ACA' | 'Other' | 'null' nullable required
existingCoveragePlanNamestring nullable required
existingCoverageCarrierstring nullable required
desiredCoverageStartDatestring date nullable required
Desired coverage start date. Canonical format: YYYY-MM-DD
currentSourceIdstring uuid nullable required
originalSourceIdstring uuid nullable required
agentNamestring nullable required
agentNpninteger nullable required
memberIdstring uuid nullable required
carrierNamestring nullable required
planNamestring nullable required
planCodestring nullable required
enrollmentDatestring date nullable required
Customer enrollment date. Canonical format: YYYY-MM-DD
effectiveDatestring date nullable required
Customer coverage effective date. Canonical format: YYYY-MM-DD
carrierAssignedCustomerIdstring nullable required
suppressedboolean required
doNotCallboolean nullable required
doNotSMSboolean nullable required
doNotEmailboolean nullable required
doNotMailboolean nullable required
lastContactedAtstring date-time nullable required
Customer last contact time. ISO 8601 timestamp
convertedAtstring date-time nullable required
Customer conversion time. ISO 8601 timestamp
testCustomerboolean required
ssnLast4string nullable required
Changes
No recorded changes to this operation across all 2 revisions of this API.