Create a custom field value

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

• text value

{
	"dealCustomFieldDatum": {
		"dealId": "2",
		"custom_field_id": "1",
		"fieldValue": "test title"
	}
}

• dropdown/radio value

{
	"dealCustomFieldDatum": {
		"dealId": "2",
		"custom_field_id": "2",
		"fieldValue": "option 1"
	}
}

• multiselect/checkbox values

// for multiple values
{
	"dealCustomFieldDatum": {
		"dealId": "2",
		"custom_field_id": "3",
		"fieldValue": [
			"option 1",
			"option 3",
			"option 4"
		]
	}
}

// for one value
{
	"dealCustomFieldDatum": {
		"dealId": "2",
		"custom_field_id": "3",
		"fieldValue": [
			"option 1"
		]
	}
}

• money value

{
	"dealCustomFieldDatum": {
		"dealId": "1",
		"custom_field_id": "4",
		"fieldValue": "9999",
		"fieldCurrency": "cad"
	}
}

• number value

{
	"dealCustomFieldDatum": {
		"dealId": "1",
		"custom_field_id": "5",
		"fieldValue": "100.99"
	}
}

• date value

{
	"dealCustomFieldDatum": {
		"dealId": "1",
		"custom_field_id": "6",
		"fieldValue": "2018-12-31 00:00:00"
	}
}

 

200 OK

{
    "dealCustomFieldDatum": {
        "id": "5",
        "dealCustomFieldMetumId": 1,
        "dealId": 2,
        "customFieldId": 1,
        "createdUtcTimestamp": "2018-11-06 02:27:05",
        "updatedUtcTimestamp": "2018-11-06 02:27:05",
        "fieldValue": "test title",
        "links": {
            "deal": "https://:account.api-us1.com/api/:version/dealCustomFieldData/5/deal",
            "dealCustomFieldMetum": "https://:account.api-us1.com/api/:version/dealCustomFieldData/5/dealCustomFieldMetum"
        }
    }
}

BODY PARAMS

dealCustomFieldDatum

object

 

dealCustomFieldDatum.deal_id                             REQUIRED

int32                                                                       The ID of the deal this field value relates to

 

dealCustomFieldDatum.custom_field_id               REQUIRED

int32                                                                       The ID of the custom field metum this field value relates to

 

dealCustomFieldDatum.field_value                       REQUIRED

string                                                                      Values for the field. (For currency field only, this needs to be in cents: eg, 10050 = 100.5)

 

dealCustomFieldDatum.fieldCurrency

string                                                                      Currency code for the money value

To create a custom deal field value, 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.
• When creating a field value for a multivalued field (checkbox, multiselect), values must be strings in an array, e.g. ["Option 1", "Option 2", "Option 4"], whether one value or multiple are being set.