Insurance Contacts and Users (POST)

Create contacts and portal users for group census members. The Contact record 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.

Resource

/connect/insurance/contacts

Resource Example

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

https://{yourInstance}.salesforce.com/services/data/v68.0/connect/insurance/contacts?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 contacts (`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	Map of field API names from the Group Census Member object (key) to the Contact object (value).	Optional	65.0
`groupCensusId`	String	ID of the group census.	Optional	65.0
`groupCensusMemberIdList`	String[]	IDs of the group census members for whom you want to create contacts 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 contact records. The default fields are FirstName, LastName, Birthdate, Email, and Gender.	Optional	65.0
`userDetails`	Portal User Creation Input	Details to create portal users. This property is required if the `createPortalUsers` parameter in the method call is set to `true`.	Optional	65.0

Response Body for POST

Insurance Contacts and Users Creation Response