Sync
ACA

Sync ACA customers and policies

Create or update ACA customers and their policies in one request.

Customer matching (first identifier present wins): healthSherpaCustomerId → externalId → carrierAssignedCustomerId → fallback on firstName + lastName + dateOfBirth + phoneNumber.

Policy matching: healthSherpaPolicyId, then carrierAssignedPolicyId.

Custom fields: Put customer values in records[].customFields and policy values in records[].policies[].customFields. Each entry uses a configured fieldKey and value. Find keys in Customer Custom Fields and Policy Custom Fields. Policy values are attached to the policy created or matched by the containing policy object.

When a new policy is created, the customer's existing ACA policies with an effectiveDate more than one year old are terminated. policyType is always set to ACA.

Response: For each successfully synced record, results contains the full customer record (same shape as the customer.created/customer.updated webhook) along with the policies this request changed: those created or updated from the request, plus any older policies auto-terminated as a side effect. The customer's untouched existing policies are not returned. Each returned policy carries a previousStatus field (its status before this request, or null if newly created); compare it with the policy's status to detect a flip; e.g. an auto-terminated policy comes back with previousStatus: "Active" and status: "Terminated".

post/v2/sync/aca

Request

  • Base URL
    https://api.carecycle.ai
  • URL
    https://api.carecycle.ai/v2/sync/aca
  • Auth
    API key in header x-api-key

Request body

Example request

{
  "records": [
    {
      "policies": [
        {
          "planName": "Medicare Elite",
          "planCode": "H1290-036-001",
          "carrierName": "Aetna",
          "aorFirstName": "John",
          "aorLastName": "Doe",
          "aorNpn": "123456789",
          "policyLives": 3
        }
      ]
    }
  ]
}

Response

POST /v2/sync/aca Positive response

succeedednumber required

Number of successfully synced records

failednumber required

Number of failed records

Changes

No recorded changes to this operation across all 2 revisions of this API.