Update a custom field value

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

• text value

{
	"dealCustomFieldDatum": {
		"fieldValue": "New title"
	}
}

• dropdown/radio value

{
	"dealCustomFieldDatum": {
		"fieldValue": "option 1"
	}
}

• multiselect/checkbox values

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

// for one value
{
	"dealCustomFieldDatum": {
		"fieldValue": [
			"option 1"
		]
	}
}

• money value

{
	"dealCustomFieldDatum": {
		"fieldValue": "9999",
		"fieldCurrency": "cad"
	}
}

• number value

{
	"dealCustomFieldDatum": {
		"fieldValue": "100.99"
	}
}

• date value

{
	"dealCustomFieldDatum": {
		"fieldValue": "2018-12-31 00:00:00"
	}
}

 

200 OK

{
    "dealCustomFieldDatum": {
        "id": "1",
        "dealCustomFieldMetumId": 5,
        "dealId": 2,
        "customFieldId": 5,
        "createdUtcTimestamp": "2018-10-29 20:40:38",
        "updatedUtcTimestamp": "2018-11-06 02:21:36",
        "fieldValue": "New title",
        "links": {
            "deal": "https://:account.api-us1.com/api/:version/dealCustomFieldData/1/deal",
            "dealCustomFieldMetum": "https://:account.api-us1.com/api/:version/dealCustomFieldData/1/dealCustomFieldMetum"
        }
    }
}

404 Not Found

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

PATH PARAMS

id                                                            REQUIRED

int32                                                      ID of the custom fields value to update

 

BODY PARAMS

dealCustomFieldDatum

object

 

dealCustomFieldDatum.field_value

string                                                     Values for text

 

dealCustomFieldDatum.fieldCurrency

string                                                     Currency code for the money value

 

To update 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 updating 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.