Newer Version Available
Insurance Person Accounts and Users (POST)
Create person accounts and portal users for group census members. The
Person Account is used for linking to the appropriate policy for policy association, and the
corresponding portal user is created to allow the member to log in to the community
portal.
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
-
1/connect/insurance/accounts - Resource example
-
1https://yourInstance.salesforce.com/services/data/v66.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.
-
1{ 2 "groupCensusId": "0rfxx0000000007AAA", 3 "matchingKeyList": { 4 "values": [ 5 "FirstName", 6 "LastName" 7 ] 8 }, 9 "fieldMappings": { 10 "data": { 11 "FirstName": "FirstName", 12 "Lastname": "LastName" 13 } 14 }, 15 "userDetails": { 16 "profileId": "00exx000000mzxC", 17 "localeSidKey": "en_US", 18 "timeZoneSidKey": "America/New York", 19 "languageLocaleKey": "en_US", 20 "emailEncodingKey": "UTF-8" 21 } 22} - This is a sample JSON example with GroupCensusMembers.
-
1{ 2 "groupCensusMemberIdList": { 3 "values": [ 4 "0r6xx0000000002AAA", 5 "0r6xx000000004rAAA" 6 ] 7 }, 8 "matchingKeyList": { 9 "values": [ 10 "FirstName", 11 "LastName" 12 ] 13 }, 14 "fieldMappings": { 15 "data": { 16 "FirstName": "FirstName", 17 "Lastname": "LastName" 18 } 19 }, 20 "userDetails": { 21 "profileId": "00exx000000mzxC", 22 "localeSidKey": "en_US", 23 "timeZoneSidKey": "America/New York", 24 "languageLocaleKey": "en_US", 25 "emailEncodingKey": "UTF-8" 26 } 27} - 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 groupCensusMemberIdList 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 personAccountRecordType 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
- Response body for POST
- Insurance Person Accounts and Users Creation Response