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.

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

Resource Example

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

https://{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

{
    "networks": [
        {
            "network": "First Network Tier",
            "name": "Preferred Network"
        },
        {
            "network": "Second Network Tier",
            "name": "In Network"
        }
    ],
    "benefits": [
        {
            "productId": "01tSG0000011yBFxxY",
            "productCompGgpId": "0y7SG0000000ZiXxxU",
            "productName": "Chiropractic Care",
            "network": "First Network Tier",
            "attributes": [
                {
                    "attributeDefinitionId": "0tjSG0000001embxxA",
                    "name": "Copay",
                    "value": 311
                },
                {
                    "attributeDefinitionId": "0tjSG0000001YmMxxU",
                    "name": "Deductible",
                    "value": "100"
                }
            ]
        }
    ]
}

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

{
    "networks": [
        {
            "networkId": "1HXSG0000002xxxxAM",
            "name": "Preferred Network Updated"
        },
        {
            "networkId": "1HXSG0000002xxxxA2",
            "name": "In Network Updated"
        },
        {
            "network": "Third Network Tier",
            "name": "Out Network"
        }
    ],
    "benefits": [
        {
            "benefitId": "1HSSG0000005Ws7xxE",
            "productId": "01tSG0000011yBFxxY",
            "productCompGgpId": "0y7SG0000000ZiXxxU",
            "productName": "Chiropractic Care",
            "attributes": [
                {
                    "covBnftAttrId": "1HYSG00000002GPxxY",
                    "attributeDefinitionId": "0tjSG0000001embxxA",
                    "name": "Copay",
                    "value": 311
                },
                {
                    "covBnftAttrId": "1HYSG00000002GQxxY",
                    "attributeDefinitionId": "0tjSG0000001YmMxxU",
                    "name": "Notes",
                    "value": "Preferred network limitations apply."
                }
            ]
        }
    ]
}

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