Manage Customer Fields - List

Show the fields used to gather customer data:

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

NOTE:

- Almost all users can access this call.

Example PHP Request:

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

1. $data['user_id'] = 'john1970';
2. $data['user_api_key'] = '1959caadac9b13dcb3';
3. $data['account_id'] = 'greatwidgets';
4. $data['type'] = 'manage_fields';
5. $data['action'] = 'list';

Success XML Response:

1. <response status="success">
2. <account>
3. <account_id>test2009050502</account_id>
4. <fields>
5. <field>
6. <name>card_number</name>
7. <label>Card #</label>
8. <show>Y</show>
9. <type>Text</type>
10. </field>
11. <field>
12. <name>custom_field_2</name>
13. <label>Marital Status</label>
14. <show>Y</show>
15. <type>List</type>
16. <choices>
17. <choice>Single</choice>
18. <choice>Married</choice>
19. <choice>Divorced</choice>
20. <choice>In Civil Union</choice>
21. <choice>Other</choice>
22. </choices>
23. </field>
24. ...
25. </fields>
26. </account>
27. </response>

NOTE:

• The <show> response indicates whether or not this field ought to be shown or not. Usually fields with "N" will have nothing in them. However, it is allowed to add content to any defined field through the API regardless of their <show> status.
• The <type> parameter can be: Text, Date, List (Multiple Choice), or Pick (Single Choice)

Error XML Response:

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