Difference between revisions of "API:CustomField:Update"
Greg Donald (talk | contribs) (Created page with " == API » Update Custom Field == '''URL:''' <nowiki>https://app.callproof.com/api/custom_field/update/</nowiki> '''Method:''' POST '''Required Fields:''' * '''''a...") |
(→API » Update Custom Field) |
||
| Line 22: | Line 22: | ||
* '''''custom_field[position]''''' - Custom Field position (e.g. 1, 2, 3) | * '''''custom_field[position]''''' - Custom Field position (e.g. 1, 2, 3) | ||
* '''''custom_field[points]''''' - Custom Field points for assigning value | * '''''custom_field[points]''''' - Custom Field points for assigning value | ||
| + | * '''''custom_field[hide_on_checkout]''''' - Set to '1' to hide on checkout | ||
'''Data Returned:''' | '''Data Returned:''' | ||
Latest revision as of 08:21, 3 August 2017
API » Update Custom Field
URL: https://app.callproof.com/api/custom_field/update/
Method: POST
Required Fields:
- api_key[key] - API Key
- api_key[secret] - API Key Secret
- custom_field[id] - Custom Field ID
Optional Fields:
- custom_field[cfield_table] - Custom Field table (contact, eform)
- custom_field[cfield_type] - Custom Field extension (text, select, radio, checkbox, textarea, date, time, datetime, integer, decimal, auto_integer, image)
- custom_field[cfield_option_default] - Custom Field default option for select and radio cfield_types
- custom_field[regular_field] - Custom Field regular field (first_name, last_name, email, address, address2, city, state_id, zip, account, title, website, country_id, contact_type_id, company_name, only applies to Event Forms)
- custom_field[custom_field] - Custom Field custom field (only applies to Event Forms)
- custom_field[name] - Custom Field name
- custom_field[position] - Custom Field position (e.g. 1, 2, 3)
- custom_field[points] - Custom Field points for assigning value
- custom_field[hide_on_checkout] - Set to '1' to hide on checkout
Data Returned:
- results - Custom Field
- errors - Array of errors produced by the request
- code - HTTP request status
