Skip to main content
PATCH
/
v2
/
customers
/
{id}
/
policies
/
{policyId}
Update customer policy
curl --request PATCH \
  --url https://api.carecycle.ai/v2/customers/{id}/policies/{policyId} \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "createdBy": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "updatedBy": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "customerId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "policyType": "MA",
  "policySubType": "<string>",
  "policyNumber": "<string>",
  "applicationId": "<string>",
  "carrierName": "<string>",
  "planName": "<string>",
  "planCode": "<string>",
  "planState": "<string>",
  "planCounty": "<string>",
  "carrierAssignedPolicyId": "<string>",
  "healthSherpaPolicyId": "<string>",
  "sunFireEnrollmentCode": "<string>",
  "hiosId": "<string>",
  "metalLevel": "Catastrophic",
  "status": "Active",
  "applicationApprovalDate": "<string>",
  "effectiveDate": "<string>",
  "terminationDate": "<string>",
  "renewalDate": "<string>",
  "enrollmentDate": "<string>",
  "cancelledDate": "<string>",
  "electionPeriod": "IEP",
  "gracePeriodStartDate": "<string>",
  "paidThroughDate": "<string>",
  "ffmApplicationId": "<string>",
  "ffmSubscriberId": "<string>",
  "aorAgentId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "aorFirstName": "<string>",
  "aorLastName": "<string>",
  "aorNpn": "<string>",
  "writingAgentNpn": "<string>",
  "writingAgentName": "<string>",
  "sepType": "<string>",
  "sepCode": "<string>",
  "sepStartDate": "<string>",
  "sepEndDate": "<string>",
  "sepDocumentationReceived": true,
  "sepDocumentationDate": "<string>",
  "sepNotes": "<string>",
  "monthlyPremium": "<string>",
  "deductible": "<string>",
  "outOfPocketMax": "<string>",
  "subsidyAmount": "<string>",
  "usingSubsidy": true,
  "premiumMode": "Monthly",
  "grossPremium": "<string>",
  "netPremium": "<string>",
  "initialCommission": "<string>",
  "renewalCommission": "<string>",
  "spifAmount": "<string>",
  "policyLives": -1,
  "wasAgent": true,
  "writtenAs": "New Business",
  "isReplacing": "<string>",
  "isRewrite": true,
  "hospitalNetwork": "<string>",
  "pcpNetwork": "<string>",
  "dailyBenefit": "<string>",
  "eliminationPeriod": -1,
  "benefitPeriod": -1,
  "hasCola": true,
  "deathBenefit": "<string>",
  "term": -1,
  "maturityDate": "<string>",
  "riders": "<string>",
  "exchangeStatus": "FFM",
  "billingMethod": "<string>",
  "benefitReminder": "<string>",
  "surveyCompleted": true,
  "reasonForPurchase": "<string>",
  "policyNotes": "<string>"
}
'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "createdAt": "<string>",
  "createdBy": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "updatedAt": "<string>",
  "updatedBy": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "customerId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "policyType": "MA",
  "policySubType": "<string>",
  "policyNumber": "<string>",
  "applicationId": "<string>",
  "carrierName": "<string>",
  "planName": "<string>",
  "planCode": "<string>",
  "planState": "<string>",
  "planCounty": "<string>",
  "carrierAssignedPolicyId": "<string>",
  "healthSherpaPolicyId": "<string>",
  "sunFireEnrollmentCode": "<string>",
  "hiosId": "<string>",
  "metalLevel": "Catastrophic",
  "status": "Active",
  "applicationApprovalDate": "<string>",
  "effectiveDate": "<string>",
  "terminationDate": "<string>",
  "renewalDate": "<string>",
  "enrollmentDate": "<string>",
  "cancelledDate": "<string>",
  "electionPeriod": "IEP",
  "gracePeriodStartDate": "<string>",
  "paidThroughDate": "<string>",
  "ffmApplicationId": "<string>",
  "ffmSubscriberId": "<string>",
  "aorAgentId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "aorFirstName": "<string>",
  "aorLastName": "<string>",
  "aorNpn": "<string>",
  "writingAgentNpn": "<string>",
  "writingAgentName": "<string>",
  "sepType": "<string>",
  "sepCode": "<string>",
  "sepStartDate": "<string>",
  "sepEndDate": "<string>",
  "sepDocumentationReceived": true,
  "sepDocumentationDate": "<string>",
  "sepNotes": "<string>",
  "monthlyPremium": "<string>",
  "deductible": "<string>",
  "outOfPocketMax": "<string>",
  "subsidyAmount": "<string>",
  "usingSubsidy": true,
  "premiumMode": "Monthly",
  "grossPremium": "<string>",
  "netPremium": "<string>",
  "initialCommission": "<string>",
  "renewalCommission": "<string>",
  "spifAmount": "<string>",
  "policyLives": -1,
  "wasAgent": true,
  "writtenAs": "New Business",
  "isReplacing": "<string>",
  "isRewrite": true,
  "hospitalNetwork": "<string>",
  "pcpNetwork": "<string>",
  "dailyBenefit": "<string>",
  "eliminationPeriod": -1,
  "benefitPeriod": -1,
  "hasCola": true,
  "deathBenefit": "<string>",
  "term": -1,
  "maturityDate": "<string>",
  "riders": "<string>",
  "exchangeStatus": "FFM",
  "billingMethod": "<string>",
  "benefitReminder": "<string>",
  "surveyCompleted": true,
  "reasonForPurchase": "<string>",
  "policyNotes": "<string>"
}

