This will allow you to create a custom field that can be used to gather custom info related to a Lead.
Type | Parameters | Values |
POST | cmd* | create_custom_field |
POST | custom_field_identifier * | string |
POST | custom_field_type* | Posible values are 'input_field', 'text_area', 'drop_down', 'radio_button', 'checkbox' |
POST | custom_field_options ** | array of arrays with one parameter: option_name (string containing the name of the option) |
* Required fields ** Required for drop_down, radio_button, checkbox field types. Here is an example:
'actions' => [ '0' => [ 'cmd' => 'create_custom_field', 'custom_field_identifier' => 'Custom field name', 'custom_field_type' => 'drop_down', 'custom_field_options' => [ '0' => ['option_name' => 'blue'], '1' => ['option_name' => 'brown'] ] ] ]
Success message:
{ "status": "Success", "message": "Custom Field created", "type: "114" }
Error Cases:
Type Number | Message | Cause |
263 | Custom Field name can only contain letters, numbers, dashes or underscores |
|
264 | Custom Field already exists or not allowed |
|
265 | Custom Field cannot be empty |
|
269 | Custom Field type not valid |
|
270 | Options not an array |
|
272 | Option cannot be empty |
|
273 | Options must have two or more elements |
|
{ "status": "Error", "message": "Custom Field name can only contain letters, numbers, dashes or underscores", "type": "263" }