careCycle
Sync

Sync ACA customers and policies

POST
/v2/sync/aca

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

Request Body

application/json

POST /v2/sync/aca Request body

TypeScript Definitions

Use the request body type in TypeScript.

array<object>

Array of ACA customer/policy records to sync (1-100)

Items1 <= items <= 100
string

Customer first name (required)

Lengthlength <= 255
string

Customer last name (required)

Lengthlength <= 255
string

Customer phone number (required). Accepts: +1XXXXXXXXXX, XXXXXXXXXX, (XXX) XXX-XXXX

string | null
Lengthlength <= 255
string | null

Customer postal code. Required if timezone is not provided (for TCPA compliance).

Length5 <= length <= 5
string | null

Customer timezone. Required if postalCode is not provided (for TCPA compliance). Accepts IANA format (America/New_York) or abbreviations (EST, CST, MST, PST).

string | null
Lengthlength <= 50
string | null
Lengthlength <= 255
string | null
Lengthlength <= 255
string | null
Lengthlength <= 255
string | null
Lengthlength <= 255
string | null

Customer date of birth. Format: MM-DD-YYYY or MM/DD/YYYY

Match^(0[1-9]|1[0-2])[-/](0[1-9]|[12]\d|3[01])[-/]\d{4}$
string | null
Lengthlength <= 50
string | null
Value in"Male" | "Female" | "Non-Binary" | "Other" | "Prefer Not to Say"
string | null
Value in"Single" | "Married" | "Divorced" | "Widowed" | "Separated" | "Domestic Partnership"
string | null
Lengthlength <= 50
integer | null
Range-2147483648 <= value <= 2147483647
integer | null
Range-2147483648 <= value <= 2147483647
boolean | null
boolean | null
string | null
Lengthlength <= 255
boolean | null
string | null
Lengthlength <= 255
boolean | null
string | null

Carrier-assigned customer ID

Lengthlength <= 255
boolean | null
boolean | null
boolean | null
boolean | null
string | null

Health Sherpa customer ID

Lengthlength <= 255
string | null

Your external system identifier for this customer

Lengthlength <= 255
array<object>

Custom field values (max 50) Your Custom Field keys can be found here in your settings

Itemsitems <= 50
string

Custom field key (e.g., 'lead_source', 'utm_campaign')

Length1 <= length <= 100
string | number | boolean | array<string> | null

Value for the custom field

array<object>

ACA policies to sync (max 10). policyType is set automatically to 'ACA'.

Itemsitems <= 10
string | null

Name of the policy

Lengthlength <= 255
string | null

Plan code of the policy

Lengthlength <= 255
string | null

Name of the carrier

Lengthlength <= 255
string | null
string | null
string | null

Agent Of Record NPN

Lengthlength <= 50
string | null
Lengthlength <= 50
string | null
Lengthlength <= 255
string | null
Lengthlength <= 100
string | null
Lengthlength <= 255
string | null

2 Letter State of the policy

Lengthlength <= 2
string | null
Lengthlength <= 255
string | null

Carrier-assigned policy ID (secondary identifier for matching)

Lengthlength <= 255
string | null

The current status of the policy

Default"Active"Value in"Active" | "Pending" | "Pending Effectuation" | "Pending Followup" | "Suspended" | "Cancelled" | "Terminated" | "Future Cancel" | "Deceased" | "Not Approved"
string | null
string | null
string | null
string | null
string | null
Value in"IEP" | "AEP" | "OEP" | "SEP" | "ICEP" | "MA-OEP"
string | null

Agent Of Record First Name

Lengthlength <= 255
string | null

Agent Of Record Last Name

Lengthlength <= 255
string | null
Lengthlength <= 255
string | null
Lengthlength <= 255
string | null
Lengthlength <= 100
string | null
string | null
boolean | null
string | null
string | null
string | null
string | null
string | null
string | null
string | null
string | null
integer | null

Number of lives covered by the policy

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
string | null
string | null

Health Sherpa policy ID (primary identifier for matching)

Lengthlength <= 255
string | null
Lengthlength <= 255
string | null
Value in"Catastrophic" | "Bronze" | "Expanded Bronze" | "Silver" | "Gold" | "Platinum"
string | null
string | null
string | null
Lengthlength <= 255
string | null
Lengthlength <= 255
string | null
boolean | null
string | null
Value in"Monthly" | "Quarterly" | "Semi-Annual" | "Annual"
string | null
string | null
string | null
Value in"FFM" | "SBM" | "SBM FP" | "OFF EXCHANGE" | "PRIVATE EXCHANGE" | "UNKNOWN"

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/sync/aca" \  -H "Content-Type: application/json" \  -d '{    "records": [      {        "firstName": "string",        "lastName": "string",        "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"
}

Upload lead records POST

Previous Page

Sync Medicare customers and policies POST

Next Page