Authorizations

​
x-api-key
string
header
required

API key required for authentication.

Keys begin with 'cc_' prefix. Get your API key from the Developer Dashboard.

Path Parameters

​
id
string<uuid>
required

Customer ID

Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
​
policyId
string<uuid>
required

Policy ID

Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$

Body

application/json

PATCH /v2/customers/:id/policies/:policyId Request body

​
createdBy
string<uuid> | null
Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
​
updatedBy
string<uuid> | null
Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
​
customerId
string<uuid>
Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
​
policyType
enum<string>
Available options:
MA,
MAPD,
PDP,
MS,
ACA,
LTC,
Individual Health,
FE,
Annuity,
Life,
Dental,
Vision,
Hospital Indemnity,
Cancer,
Accident,
Group
​
policySubType
string | null
Maximum string length: 100
​
policyNumber
string | null
Maximum string length: 255
​
applicationId
string | null
Maximum string length: 255
​
carrierName
string | null
Maximum string length: 255
​
planName
string | null
Maximum string length: 255
​
planCode
string | null
Maximum string length: 255
​
planState
string | null
Maximum string length: 2
​
planCounty
string | null
Maximum string length: 255
​
carrierAssignedPolicyId
string | null
Maximum string length: 255
​
healthSherpaPolicyId
string | null
Maximum string length: 255
​
sunFireEnrollmentCode
string | null
Maximum string length: 255
​
hiosId
string | null
Maximum string length: 255
​
metalLevel
enum<string> | null
Available options:
Catastrophic,
Bronze,
Silver,
Gold,
Platinum
​
status
enum<string> | null
Available options:
Active,
Pending,
Pending Effectuation,
Pending Followup,
Suspended,
Cancelled,
Terminated,
Future Cancel,
Deceased,
Not Approved
​
applicationApprovalDate
string | null
​
effectiveDate
string | null
​
terminationDate
string | null
​
renewalDate
string | null
​
enrollmentDate
string | null
​
cancelledDate
string | null
​
electionPeriod
enum<string> | null
Available options:
IEP,
AEP,
OEP,
SEP,
ICEP,
MA-OEP
​
gracePeriodStartDate
string | null
​
paidThroughDate
string | null
​
ffmApplicationId
string | null
Maximum string length: 255
​
ffmSubscriberId
string | null
Maximum string length: 255
​
aorAgentId
string<uuid> | null
Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
​
aorFirstName
string | null
Maximum string length: 255
​
aorLastName
string | null
Maximum string length: 255
​
aorNpn
string | null
Maximum string length: 50
​
writingAgentNpn
string | null
Maximum string length: 50
​
writingAgentName
string | null
Maximum string length: 255
​
sepType
string | null
Maximum string length: 255
​
sepCode
string | null
Maximum string length: 100
​
sepStartDate
string | null
​
sepEndDate
string | null
​
sepDocumentationReceived
boolean | null
​
sepDocumentationDate
string | null
​
sepNotes
string | null
​
monthlyPremium
string | null
​
deductible
string | null
​
outOfPocketMax
string | null
​
subsidyAmount
string | null
​
usingSubsidy
boolean | null
​
premiumMode
enum<string> | null
Available options:
Monthly,
Quarterly,
Semi-Annual,
Annual
​
grossPremium
string | null
​
netPremium
string | null
​
initialCommission
string | null
​
renewalCommission
string | null
​
spifAmount
string | null
​
policyLives
integer | null
Required range: -2147483648 <= x <= 2147483647
​
wasAgent
boolean | null
​
writtenAs
enum<string> | null
Available options:
New Business,
Like Plan Change,
Unlike Plan Change,
Reinstatement,
Rewrite
​
isReplacing
string | null
Maximum string length: 255
​
isRewrite
boolean | null
​
hospitalNetwork
string | null
Maximum string length: 255
​
pcpNetwork
string | null
Maximum string length: 255
​
dailyBenefit
string | null
​
eliminationPeriod
integer | null
Required range: -2147483648 <= x <= 2147483647
​
benefitPeriod
integer | null
Required range: -2147483648 <= x <= 2147483647
​
hasCola
boolean | null
​
deathBenefit
string | null
​
term
integer | null
Required range: -2147483648 <= x <= 2147483647
​
maturityDate
string | null
​
riders
string | null
​
exchangeStatus
enum<string> | null
Available options:
FFM,
SBM,
SBM FP,
OFF EXCHANGE,
PRIVATE EXCHANGE,
UNKNOWN
​
billingMethod
string | null
Maximum string length: 100
​
benefitReminder
string | null
​
surveyCompleted
boolean | null
​
reasonForPurchase
string | null
​
policyNotes
string | null

