You can use this API to create custom fields for historical points import as part of your loyalty migration setup.

Custom fields allow you to attach additional metadata to each historical point's entry when onboarding customers from an external or legacy loyalty system.

You can use this API to:

Store additional attributes from the source loyalty platform.
Define required fields before uploading historical points.
Reference these fields during the historical points upload process. Ensure that you execute this API before initiating historical points import.

Example request

curl --location 'https://eu.intouch.capillarytech.com/v2/historicalPoints/saveCustomFields' \
--header 'Content-Type: application/json' \
--header 'Accept: application/json' \
--header 'Authorization: Basic bmVlcmFqLmRhNGNjZGMzMzQzMWVmOWFjOQ==' \
--data '{
    "customFieldName": [
        "testField2"
    ]
}'

Prerequisites

Custom fields must be created before importing historical points data. These fields store additional metadata about each historical point's entry.

📘
Note
This API is for organizations migrating customers from an external or legacy loyalty program to Capillary. Custom fields allow you to capture additional metadata from the source system during import.

Body parameters

Field	Type	Required?	Description
customFieldName	array	Yes	List of custom field names to create. Each name must be unique within the org.

Example response

{
    "status": true,
    "message": "SUCCESSFULLY_SAVED_HISTORICAL_POINTS_CUSTOM_FIELD",
    "warnings": []
}

Response parameters

Parameter	Datatype	Description
status	boolean	`true` if the operation was successful, `false` otherwise.
message	string	Descriptive message about the result of the operation.
warnings	array	List of warning messages.

Error & warning codes

Code	Description
2202	Error in saving historical points custom fields. Returned when any exception occurs during the save operation (e.g., database error, thrift service failure).