Manage Customer Fields - Delete Field

Remove a field used to gather customer data:

The data to be submitted to the API is composed of the following fields:

NOTE:

• Only users with proper permissions can access this call.
• Multiple fields can be deleted at the same time.
• The following default field_names cannot be deleted (you can update them to show=N, however.)
  • card_number
  • first_name
  • last_name
  • phone
  • email
  • street1
  • street2
  • city
  • state
  • zip
  • country
  • customer_username
  • customer_PIN
  • customer_password
  • custom_date
  • custom_field_1
• Valid fields that can be deleted have the following field_name structure:
  • "custom_field_#" where the "#" is any integer above 1
    (one of the default fields is "custom_field_1")
    Example:
    • custom_field_2
    • custom_field_14
    • ...

Example PHP Request:

If you are using PHP, the $data array would look like this:

1. $data['API'] = '1.5';
2. $data['user_id'] = 'john1970';
3. $data['user_api_key'] = '1959caadac9b13dcb3';
4. $data['account_id'] = 'greatwidgets';
5. $data['type'] = 'manage_fields';
6. $data['action'] = 'delete';
7. $data['field_list'] = 'custom_field_3|custom_field_4';

Success XML Response (lists ALL the existing fields):

1. <response status="success">
2. <account>
3. <account_id>test2009050502</account_id>
4. <fields>
5. <field>
6. <name>card_number</name>
7. <label>Member #</label>
8. <show>Y</show>
9. <type>Text</type>
10. </field>
11. <field>
12. <name>first_name</name>
13. <label>First Name</label>
14. <show>Y</show>
15. <type>Text</type>
16. </field>
17. ...
18. <field>
19. <name>custom_field_2</name>
20. <label>Middle Name</label>
21. <show>Y</show>
22. <type>Text</type>
23. </field>
24. </fields>
25. </account>
26. </response>

Error XML Response:

1. <response status="error">
2. <error>Error message</error>
3. </response>