Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.helloannie.com/llms.txt

Use this file to discover all available pages before exploring further.

Insurance configurations help your agent answer coverage questions accurately. Instead of burying insurance info in FAQs, use the dedicated insurance module so Annie can respond intelligently to questions like “Do you take my insurance?” Use insurances for:
  • Which providers you accept
  • In-network vs out-of-network status
  • Plan-specific notes (PPO vs HMO, filing policies)

​
Creating an Insurance

const response = await fetch(
  "https://api.helloannie.com/v1/organizations/YOUR_ORG_ID/insurances",
  {
    method: "POST",
    headers: {
      "Authorization": "Bearer YOUR_API_KEY",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      name: "Delta Dental",
      type: "PPO",
      status: "IN_NETWORK",
      notes: "Premier and PPO plans accepted"
    })
  }
)

​
Insurance Fields

​
name
string
required
The insurance provider name. Annie matches this case-insensitively against known providers.Example: "Delta Dental", "Cigna", "Aetna"
​
type
string
required
The plan type.Options: PPO, HMO, EPO, MEDICAID, MEDICARE
​
status
string
required
Your acceptance status for this insurance.
StatusMeaning
IN_NETWORKYou’re an in-network provider
ACCEPTEDYou accept the insurance. Similar to CAN_FILE, but helps adjust verbiage to be less direct about being out of network.
CAN_FILESimilar to ACCEPTED, but more direct about being out of network. Means you can file claims on the patient’s behalf
CONDITIONALAccepted with conditions (explain in notes)
NOT_ACCEPTEDYou don’t accept this insurance
​
notes
string
Additional context Annie can use when discussing this insurance.Example: "Premier and PPO plans only. HMO plans not accepted."

Insurances API

See the full API reference for insurance endpoints.