Creates a custom field 


JSON Request Example:




json_request element


Field NameDescription
usernameUsername used to login to Pinpointe
usertokenUnique token assigned to Pinpointe account
requesttypeLists
requestmethodCreateCustomField


details element


Field NameDescription
listList ID
nameName (Required)
typeType of field (test area, number, dropdown, checkbox, radiobutton, date)
isrequiredIs the custom field required (TRUE, FALSE)
fieldlengthLength of number and text fields (Number and text fields only) 
defaultvalueThe default value 
instructionInstructions for the field ("please select an option") (Drop down fields only) 
applydefaultApplies default value (TRUE, FALSE) (Date, number, and test area fields only) 
optionsOptions (Drop down, radio button, and checkbox fields only) (Required)
dateformatFormat 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")
startStart date (Date fields only) (Required) 
endEnd date (Date fields only) 
rowsNumber of rows for multi-line text box (Text area only)
columnsNumber of columns for multi-line text box (Text area only) 


Successful Response


response element


Field NameDescription
statusReturns SUCCESS when successful


Unsuccessful Response


response element


Field NameDescription
statusReturns FAILED when unsuccessful
errormessageText explaining why request failed