Actions17
Custom Field → Delete Value
AI-generatedSummary
Deletes a custom field value for a given entity.
Inputs
- attributeId (required) — The ID of the custom field attribute to delete
- entityId (required) — The ID of the entity (e.g., Student ID, Parent ID) whose custom field value will be deleted
Output shape
object
On success, returns {success: true, message: 'Custom field value deleted successfully'}. On 404, returns {success: true, message: 'Value not found (already deleted or never existed)'}. Other errors are propagated as NodeApiError.
Examples
Example 1: Delete a custom field value for a student
Provide the custom field attribute ID and the student's entity ID.