Plan Benefits (GET, POST, PATCH, DELETE)

Get, create, update and delete Insurance Policy Coverage Networks and Insurance Policy Coverage Benefits of an Insurance Policy Coverage.

Resource

{coverageId} is a placeholder.

1/connect/insurance/brokerage/coverages/{coverageId}/benefits

Resource Example

Replace {yourInstance} with the My Domain name of your Salesforce org.

1https://{yourInstance}.salesforce.com/services/data/v68.0/connect/insurance/brokerage/coverages/0kPxx000000002fEAA/benefits

Available Version

63.0

HTTP Methods

GET, POST, PATCH, DELETE

Response Body for GET

Plan Benefits Details

Request Body for POST

JSON Example

1{
2    "networks": [
3        {
4            "network": "First Network Tier",
5            "name": "Preferred Network"
6        },
7        {
8            "network": "Second Network Tier",
9            "name": "In Network"
10        }
11    ],
12    "benefits": [
13        {
14            "productId": "01tSG0000011yBFxxY",
15            "productCompGgpId": "0y7SG0000000ZiXxxU",
16            "productName": "Chiropractic Care",
17            "network": "First Network Tier",
18            "attributes": [
19                {
20                    "attributeDefinitionId": "0tjSG0000001embxxA",
21                    "name": "Copay",
22                    "value": 311
23                },
24                {
25                    "attributeDefinitionId": "0tjSG0000001YmMxxU",
26                    "name": "Deductible",
27                    "value": "100"
28                }
29            ]
30        }
31    ]
32}

Properties

Name	Type	Descriptions	Required or Optional	Available Version
`attributes`	Benefit Attributes	List of benefit attributes.	Optional	63.0
`network`	String	The tier type of the network.	Optional	63.0
`networks`	Networks	Insurance Policy Coverage Networks for creating plan benefits.	Required	63.0
`productCompGgpId`	String	ID of product component group.	Optional	63.0
`productId`	String	ID of the product.	Required	63.0
`productName`	String	Name of the product.	Optional	63.0

Response Body for POST

Plan Benefits

Request Body for PATCH

JSON Example

1{
2    "networks": [
3        {
4            "networkId": "1HXSG0000002xxxxAM",
5            "name": "Preferred Network Updated"
6        },
7        {
8            "networkId": "1HXSG0000002xxxxA2",
9            "name": "In Network Updated"
10        },
11        {
12            "network": "Third Network Tier",
13            "name": "Out Network"
14        }
15    ],
16    "benefits": [
17        {
18            "benefitId": "1HSSG0000005Ws7xxE",
19            "productId": "01tSG0000011yBFxxY",
20            "productCompGgpId": "0y7SG0000000ZiXxxU",
21            "productName": "Chiropractic Care",
22            "attributes": [
23                {
24                    "covBnftAttrId": "1HYSG00000002GPxxY",
25                    "attributeDefinitionId": "0tjSG0000001embxxA",
26                    "name": "Copay",
27                    "value": 311
28                },
29                {
30                    "covBnftAttrId": "1HYSG00000002GQxxY",
31                    "attributeDefinitionId": "0tjSG0000001YmMxxU",
32                    "name": "Notes",
33                    "value": "Preferred network limitations apply."
34                }
35            ]
36        }
37    ]
38}

Properties

Name	Type	Description	Required or Optional	Available Version
`benefits`	Benefits Input []	The benefits of the Insurance Plan Coverage.	Optional	63.0
`networks`	Networks Input []	The list of networks.	Optional	63.0

Response Body for PATCH

Plan Benefits

Request Parameters for DELETE

Parameter Name	Type	Description	Required or Optional	Available Version
`benefitIds`	String[]	IDs of Insurance Policy Coverage Benefit. If `benefitIds` are provided, the service will only delete the respective Insurance Policy Coverage Benefit records.	Optional	63.0
`networkIds`	String[]	IDs of the Insurance Policy Coverage Network. If`networkIds` are provided, the service will only delete the respective Insurance Policy Coverage Network records and their associated Insurance Policy Coverage Benefit records.	Optional	63.0