Delete Custom Fields

To delete custom field using the id.

Delete one or more custom fields.

Below is a Sample cURL request to delete particular custom fields.

sample_curl - delete_custom_field.txt

517B

Open

POST{{apiUrl}}custom_fields/add_update_custom_field

Request Body

Name	Type	Description
apikey*	String	Authentication token
entity	Number	type of the entity
custom_fields	Array	Array of custom field object containing id, attribute key and module name For ex: {id: string, attribute_key: string, module: string} Valid module are: sales and customers
action	String	delete

OK Success

{
    "status_code": "1",
    "status_message": "Success",
    "datetime": "2024-10-01 10:24:18",
    "data": null
}

Invalid id of attribute

{
    "status_code": "0",
    "status_message": "deleting failed",
    "datetime": "2024-10-01 10:25:52",
    "data": null
}