After the records are created and required permission sets are assigned, members can log into the customer community portal to select plans and complete their individual enrollment based on the digital workflow that's configured by the carrier.
Special Access Rule
To use this API, the org must be enabled with Person Account and you must have Census Management user access.
Resource
/connect/insurance/accounts
Resource Example
Replace {yourInstance} with the My Domain name of your Salesforce org.
https://{yourInstance}.salesforce.com/services/data/v68.0/connect/insurance/accounts?createPortalUsers=false
Available Version
65.0
HTTP Methods
POST
Request Parameters for POST
| Parameter Name | Type | Description | Required or Optional | Available Version |
|---|---|---|---|---|
| createPortalUsers | Boolean | Indicates whether to create portal users for the new person accounts (true) or not (false). The default value is true. |
Optional | 65.0 |
Request Body for POST
JSON Example
This is a sample JSON example with GroupCensusId.
{
"groupCensusId": "0rfxx0000000007AAA",
"matchingKeyList": {
"values": [
"FirstName",
"LastName"
]
},
"fieldMappings": {
"data": {
"FirstName": "FirstName",
"Lastname": "LastName"
}
},
"userDetails": {
"profileId": "00exx000000mzxC",
"localeSidKey": "en_US",
"timeZoneSidKey": "America/New York",
"languageLocaleKey": "en_US",
"emailEncodingKey": "UTF-8"
}
}
This is a sample JSON example with GroupCensusMembers.
{
"groupCensusMemberIdList": {
"values": [
"0r6xx0000000002AAA",
"0r6xx000000004rAAA"
]
},
"matchingKeyList": {
"values": [
"FirstName",
"LastName"
]
},
"fieldMappings": {
"data": {
"FirstName": "FirstName",
"Lastname": "LastName"
}
},
"userDetails": {
"profileId": "00exx000000mzxC",
"localeSidKey": "en_US",
"timeZoneSidKey": "America/New York",
"languageLocaleKey": "en_US",
"emailEncodingKey": "UTF-8"
}
}
Properties
| Name | Type | Description | Required or Optional | Available Version |
|---|---|---|---|---|
| fieldMappings | Map<String, String> | Map of field API names from the Group Census Member object (key) to the Account object (value). | Optional | 65.0 |
| groupCensusId | String | ID of the group census that contains the members to process. | Optional | 65.0 |
| groupCensusMember​IdList | String[] | IDs of the group census members for whom you want to create person accounts and
users.
If not provided, all members of the specified group census are processed. |
Optional | 65.0 |
| matchingKeyList | String[] | List of field API names on the Group Census Member object that are used to identify
and prevent the creation of duplicate person accounts.
The default fields are FirstName, LastName, PersonBirthdate, PersonEmail, and PersonGender. |
Optional | 65.0 |
| personAccount​RecordType | String | Developer name of the person account record type to use for the new accounts. | Optional | 65.0 |
| userDetails | Portal User Creation Input | Details to create portal users. | Required if the createPortalUsers request parameter is set to true. | 65.0 |