Custom Data For Customer Creation

We have introduced a custom data object in the customer creation API that will allow our clients to store data that is unique to that customer but not currently part of the Shaype Customer Data Model.

The custom data object allows for an attribute to be referenced and for the value to be set in the request. This could be used for storing a unique identifier held in a seperate system that you wish to maintain in the Shaype customer record

{
  "customerHayId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  ...
  "customData": {
    "external_id": "359916f3-10d2-437e-a0f0-ea83ac8fd9c2"
  }
}

but the custom data object is fully flexible so any key-value pair can be assigned

{
    "customerHayId": "f4847420-5ac4-4a40-a833-21f3f2265e20",
    "email": "[email protected]",
 ...
    "customData": {
        "key": "AUS"
    }
}

These values will be stored against the customer record. They can be retrieved via the GET customer API and are visible in the control centre once set.