post https://{youraccountname}.api-us1.com/api/3/dealCustomFieldMeta
You must call /groupMembers after creating the Custom Field
After creating the custom field, you must call the Add Custom Field to Field Group api to add the custom field to a field group. Failure to do so will result in fields that are not visible on record pages.
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
, andisDisabled
set to1
.
{
"dealCustomFieldMetum": {
"fieldLabel": "sample text field2",
"fieldType": "text",
"fieldDefault": "Default Text",
"isFormVisible": 1,
"displayOrder": 1
}
}
{
"dealCustomFieldMetum": {
"fieldLabel": "sample textarea field",
"fieldType": "textarea",
"fieldDefault": "Default Text in Text Area",
"isFormVisible": 1,
"displayOrder": 2
}
}
{
"dealCustomFieldMetum": {
"fieldLabel": "sample date field",
"fieldType": "date",
"fieldDefault": "2018-12-31 00:00:00",
"isFormVisible": 1,
"displayOrder": 3
}
}
{
"dealCustomFieldMetum": {
"fieldLabel": "sample dropdown field",
"fieldType": "dropdown",
"fieldDefault": "option 2",
"fieldOptions": [
"option 1",
"option 2",
"option 3"
],
"isFormVisible": 1,
"displayOrder": 4
}
}
{
"dealCustomFieldMetum": {
"fieldLabel": "sample multiselect field",
"fieldType": "multiselect",
"fieldDefault": [
"option 2",
"option 3"
],
"fieldOptions": [
"option 1",
"option 2",
"option 3"
],
"isFormVisible": 1,
"displayOrder": 5
}
}
{
"dealCustomFieldMetum": {
"fieldLabel": "sample radio field",
"fieldType": "radio",
"fieldDefault": "option 2",
"fieldOptions": [
"option 1",
"option 2",
"option 3"
],
"isFormVisible": 1,
"displayOrder": 6
}
}
{
"dealCustomFieldMetum": {
"fieldLabel": "sample checkbox field",
"fieldType": "checkbox",
"fieldDefault": [
"option 2",
"option 3"
],
"fieldOptions": [
"option 1",
"option 2",
"option 3"
],
"isFormVisible": 1,
"displayOrder": 7
}
}
{
"dealCustomFieldMetum": {
"fieldLabel": "sample hidden field",
"fieldType": "hidden",
"fieldDefault": "Default Text in Hidden Field",
"isFormVisible": 1,
"displayOrder": 8
}
}
{
"dealCustomFieldMetum": {
"fieldLabel": "sample number field",
"fieldType": "number",
"fieldDefault": "100.99",
"isFormVisible": 1,
"displayOrder": 9
}
}
{
"dealCustomFieldMetum": {
"fieldLabel": "sample money field",
"fieldType": "currency",
"fieldDefault": "10099",
"fieldDefaultCurrency": "aud",
"isFormVisible": 1,
"displayOrder": 10
}
}
{
"dealCustomFieldMetum": {
"fieldLabel": "sample datetime field",
"fieldType": "datetime",
"fieldDefault": "2020-05-16T03:15:00-05:00",
"isFormVisible": 1,
"displayOrder": 3
}
}