Update a custom field

PUT  https://:account.api-us1.com/api/3/fields/id

• JSON

{
	"field": {
		"type": "textarea",
		"title": "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
    }
}

 

200 OK

{
    "field": {
        "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-09-25T16:06:08-05:00",
        "udate": "2018-09-29T18:23:20-05:00",
        "links": {
            "options": "https://:account.api-us1.com/api/:version/fields/3/options",
            "relations": "https://:account.api-us1.com/api/:version/fields/3/relations"
        },
        "id": "3"
    }
}

403 Forbidden

{
    "message": "Forbidden"
}

PATH PARAMS

ID                                  REQUIRED

int32                              ID of the field to update

 

BODY PARAMS

field

object

 

field.type

string                            Possible Values: dropdown, hidden, checkbox, date, text, textarea, NULL, listbox, radio

 

field.title

string                            Title of the field being updated

 

field.descript

string                            Description of field being updated

 

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 (No longer Used)

 

field.visible

boolean                           Setting to show/hide field

 

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

string                               Order of appearance in ‘My Fields’ tab.