Update a custom field

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

• JSON

{	
	"dealCustomFieldMetum": {
		"field_label": "New Title",
		"field_default": "Default Text",
		"is_form_visible": 1,
		"is_required": 1,
		"display_order": 1
	}
}

 

200 OK

{
    "dealCustomFieldMetum": {
        "id": "1",
        "fieldLabel": "New Title",
        "fieldType": "text",
        "fieldOptions": null,
        "fieldDefault": "Default Text",
        "isFormVisible": 1,
        "isRequired": 1,
        "displayOrder": 1,
        "createdUtcTimestamp": "2018-10-22 19:57:37",
        "updatedUtcTimestamp": "2018-10-22 20:04:21",
        "links": {
            "dealCustomFieldData": "https://:account.api-us1.com/api/:version/dealCustomFieldMeta/1/dealCustomFieldData"
        }
    }
}

404 Not Found

{
    "errors": [
        {
            "status": 404,
            "title": "Not Found"
        }
    ]
}

PATH PARAMS

id                                                              REQUIRED

int32                                                        ID of the custom field to update

 

BODY PARAMS

dealCustomFieldMetum

object

 

dealCustomFieldMetum.field_label

string                                                        Name of the field

 

dealCustomFieldMetum.field_options

array of strings                                          Options for the field. Only necessary if field_type is dropdown, multiselect, radio, or checkbox.

 

dealCustomFieldMetum.field_default

string                                                        Default value of the field

 

dealCustomFieldMetum.is_form_visible

boolean                                                     Whether or not the field is visible on forms

 

dealCustomFieldMetum.is_required

boolean                                                     Whether or not the field is required on forms

 

dealCustomFieldMetum.display_order

int32                                                         Order for displaying the field on Manage Fields page and deal profiles

To update a custom deal field, the following permissions are required.

• Deal permission: the user should have permission to manage deals.
• Pipeline-specific permission: the user should have permission to manage the pipeline that the deal belongs to. If the user does not have the permission to manage the pipeline, limited deal data are returned with only id, title, and isDisabled set to 1.