DataMapping

Update a Data Mapping

Changed on

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_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.

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

Request

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

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": [
      {
        "expression": "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."
}

Changes

    • breaking

      added to the request body allOf list

    • breaking

      request body became required

    • breaking

      the request's body type changed from object to no type

    • warning

      removed the request property

    • warning

      removed the request property

    • warning

      removed the request property

    • warning

      removed the request property

    • breaking

      the request property /////// became required

    • breaking

      the request property's maxLength was decreased to 64

    • breaking

      the response property's max was increased from 99999.00 to 999999.00 for the response status

    • breaking

      the response property's max was increased from 99999.00 to 999999.00 for the response status

    • breaking

      the response property's max was increased from 99999.00 to 999999.00 for the response status

    • breaking

      the response property's max was increased from 99999.00 to 999999.00 for the response status

    • breaking

      the response property's max was increased from 99999.00 to 999999.00 for the response status

    • warning

      changed the pattern of the request property from ^[a-zA-Z][a-zA-Z0-9-_.]*$ to ^[a-zA-Z][a-zA-Z0-9-.]*$

    • warning

      removed the request property ///////