Add Custom Fields

To add user defined custom fields with attribute key and module

Add custom fields, Maximum limit for an entity to add custom fields is 20. Below is a sample cURL request to add some custom fields:

sample_curl - add_custom_field.txt

400B

Open

POST{{apiUrl}}custom_fields/add_update_custom_field

Request Body

Name	Type	Description
apikey*	String	Authentication token
custom_fields	Array	Array of custom field object For ex: {attribute_key: string, module: string } Valid module are: sales and customers
action	String	add

OK Success

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

Limit Error

{
    "status_code": "0",
    "status_message": "Total custom field exceeds limit of 20",
    "datetime": "2024-10-01 10:44:00",
    "data": null
}