{"info":{"_postman_id":"bc352a84-296e-42c8-8d95-e621de41904f","name":"Healthcare Solutions API Documentation","description":"

Collection of API for Healthcare Solutions

\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"12208069","collectionId":"bc352a84-296e-42c8-8d95-e621de41904f","publishedId":"2sBXcKBdPT","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"293250"},"publishDate":"2026-06-11T20:56:12.000Z"},"item":[{"name":"Lead Intake","id":"80d17a2e-e4bb-4ec3-a738-48d7f8d778e6","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n\t\"phone_number\": \"{{phone_number}}\",\n\t\"first_name\": \"{{first_name}}\",\n\t\"last_name\": \"{{last_name}}\",\n\t\"street\": \"{{street}}\",\n\t\"city\": \"{{city}}\",\n\t\"state\": \"{{state}}\",\n\t\"postal_code\": \"{{postal_code}}\",\n\t\"email\": \"{{email}}\",\n\t\"ipaddress\": \"{{ipaddress}}\",\n\t\"device\": \"{{device}}\",\n\t\"gender\": \"{{gender}}\",\n\t\"age\": \"{{age}}\",\n\t\"dateofbirth\": \"{{dateofbirth}}\",\n\t\"publisher\": \"{{publisher}}\",\n\t\"property\": \"{{property}}\",\n\t\"placement\": \"{{placement}}\",\n\t\"tfcertid\": \"{{tfcertid}}\",\n\t\"marketing_platform\": \"{{marketing_platform}}\",\n\t\"productinterest\": \"{{productinterest}}\",\n\t\"lead_source\": \"{{lead_source}}\",\n\t\"campaignname\": \"{{campaignname}}\",\n\t\"campaignid\": \"{{campaignid}}\",\n\t\"ad_name\": \"{{ad_name}}\",\n\t\"adid\": \"{{adid}}\",\n\t\"adsetname\": \"{{adsetname}}\",\n\t\"marketingleadid\": \"{{marketingleadid}}\"\n}","options":{"raw":{"language":"json"}}},"url":"https://lead.healthcaresolutions.net/api/insert","description":"

Lead Intake

\n

Submits a new lead into the Healthcare Solutions system.

\n
\n

Request Body Fields

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
FieldTypeDescription
phone_numberString(Required) Contact phone number for the lead. XXXXXXXXXX format
first_nameString(Required) Lead's first name
last_nameString(Required) Lead's last name
streetString(Optional) Street address of the lead
cityString(Optional) City of the lead's address
stateString(Optional) 2-letter U.S. state abbreviation (e.g. FL)
postal_codeString(Required) ZIP/postal code of the lead's address
emailString(Optional) Email address of the lead
ipaddressString(Optional) IP address captured at the time of lead submission
deviceString(Optional) Device type used by the lead (e.g. MOBILE, DESKTOP)
genderString(Optional) Gender of the lead
ageString(Optional) Age of the lead
dateofbirthString(Required) Date of birth in YYYY-MM-DD format
publisherString(Optional) Publisher identifier associated with the lead source
propertyString(Optional) Property from which the lead originated
placementString(Optional) Placement identifier for the ad or content unit
tfcertidString(Optional) TrustedForm certificate URL for consent verification
marketing_platformString(Optional) Platform or tool used to generate the lead
productinterestString(Required) The health product the lead is interested in. Accepted values: \"Medicare Supplement\", \"Medicare Advantage\", \"Final Expense\", \"ACA\"
lead_sourceString(Required) {Provided by Healthcare Solutions}
campaignnameString(Optional) Name of the marketing campaign associated with the lead
campaignidString(Optional) Unique identifier for the campaign
jornayatokenString(Optional) Jornaya lead token for TCPA compliance verification
SubIDString(Optional) Optional sub-identifier for tracking purposes
ad_nameString(Optional) Name of the ad unit
adidString(Optional) Unique identifier for the ad
adsetnameString(Optional) Name of the ad set
marketingleadidString(Optional) External marketing lead ID
## Notes
\n
\n
\n

Responses

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
HTTP StatusBodyWhen
200 OK\"Success\"The insert completed without throwing an exception
400 Bad Request\"Failure: {ex.Message}\"Any exception was thrown during processing
\n
","urlObject":{"protocol":"https","path":["api","insert"],"host":["lead","healthcaresolutions","net"],"query":[],"variable":[]}},"response":[{"id":"fa715dff-a026-448b-aa7c-55ff35917348","name":"Sample Lead Submission","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\t\"phone_number\": \"3059634999\",\n\t\"first_name\": \"Sasha\",\n\t\"last_name\": \"Barkov\",\n\t\"street\": \"123 Road St\",\n\t\"city\": \"Miami\",\n\t\"state\": \"FL\",\n\t\"postal_code\": \"33196\",\n\t\"email\": \"Barky@gopanthers.com\",\n\t\"ipaddress\": \"12.0.0.1\",\n\t\"device\": \"MOBILE\",\n\t\"gender\": \"Male\",\n\t\"age\": \"65\",\n\t\"dateofbirth\": \"1950-01-01\",\n\t\"publisher\": \"TestPub\",\n\t\"property\": \"TestProperty\",\n\t\"placement\": \"TestPlacement\",\n\t\"tfcertid\": \"https://trustedform.com/1231231231231\",\n\t\"marketing_platform\": \"TestPlatform\",\n\t\"productinterest\": \"Medicare Supplement\",\n\t\"lead_source\": \"{Provided by Healthcare Solutions}\",\n\t\"campaignname\": \"TestCampaignName\",\n\t\"campaignid\": \"TestCampaignID\",\n\t\"ad_name\": \"TestAdName\",\n\t\"adid\": \"TestAdID\",\n\t\"adsetname\": \"TestAdSetName\",\n\t\"marketingleadid\": \"TestMarketingLeadID\"\n}","options":{"raw":{"language":"json"}}},"url":"https://lead.healthcaresolutions.net/api/insert"},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"text/plain","enabled":true}],"cookie":[],"responseTime":null,"body":"Success"}],"_postman_id":"80d17a2e-e4bb-4ec3-a738-48d7f8d778e6"},{"name":"Agent Availability","event":[{"id":"b226fcce-ccc7-4e8f-8267-0ee5229d6a31","listen":"test","script":{"type":"text/javascript","exec":["pm.test(\"Status code is 200\", function () {"," pm.response.to.have.status(200);","});","","pm.test(\"Agents are available\", function () {"," const json = pm.response.json();"," pm.expect(json.availableAgents).to.be.above(0);","});"]}}],"id":"deeda69c-594a-4398-97d7-81b3deb906e7","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"body":{"mode":"raw","raw":"## Agent Availability Ping\n\nThis endpoint pings the Agent Availability service to retrieve real-time agent availability status for a given agent/campaign. It is used to monitor agent availability and call activity for a given campaign.\n\n**Base URL:** `https://api.healthcaresolutions.net/api/AgentAvailabilityPing`\n\n**Method:** `GET`\n\n---\n\n## Query Parameters\n\n| Parameter | Value | Description |\n| --- | --- | --- |\n| `code` | `{Provided by Healthcare Solutions}` | The API authorization code provided by Healthcare Solutions. Required for authenticating the request. |\n| `id` | `5905` | The Final Expense Campaign ID used to identify agents for availability. |\n| `queue_id` | `{queue_id}` | The unique identifier for the queue to check agent availability against. Provided by Healthcare Solutions. |\n\n---\n\n## Authentication\n\nAuthentication is handled via the `code` query parameter. This value is provided by Healthcare Solutions and must be included with every request.\n\n---\n\n## Example Request\n\n```\nGET https://api.healthcaresolutions.net/api/AgentAvailabilityPing?code={Provided by Healthcare Solutions}&id=5905&queue_id={queue_id}\n\n ```\n\n---\n\n## Response\n\nA successful request returns a `200 OK` response with the following JSON body:\n\n``` json\n{\n \"availableAgents\": 2\n}\n\n ```\n\n| Field | Type | Description |\n| --- | --- | --- |\n| `availableAgents` | `number` | The number of agents currently available. A value greater than `0` indicates agents are available. |\n\n### Availability Logic\n\n| `availableAgents` | Status |\n| --- | --- |\n| `> 0` | ✅ Agents available |\n| `0` | ❌ No agents available |\n\nAn invalid or missing `code` parameter will result in a `401 Unauthorized` response."},"url":"https://api.healthcaresolutions.net/api/AgentAvailabilityPing?code={Provided by Healthcare Solutions}&id=5905","description":"

Agent Availability Ping

\n

This endpoint pings the Agent Availability service to retrieve real-time agent availability status for a given agent/campaign. It is used to monitor agent availability and call activity for a given campaign.

\n

Base URL: https://api.healthcaresolutions.net/api/AgentAvailabilityPing

\n

Method: GET

\n
\n

Query Parameters

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterValueDescription
code{Provided by Healthcare Solutions}The API authorization code provided by Healthcare Solutions. Required for authenticating the request.
id5905The Final Expense Campaign ID used to identify agents for availability.
queue_id{Provided by Healthcare Solutions}The unique identifier for the queue to check agent availability against. Provided by Healthcare Solutions.
\n
\n

Authentication

\n

Authentication is handled via the code query parameter. This value is provided by Healthcare Solutions and must be included with every request.

\n
\n

Example Request

\n
GET https://api.healthcaresolutions.net/api/AgentAvailabilityPing?code={Provided by Healthcare Solutions}&id=5905&queue_id={Provided by Healthcare Solutions}\n\n
\n

Response

\n

A successful request returns a 200 OK response with the following JSON body:

\n
{\n    \"availableAgents\": 2\n}\n\n
\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
FieldTypeDescription
availableAgentsnumberThe number of agents currently available. A value greater than 0 indicates agents are available.
\n

Availability Logic

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
availableAgentsStatus
> 0✅ Agents available
0❌ No agents available
\n

An invalid or missing code parameter will result in a 401 Unauthorized response.

\n","urlObject":{"protocol":"https","path":["api","AgentAvailabilityPing"],"host":["api","healthcaresolutions","net"],"query":[{"description":{"content":"

The API authorization code provided by Healthcare Solutions. Required for authenticating the request.

\n","type":"text/plain"},"key":"code","value":"{Provided by Healthcare Solutions}"},{"description":{"content":"

The Final Expense Campaign ID used to identify agents for availability.

\n","type":"text/plain"},"key":"id","value":"5905"}],"variable":[]}},"response":[],"_postman_id":"deeda69c-594a-4398-97d7-81b3deb906e7"}]}