Insurance Developer Guide

Get Started with Insurance Developer Resources
Insurance Brokerage
Insurance Claims Management
Insurance Group Benefits
Insurance Group Benefits Business APIs
Resources
Insurance Person Accounts and Users (POST)
Insurance Contacts and Users (POST)
Insurance Member Rating (POST)
Insurance Group Census Members (POST, PATCH, DELETE)
Insurance Group Census Members Delete (POST)
Insurance Bulk Census Management (POST)
Insurance Census Summary Sync (POST)
Insurance Member Plans (POST, PATCH)
Insurance Member Plans Delete (POST)
Insurance Member Eligible Plans (GET)
Insurance Plans Eligibility Check (POST, PATCH)
Insurance Contract from Quote (POST)
Insurance Group Rating (POST)
Individual Enrollment (POST)
Requests
Responses
Insurance Group Benefits Apex Reference
Insurance Group Benefits Standard Invocable Actions
Insurance Group Benefits Metadata API Types
Insurance Policy Administration
Insurance Product Administration
Insurance Quoting
Insurance Apex Reference
Error Codes and Responses
PDF

Newer Version Available

This content describes an older version of this product. View Latest

Insurance Plans Eligibility Check (POST, PATCH)

Evaluate product configuration rules for a group census member based on their selected plan and coverage options during initial enrollment (POST). Reevaluate plan eligibility for a group census member when plans are added or removed (PATCH).
Resource
1/connect/insurance/census-management/group-census-members/memberId/enrollment-rules/actions/invoke
Resource example
1https://yourInstance.salesforce.com/services/data/v66.0/connect/insurance/census-management/group-census-members/0r6RM0000000h1pYAA/enrollment-rules/actions/invoke
Available version
66.0
HTTP methods
POST, PATCH
Path Parameter for POST and PATCH
Name Type Description Required or Optional Available Version
memberId String ID of the group census member. Required 66.0
Request body for POST
JSON example
1{
2  "plans": [
3    {
4      "planId": "0gpp00000004C9wAAE",
5      "coverages": []
6    }
7  ]
8}
Properties
Name Type Description Required or Optional Available Version
plans Insurance Group Plan Input[] List of contract group plans for initial eligibility validation. Required 66.0
Response body for POST
Insurance Plans Eligibility Details
Request body for PATCH
JSON example
1{
2  "contextId": "42ce00ea6a44dcc0d308ba1ea7c4c9bb455bd14bb0405ff03dca1b5371c42cda",
3  "addedPlans": [
4    {
5      "planId": "0gpp00000004C9wAAE",
6      "coverages": [
7        {
8          "planId": "0rgxx0000000001AAA"
9        }
10      ]
11    }
12  ],
13  "deletedPlans": []
14}
Properties
Name Type Description Required or Optional Available Version
addedPlans Insurance Group Plan Input[] List of contract group plans to add to the member's enrollment for eligibility checking. Optional 66.0
contextId String ID of the context. Required 66.0
deletedPlans Insurance Group Plan Input[] List of contract group plans to remove from the member's enrollment. Optional 66.0
Response body for PATCH
Insurance Plans Eligibility Details