Add Custom Fields to a Result Set

Add or edit a custom field for a result set. To edit a field, supply the field id in custom_field_id. The short name for a custom field is the header that will appear for that column in the results. The data type for a field may be "string", "float", "int", "uint", or "table". For "table", the data should include tabs to separate columns. You cannot modify the data type for an existing field.

For 'xml', the request should look like the example below.

<?xml version="1.0" encoding="utf-8" ?>
<request>
	<custom_field>
		<custom_field_id></custom_field_id>
		<custom_field_name>Custom Name</custom_field_name>
		<custom_field_short_name>Custom Name</custom_field_short_name>
		<custom_field_data_type>string</custom_field_data_type>
	</custom_field>
</request>

For 'json', the request should look like the example below.

{
	"custom_fields": [
		{
			"custom_field_id": null,
			"custom_field_name": "Custom Name",
			"custom_field_short_name": "Custom Name",
			"custom_field_data_type": "string"
		}
	]
}

URL

HTTP Method

Standard Parameters

Parameters