v3

latestOpenAPI 3.0.1Apache 2.0raw.githubusercontent.com2026-08-014669239.7 KB

DataMapping

Update a Data Mapping

Partially update a data mapping. Only the fields provided in the request body will be updated, including replacing the entire contents of the mappings array.

For DATASET types, validates that all mapped Trait Groups and traits exist and that dataset field data types match their respective mapped trait data types.

patch/v1/ControlPlane/Stores/{storeId}/DataMappings/{dataMappingId}

Headers

If-Matchstring

Example:"eyJpZCI6ImFuX2lkIiwidiI6MX0"

Allows for optimistic concurrency control by making the request conditional. Server will only act if the resource's current Entity Tag (ETag) matches the one provided, preventing accidental overwrites.

Request body

displayNamestring

Name of the data mapping.

descriptionstring

A human readable description of this resource, up to 512 characters.

isEnabledboolean

Flag indicating whether the data mapping is active. When true, data will be ingested and mapped according to the configuration. When false, the data mapping will be inactive and no data will be ingested into the Memory Store.

Example request

{
  "displayName": "crm-contacts",
  "description": "Syncs customer data from CRM dataset to profile traits",
  "isEnabled": true,
  "mappingTo": {
    "type": "TRAITS",
    "mappings": [
      {
        "fieldName": "primary_email",
        "traitGroup": "Contact",
        "traitName": "email"
      }
    ]
  }
}

Response

Data mapping update request accepted.

messagestring

statusUrlstring

URI to check operation status.

Example response

{
  "message": "Data mapping update request accepted for processing."
}