Response

PATCH /v2/customers/:id/policies/:policyId Positive response

​
id
string<uuid>
required
Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
​
createdAt
string | null
required
​
createdBy
string<uuid> | null
required
Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
​
updatedAt
string | null
required
​
updatedBy
string<uuid> | null
required
Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
​
customerId
string<uuid>
required
Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
​
policyType
enum<string>
required
Available options:
MA,
MAPD,
PDP,
MS,
ACA,
LTC,
Individual Health,
FE,
Annuity,
Life,
Dental,
Vision,
Hospital Indemnity,
Cancer,
Accident,
Group
​
policySubType
string | null
required
Maximum string length: 100
​
policyNumber
string | null
required
Maximum string length: 255
​
applicationId
string | null
required
Maximum string length: 255
​
carrierName
string | null
required
Maximum string length: 255
​
planName
string | null
required
Maximum string length: 255
​
planCode
string | null
required
Maximum string length: 255
​
planState
string | null
required
Maximum string length: 2
​
planCounty
string | null
required
Maximum string length: 255
​
carrierAssignedPolicyId
string | null
required
Maximum string length: 255
​
healthSherpaPolicyId
string | null
required
Maximum string length: 255
​
sunFireEnrollmentCode
string | null
required
Maximum string length: 255
​
hiosId
string | null
required
Maximum string length: 255
​
metalLevel
enum<string> | null
required
Available options:
Catastrophic,
Bronze,
Silver,
Gold,
Platinum
​
status
enum<string> | null
required
Available options:
Active,
Pending,
Pending Effectuation,
Pending Followup,
Suspended,
Cancelled,
Terminated,
Future Cancel,
Deceased,
Not Approved
​
applicationApprovalDate
string | null
required
​
effectiveDate
string | null
required
​
terminationDate
string | null
required
​
renewalDate
string | null
required
​
enrollmentDate
string | null
required
​
cancelledDate
string | null
required
​
electionPeriod
enum<string> | null
required
Available options:
IEP,
AEP,
OEP,
SEP,
ICEP,
MA-OEP
​
gracePeriodStartDate
string | null
required
​
paidThroughDate
string | null
required
​
ffmApplicationId
string | null
required
Maximum string length: 255
​
ffmSubscriberId
string | null
required
Maximum string length: 255
​
aorAgentId
string<uuid> | null
required
Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
​
aorFirstName
string | null
required
Maximum string length: 255
​
aorLastName
string | null
required
Maximum string length: 255
​
aorNpn
string | null
required
Maximum string length: 50
​
writingAgentNpn
string | null
required
Maximum string length: 50
​
writingAgentName
string | null
required
Maximum string length: 255
​
sepType
string | null
required
Maximum string length: 255
​
sepCode
string | null
required
Maximum string length: 100
​
sepStartDate
string | null
required
​
sepEndDate
string | null
required
​
sepDocumentationReceived
boolean | null
required
​
sepDocumentationDate
string | null
required
​
sepNotes
string | null
required
​
monthlyPremium
string | null
required
​
deductible
string | null
required
​
outOfPocketMax
string | null
required
​
subsidyAmount
string | null
required
​
usingSubsidy
boolean | null
required
​
premiumMode
enum<string> | null
required
Available options:
Monthly,
Quarterly,
Semi-Annual,
Annual
​
grossPremium
string | null
required
​
netPremium
string | null
required
​
initialCommission
string | null
required
​
renewalCommission
string | null
required
​
spifAmount
string | null
required
​
policyLives
integer | null
required
Required range: -2147483648 <= x <= 2147483647
​
wasAgent
boolean | null
required
​
writtenAs
enum<string> | null
required
Available options:
New Business,
Like Plan Change,
Unlike Plan Change,
Reinstatement,
Rewrite
​
isReplacing
string | null
required
Maximum string length: 255
​
isRewrite
boolean | null
required
​
hospitalNetwork
string | null
required
Maximum string length: 255
​
pcpNetwork
string | null
required
Maximum string length: 255
​
dailyBenefit
string | null
required
​
eliminationPeriod
integer | null
required
Required range: -2147483648 <= x <= 2147483647
​
benefitPeriod
integer | null
required
Required range: -2147483648 <= x <= 2147483647
​
hasCola
boolean | null
required
​
deathBenefit
string | null
required
​
term
integer | null
required
Required range: -2147483648 <= x <= 2147483647
​
maturityDate
string | null
required
​
riders
string | null
required
​
exchangeStatus
enum<string> | null
required
Available options:
FFM,
SBM,
SBM FP,
OFF EXCHANGE,
PRIVATE EXCHANGE,
UNKNOWN
​
billingMethod
string | null
required
Maximum string length: 100
​
benefitReminder
string | null
required
​
surveyCompleted
boolean | null
required
​
reasonForPurchase
string | null
required
​
policyNotes
string | null
required