Data Kit definition

Last updated: October 28, 2026, 17:17 (UTC+1).

Runtime verified

Verification scope: Live-org reads and the explicitly described bounded operations were tested. The operation-specific limitations still apply; this badge does not verify untested writes or general CRUD support.

Back to Data Cloud with Salesforce CLI. Start with its setup, placeholders and safety guidance before running these examples.

Data Kit definition — DataPackageKitDefinition.

Supplied workflows for Data Kit definition
Retrieve	Create	Update	Delete
Yes	Partial	?	?

Yes: a usable scoped workflow is supplied. Partial: a usable bounded, combined or incomplete asynchronous workflow is supplied. Neither means universal capability. No: proven unavailable in an explicit scope. ?: unknown, untested or no usable workflow supplied. Neither No nor ? displays method icons. means dedicated CLI commands; means API-led requests or facades, even when invoked through the CLI. Two icons identify alternatives, not equivalent coverage. Read each operation's prerequisites and limits. An available operation tab may explain an illustrative mechanism without supplying a usable summary workflow.

Retrieve

CLI — Available: Use the linked combined kit retrieval to retain templates and membership links.
API — Unknown: No separate API retrieval workflow is supplied.
sf-plugin-data — Unknown: Not implemented in this guide; no workflow is supplied.

CLI

Use the combined kit retrieval. Its files response includes DataPackageKitDefinition:CustomerKit, written to force-app/main/default/dataPackageKitDefinitions/CustomerKit.dataPackageKitDefinition-meta.xml. Keep the templates and membership links alongside it for a complete snapshot.

<DataPackageKitDefinition xmlns="http://soap.sforce.com/2006/04/metadata">
  <isEnabled>false</isEnabled>
  <isDeployed>false</isDeployed>
  <!-- Retrieved ordering, state and other attributes omitted. -->
</DataPackageKitDefinition>

These flags do not switch off schedules or automatic runs embedded in component templates.

Create

CLI — Available: Joint source-org metadata creation only; requires the three complete compatible files.
API — Unknown: No separate API creation workflow is supplied.
sf-plugin-data — Unknown: Not implemented in this guide; no workflow is supplied.

CLI

An owned Identity Resolution kit definition, substantive template and membership link have been created together in the source org. Run this only from an isolated Salesforce project whose force-app directory contains exactly those three complete, compatible metadata files, with matching references:

force-app/main/default/dataPackageKitDefinitions/CustomerIdentityKit.dataPackageKitDefinition-meta.xml
force-app/main/default/dataKitObjectTemplates/CustomerIdentityTemplate.dataKitObjectTemplate-meta.xml
force-app/main/default/DataPackageKitObjects/CustomerIdentityMember.DataPackageKitObject-meta.xml

These are local project-relative paths; replace the illustrative names with your own. The complete Identity Resolution template content must already exist—these paths are not a template generator.

sf project deploy start --source-dir force-app --target-org SOURCE_ALIAS --api-version 65.0 --wait 10 --json

Shortened illustrative response:

{ "status": 0, "result": { "success": true, "status": "Succeeded", "files": [
  { "fullName": "CustomerIdentityKit", "type": "DataPackageKitDefinition", "state": "Created" },
  { "fullName": "CustomerIdentityTemplate", "type": "DataKitObjectTemplate", "state": "Created" },
  { "fullName": "CustomerIdentityMember", "type": "DataPackageKitObject", "state": "Created" }
] } }

This proves joint metadata creation only, not independent member creation, runtime installation or cross-org replay.

Update

Definition updates have not been verified.

CLI — Unknown: Definition updates have not been verified; no workflow is supplied.
API — Unknown: No API definition-update workflow is supplied.
sf-plugin-data — Unknown: Not implemented in this guide; no workflow is supplied.

Delete

CLI — Available: Joint deletion of the three owned source-org metadata components only; runtime cleanup remains unverified.
API — Unknown: No separate API deletion workflow is supplied.
sf-plugin-data — Unknown: Not implemented in this guide; no workflow is supplied.

CLI

The owned source-org definition, template and membership link have also been deleted together. For the same three components, the generated local manifest/empty.xml contains only the package namespace and API version:

<?xml version="1.0" encoding="UTF-8"?>
<Package xmlns="http://soap.sforce.com/2006/04/metadata">
  <version>65.0</version>
</Package>

The generated local manifest/destructiveChangesPost.xml selects the exact three components to remove. Replace these illustrative names only with components you own and intend to delete:

<?xml version="1.0" encoding="UTF-8"?>
<Package xmlns="http://soap.sforce.com/2006/04/metadata">
  <types>
    <members>CustomerIdentityTemplate</members>
    <name>DataKitObjectTemplate</name>
  </types>
  <types>
    <members>CustomerIdentityMember</members>
    <name>DataPackageKitObject</name>
  </types>
  <types>
    <members>CustomerIdentityKit</members>
    <name>DataPackageKitDefinition</name>
  </types>
  <version>65.0</version>
</Package>

With both files supplied at those project-relative paths, run:

sf project deploy start --manifest manifest/empty.xml --post-destructive-changes manifest/destructiveChangesPost.xml --target-org SOURCE_ALIAS --api-version 65.0 --wait 10 --json

Shortened illustrative response:

{ "status": 0, "result": { "success": true, "status": "Succeeded", "files": [
  { "fullName": "CustomerIdentityTemplate", "type": "DataKitObjectTemplate", "state": "Deleted" },
  { "fullName": "CustomerIdentityMember", "type": "DataPackageKitObject", "state": "Deleted" },
  { "fullName": "CustomerIdentityKit", "type": "DataPackageKitDefinition", "state": "Deleted" }
] } }

This proves joint metadata deletion only. Runtime undeployment, generated-object cleanup, independent deletion of arbitrary member links and cross-org behavior remain unverified.

For the shared distinction between metadata transport and runtime installation, see Moving a kit is not installing it.