API: FTP Delete Custom Field
Overview
The Delete Custom Field command allows you to delete a custom contact data field that may no longer be of use.
Arguments
The Delete Custom Field command requires the following arguments: Command and Field Name.
cmd=customfielddelete&fieldname=age
The command is ‘customfielddelete' and the custom field will named ‘age’ will be deleted. Any data associated with contacts will remain in the system, but will no longer be accessible.
The Delete Custom Field command supports the following arguments:
Name | Req? | Description | Argument |
Command | Yes | Defines the command to use. | cmd=customfielddelete |
Realm |
| Name of the realm to run the command. This is optional and only necessary when submitting files to a parent realm to manipulate data in a child realm. | realm=[realm_name] |
Field Name | Yes | Name of the custom field to delete. | fieldname=[custom_field_name] |
Example
Using all commands and arguments (please note the command is wrapped for display purposes only):
cmd=customfielddelete&realm=myrealm_child&fieldname=gender
The custom field, 'gender' will be deleted from the realm 'myrealm_child', a child of the realm defined in the header.
Error
A Delete Custom Field command will fail if a custom field does not exist.