DELETE /api/v3/udf/{udfId}

Deletes a user defined field definition and all associated values

DeleteUDFV3 Permissions: ApplicationSettings (Manage)
Use this endpoint to permanently remove a custom field. All values stored for this UDF across all entities will be deleted. Locked system UDFs cannot be deleted. No confirmation is required. Requires ApplicationSettings Manage permission.

Request Headers

Header Value Required Description
ECI-ApiKey string Yes Your API key. See Authentication.
Content-Type application/json Yes All requests must specify JSON content type.

Path Parameters

Name Description Type Required
udfId Unique numeric identifier of the UDF to delete integer (int32) Required

Responses

204 No Content The request succeeded. No content is returned in the response body.
404 Not Found The requested resource was not found. Verify the ID or path is correct.