careCycle
CustomersPolicies

Update customer policy

Update an existing policy for a customer

PATCH
/v2/customers/{id}/policies/{policyId}

Authorization

x-api-key
x-api-key<token>

API key required for authentication.

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

In: header

Path Parameters

string

Customer ID

Match^([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)$Formatuuid
string

Policy ID

Match^([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)$Formatuuid

Request Body

application/json

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

TypeScript Definitions

Use the request body type in TypeScript.

string
Value in"MA" | "MAPD" | "PDP" | "MS" | "ACA" | "LTC" | "Individual Health" | "FE" | "Annuity" | "Life" | "Dental" | "Vision" | "Hospital Indemnity" | "Cancer" | "Accident" | "Group" | "Home Health Care"
string | null
Lengthlength <= 100
string | null
Lengthlength <= 255
string | null
Lengthlength <= 255
string | null
Match^([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)$Formatuuid
string | null
Lengthlength <= 255
string | null
Lengthlength <= 255
string | null
Lengthlength <= 255
string | null
Lengthlength <= 255
string | null
Lengthlength <= 255
string | null
Lengthlength <= 255
string | null
Lengthlength <= 255
string | null
Lengthlength <= 255
string | null
Value in"Catastrophic" | "Bronze" | "Expanded Bronze" | "Silver" | "Gold" | "Platinum"
string | null
Value in"Active" | "Placed" | "Pending" | "Pending Effectuation" | "Pending Followup" | "Suspended" | "Cancelled" | "Terminated" | "Future Cancel" | "Deceased" | "Not Approved"
string | null

Application approval date. Canonical format: YYYY-MM-DD

Formatdate
string | null

Policy effective date. Canonical format: YYYY-MM-DD

Formatdate
string | null

Policy termination date. Canonical format: YYYY-MM-DD

Formatdate
string | null

Policy renewal date. Canonical format: YYYY-MM-DD

Formatdate
string | null

Policy enrollment date. Canonical format: YYYY-MM-DD

Formatdate
string | null

Policy cancellation date. Canonical format: YYYY-MM-DD

Formatdate
string | null
string | null
string | null
string | null
string | null
Value in"IEP" | "AEP" | "OEP" | "SEP" | "ICEP" | "MA-OEP"
string | null

Grace period start date. Canonical format: YYYY-MM-DD

Formatdate
string | null

Coverage paid-through date. Canonical format: YYYY-MM-DD

Formatdate
string | null
Lengthlength <= 255
string | null
Lengthlength <= 255
string | null
Match^([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)$Formatuuid
string | null
Lengthlength <= 255
string | null
Lengthlength <= 255
string | null
Lengthlength <= 50
string | null
Lengthlength <= 50
string | null
Lengthlength <= 255
string | null
Lengthlength <= 255
string | null
Lengthlength <= 100
string | null

SEP start date. Canonical format: YYYY-MM-DD

Formatdate
string | null

SEP end date. Canonical format: YYYY-MM-DD

Formatdate
boolean | null
string | null

SEP documentation date. Canonical format: YYYY-MM-DD

Formatdate
string | null
string | null
string | null
string | null
string | null
boolean | null
string | null
Value in"Monthly" | "Quarterly" | "Semi-Annual" | "Annual"
string | null
Value in"ACH" | "Credit/ debit card" | "Direct bill"
string | null
Value in"Credit Card" | "Debit Card" | "Check" | "ACH / Bank Draft" | "Money Order" | "Cash" | "Other"
string | null
string | null
string | null
string | null
string | null
integer | null
Range-2147483648 <= value <= 2147483647
boolean | null
string | null
Value in"New Business" | "Like Plan Change" | "Unlike Plan Change" | "Reinstatement" | "Rewrite"
string | null
Lengthlength <= 255
boolean | null
string | null
Lengthlength <= 255
string | null
Lengthlength <= 255
boolean | null
string | null
integer | null
Range-2147483648 <= value <= 2147483647
integer | null
Range-2147483648 <= value <= 2147483647
boolean | null
string | null
integer | null
Range-2147483648 <= value <= 2147483647
string | null

Policy maturity date. Canonical format: YYYY-MM-DD

Formatdate
string | null
string | null
Value in"FFM" | "SBM" | "SBM FP" | "OFF EXCHANGE" | "PRIVATE EXCHANGE" | "UNKNOWN"
string | null
Lengthlength <= 100
string | null

Benefit reminder date. Canonical format: YYYY-MM-DD

Formatdate
boolean | null
string | null
string | null

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X PATCH "https://api.carecycle.ai/v2/customers/497f6eca-6276-4993-bfeb-53cbbbba6f08/policies/497f6eca-6276-4993-bfeb-53cbbbba6f08" \  -H "Content-Type: application/json" \  -d '{}'
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "createdAt": "2019-08-24T14:15:22Z",
  "createdBy": "25a02396-1048-48f9-bf93-102d2fb7895e",
  "updatedAt": "2019-08-24T14:15:22Z",
  "updatedBy": "b0efe45f-0520-4e21-90f0-7e35f137732e",
  "customerId": "87d8e330-2878-4742-a86f-dbbb3bf522ac",
  "policyType": "MA",
  "policySubType": "string",
  "policyNumber": "string",
  "applicationId": "string",
  "carrierId": "81a9910c-2657-4f54-9feb-7f6d85d613bc",
  "carrierName": "string",
  "planName": "string",
  "planCode": "string",
  "carrierAssignedPolicyId": "string",
  "healthSherpaPolicyId": "string",
  "sunFireEnrollmentCode": "string",
  "connectureConfirmationNumber": "string",
  "hiosId": "string",
  "metalLevel": "Catastrophic",
  "status": "Active",
  "applicationApprovalDate": "2019-08-24",
  "effectiveDate": "2019-08-24",
  "terminationDate": "2019-08-24",
  "renewalDate": "2019-08-24",
  "enrollmentDate": "2019-08-24",
  "cancelledDate": "2019-08-24",
  "declineReason": "string",
  "declineReasonDescription": "string",
  "cancellationReason": "string",
  "cancellationReasonDescription": "string",
  "electionPeriod": "IEP",
  "gracePeriodStartDate": "2019-08-24",
  "paidThroughDate": "2019-08-24",
  "ffmApplicationId": "string",
  "ffmSubscriberId": "string",
  "aorAgentId": "b69824d9-b3c3-46ff-b624-5d3573bdf8fa",
  "aorFirstName": "string",
  "aorLastName": "string",
  "aorNpn": "string",
  "writingAgentNpn": "string",
  "writingAgentName": "string",
  "sepType": "string",
  "sepCode": "string",
  "sepStartDate": "2019-08-24",
  "sepEndDate": "2019-08-24",
  "sepDocumentationReceived": true,
  "sepDocumentationDate": "2019-08-24",
  "sepNotes": "string",
  "monthlyPremium": "string",
  "deductible": "string",
  "outOfPocketMax": "string",
  "subsidyAmount": "string",
  "usingSubsidy": true,
  "premiumMode": "Monthly",
  "paymentMode": "ACH",
  "paymentMethod": "Credit Card",
  "grossPremium": "string",
  "netPremium": "string",
  "initialCommission": "string",
  "renewalCommission": "string",
  "spifAmount": "string",
  "policyLives": -2147483648,
  "wasAgent": true,
  "writtenAs": "New Business",
  "isReplacing": "string",
  "isRewrite": true,
  "hospitalNetwork": "string",
  "pcpNetwork": "string",
  "ssbciVerificationRequired": true,
  "dailyBenefit": "string",
  "eliminationPeriod": -2147483648,
  "benefitPeriod": -2147483648,
  "hasCola": true,
  "deathBenefit": "string",
  "term": -2147483648,
  "maturityDate": "2019-08-24",
  "riders": "string",
  "exchangeStatus": "FFM",
  "billingMethod": "string",
  "benefitReminder": "2019-08-24",
  "surveyCompleted": true,
  "reasonForPurchase": "string",
  "policyNotes": "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"
    }
  ],
  "failedRecords": [
    {
      "index": 0,
      "phoneNumber": "string",
      "firstName": "string",
      "lastName": "string",
      "externalId": "string"
    }
  ]
}
{
  "message": "string",
  "code": "string",
  "retryAfter": 0
}
{
  "message": "string",
  "code": "string"
}

Delete customer policy DELETE

Previous Page

Create customer prescription POST

Next Page