DataMapping

Create a Data Mapping

Changed on

Create a new data mapping to connect an external data source to this Memory Store. For DATASET_CLOUDAPP and DATASET_WAREHOUSE types, validates that all mapped Trait Groups and traits exist and that dataset field data types match their respective mapped trait data types.

post/v1/ControlPlane/Stores/{storeId}/DataMappings

Request

  • Base URL
    https://memory.twilio.com
  • URL
    https://memory.twilio.com/v1/ControlPlane/Stores/{storeId}/DataMappings
  • Auth
    HTTP basic

Request body

displayNamestring required

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": [
      {
        "expression": "primary_email",
        "traitGroup": "Contact",
        "traitName": "email"
      }
    ]
  },
  "mappingFrom": {
    "type": "INGRESS",
    "columns": [
      "first_name",
      "last_name",
      "email",
      "favorite_color"
    ]
  }
}

Response

Data mapping creation request accepted.

messagestring
statusUrlstring

URI to check operation status.

Example response

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

Changes

    • breaking

      removed from the request property oneOf list

    • info

      removed CSV DATASET discriminator mapping keys from the request property

    • info

      added INGRESS DATASET_CLOUDAPP DATASET_WAREHOUSE discriminator mapping keys to the request property

    • info

      added to the request property oneOf list