Creates a custom field
JSON Request Example:
json_request element
Field Name | Description |
username | Username used to login to Pinpointe |
usertoken | Unique token assigned to Pinpointe account |
requesttype | Lists |
requestmethod | CreateCustomField |
details element
Field Name | Description |
list | List ID |
name | Name (Required) |
type | Type of field (test area, number, dropdown, checkbox, radiobutton, date) |
isrequired | Is the custom field required (TRUE, FALSE) |
fieldlength | Length of number and text fields (Number and text fields only) |
defaultvalue | The default value |
instruction | Instructions for the field ("please select an option") (Drop down fields only) |
applydefault | Applies default value (TRUE, FALSE) (Date, number, and test area fields only) |
options | Options (Drop down, radio button, and checkbox fields only) (Required) |
dateformat | Format for dates (Date fields only) (Required) (Strings are d for day, m for month, y for year; separators are dashes, commas, forward slashes, or commas) (ex. "m,d,y") |
start | Start date (Date fields only) (Required) |
end | End date (Date fields only) |
rows | Number of rows for multi-line text box (Text area only) |
columns | Number of columns for multi-line text box (Text area only) |
Successful Response
response element
Field Name | Description |
status | Returns SUCCESS when successful |
Unsuccessful Response
response element
Field Name | Description |
status | Returns FAILED when unsuccessful |
errormessage | Text explaining why request failed |