Clone a group census and its hierarchy, including members, member plans, and plan
attributes. Use this API to copy one census data into another, apply field-level overrides, and
optionally filter or remap member plan references. This API clones all reference data linked to
the group census ID and supports field-level transformations to add to new values on existing
data. You can apply filters to select the specific records to clone, such as filtering group
census member plans by quote ID, and can use custom context definitions to include unique fields
and specialized mappings.
Resource
{censusId} is a placeholder.
/connect/insurance/group-censuses/{censusId}/actions/deep-clone
Resource Example
Replace {yourInstance} with the My Domain name of your Salesforce org.
https://{yourInstance}.salesforce.com/services/data/v68.0/connect/insurance/group-censuses/0rfxx000000001aEAA/actions/deep-clone
Available Version
68.0
HTTP Methods
POST
Path Parameter for POST
| Parameter Name | Type | Description | Required or Optional | Available Version |
|---|---|---|---|---|
| censusId | String | ID of the source group census to clone. | Required | 68.0 |
Request Body for POST
JSON Example
{
"contextDefId": "Custom_GroupCensus_DeepClone",
"groupCensusFilters": {
"memberPlanFilter": {
"quoteId": "0Q0xx0000004CtoCAE"
}
},
"groupCensusReferenceMappings": {
"memberPlanReferenceMapping": {
"contractId": "800xx0000004C92AAE"
}
},
"targetGroupCensusOverrides": {
"Name": "Acme Enrollment Census",
"Description": "Enrollment census cloned from the quoting census"
}
}
Properties
| Name | Type | Description | Required or Optional | Available Version |
|---|---|---|---|---|
| contextDefId | String | API name of the custom context definition that overrides the standard group census deep-clone context definition. Use this property when you need unique fields or specialized mappings that the standard context definition doesn't include. | Optional | 68.0 |
| groupCensusFilters | Group Census Filters Input | Filters that limit which records in the source census hierarchy are cloned. For example, clone only the group census member plans that belong to a specified quote. | Optional | 68.0 |
| groupCensusReferenceMappings | Group Census Reference Mappings Input | Reference mappings to apply on the cloned records. Use these mappings to associate source references with target references, such as mapping quote line items to contract group plans. | Optional | 68.0 |
| targetGroupCensusOverrides | Object | Map of field API names and values to apply to the cloned group census. Use this map to set new values on the target census, such as the census name or description. | Optional | 68.0 |