Use this API to delete a custom field configured for historical points import. The API performs a soft delete. It marks the custom field as inactive but does not remove existing historical points data associated with that field. Historical records continue to retain previously stored values.

When to use this API

Use this API when you want to:

Prevent further use of a custom field in historical points imports.
Clean up unused or incorrectly configured custom fields.
Deactivate a field without affecting existing historical data.

Prerequisites

The custom field you want to delete must exist.

🚧
Warning
Deleting a custom field is a soft delete operation. The field is marked as inactive, but existing historical points data retains the field values.

Example request

curl --location 'https://eu.intouch.capillarytech.com/v2/historicalPoints/deleteCustomFields?field_name=testField2' \
--header 'Content-Type: application/json' \
--header 'Accept: application/json' \
--header 'Authorization: Basic bmVlIwMzZhNGNjZGMzMzQzMWVmOWFjOQ==' \
--data ''

Query parameters

Parameter	Type	Required?	Description
field_name	string	Yes	Name of the custom field to soft delete.

Example response

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

Response parameters

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

Error codes

Code	Description
2203	Error while deleting historical points custom field. Returned when the delete operation fails or an exception occurs.