POST https://:account.api-us1.com/api/3/fields
- JSON
{
"field": {
"type": "textarea",
"title": "Field Title",
"descript": "Field description",
"isrequired": 1,
"perstag": "Personalized Tag",
"defval": "Defaut Value",
"show_in_list": 1,
"rows": 2,
"cols": 2,
"visible": 1,
"service": "google",
"ordernum": 3
}
}
201 Created
{
"fieldOptions": [],
"fieldRels": [],
"fields": [
{
"title": "Another Test Title",
"descript": null,
"type": "",
"isrequired": "0",
"perstag": "ANOTHER_TEST_TITLE",
"defval": null,
"show_in_list": "0",
"rows": "0",
"cols": "0",
"visible": "1",
"service": "",
"ordernum": "2",
"cdate": "2018-11-15T21:43:38-06:00",
"udate": "2018-11-15T21:43:38-06:00",
"options": [],
"relations": [],
"links": {
"options": "https://:account.api-us1.com/api/:version/fields/2/options",
"relations": "https://:account.api-us1.com/api/:version/fields/2/relations"
},
"id": "2"
},
{
"title": "Title",
"descript": "Field description",
"type": "textarea",
"isrequired": "1",
"perstag": "PERSONALIZEDTAG",
"defval": "Defaut Value",
"show_in_list": "1",
"rows": "2",
"cols": "2",
"visible": "1",
"service": "google",
"ordernum": "3",
"cdate": "2018-11-15T21:42:40-06:00",
"udate": "2018-11-15T21:49:52-06:00",
"options": [],
"relations": [],
"links": {
"options": "https://:account.api-us1.com/api/:version/fields/1/options",
"relations": "https://:account.api-us1.com/api/:version/fields/1/relations"
},
"id": "1"
}
],
"meta": {
"total": "2"
}
}
BODY PARAMS
field
object
field.title REQUIRED
string Title of the field being created
field.type
string Possible Values: dropdown, hidden, checkbox, date, text, textarea, NULL, listbox, radio
field.descript
string Description of field being created
field.isrequired
boolean Dictates whether the field being created, is required or not
field.perstag
string The perstag that represents the field being created
field.defval
string Default value of the field being created
field.show_in_list
boolean Show this field in the contact list view (Deprecated - no longer used)
field.rows
int32 Num of rows for a textarea (Deprecated - no longer used)
field.cols
int32 Num of columns for a textarea (Deprecated - no longer used)
field.visible
boolean Show or hide this field when using the Form Builder
field.service
string Possible Vales: nimble, contactually, mindbody, salesforce, highrise, google_spreadsheets, pipedrive, onepage, google_contacts, freshbooks, shopify, zendesk, etsy, NULL, bigcommerce, capsule, bigcommerce_oauth, sugarcrm, zohocrm, batchbook
field.ordernum
int32 Order of appearance in ‘My Fields’ tab.
Important Notes:
- When the
field_type
isdropdown
,radio
,checkbox
orlistbox
, you need to add field options usingfieldOption/bulk
endpoint. - A contact can only see a custom field if the contact is part of a list that this custom field is related to. Use
fieldRel
endpoint to specify which list gets to see the custom field.
Opmerkingen
0 opmerkingen
Artikel is gesloten voor opmerkingen.