Update Custom Field

To update a particular custom field using the id.

Update a custom field

Below is sample cURL request to update a custom field. Use raw JSON format to call the API. Length of the array while update action should be one only.

356B

sample_curl - update_custom_field.txt

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 of length one containing id attribute key and module. Update one custom field at a time. For ex: {id: string, attribute_key: string, module: string } Valid modules are: sales and customers
action	String	update

200 Update success

{
    "status_code": "1",
    "status_message": "Success",
    "datetime": "2024-09-24 15:14:36",
    "data": null
}

Invalid update id

{
    "status_code": "0",
    "status_message": "update failed",
    "datetime": "2024-09-24 15:14:36",
    "data": null
}