Create a custom field

POST  https://:account.api-us1.com/api/3/dealCustomFieldMeta

• text field

{	
	"dealCustomFieldMetum": {
		"field_label": "sample text field",
		"field_type": "text",
		"field_default": "Default Text",
		"is_form_visible": 1,
		"is_required": 1,
		"display_order": 1
	}
}

• dropdown field

{	
	"dealCustomFieldMetum": {
		"field_label": "sample dropdown field",
		"field_type": "dropdown",
		"field_default": "option 2",
		"field_options": [
			"option 1",
			"option 2",
			"option 3"
		]
		"is_form_visible": 1,
		"is_required": 1,
		"display_order": 1
	}
}

• money field

{	
	"dealCustomFieldMetum": {
		"field_label": "sample money field",
		"field_type": "currency",
		"field_default": "0.00",
		"field_default_currency": "aud",
		"is_form_visible": 1,
		"is_required": 1,
		"display_order": 1
	}
}

 

200 OK

{
    "dealCustomFieldMetum": {
        "id": "1",
        "fieldLabel": "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 19:57:37",
        "links": {
            "dealCustomFieldData": "https://:account.api-us1.com/api/:version/3/dealCustomFieldMeta/1/dealCustomFieldData"
        }
    }
}

422 Unprocessable Entity

{
	"errors": [
  	"title": "The field type field is required.",
    "detail": "",
    "code": 422,
    "source": {
    	"pointer": "/data/attributes/field_type"
    }
  ]
}

BODY PARAMS

dealCustomFieldMetum

object

 

dealCustomFieldMetum.field_label        REQUIRED

string                                                       Name of the field

 

dealCustomFieldMetum.field_type         REQUIRED

string                                                       Type of field. Possible values are: text, textarea, date, dropdown, multiselect, radio, checkbox, hidden.

 

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.field_default_currency

string                                                       The 3-letter currency code of the default currency for the field. Only necessary if field_type is currency.

 

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 create 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.