Update a custom field value for contact

Updates one stored custom field value by its fieldValue id. The request must include the fieldValue's contact and field ids along with the new value: omitting them fails with a misleading 404 that reports "No Result found for Field with id 0" rather than a validation error. Multi-select fields use the ||option 1||option 2|| format. Date and datetime values are accepted and returned in ISO 8601. The response side-loads the updated contact in a contacts array. 403 without contact-edit permission.

🚧

Datetime field values will be converted to your account's timezone when saved

Example: If an account has a timezone setting of Central (America/Chicago):

  • Sending a datetime w/ timezone of 2024-11-01T13:05:00-06:00 will be saved in the account's preference of Chicago's (Central) timezone: 2024-11-01T14:05:00-05:00

Example PUT Request

{
    "fieldValue": {
        "contact": 4,
        "field": 24,
        "value": "Blue"
    },
    "useDefaults": true
}
{
    "fieldValue": {
        "contact": 2,
        "field": 5,
        "value": "Option 1"
    }
}
{
    "fieldValue": {
        "contact": 2,
        "field": 7,
        "value": "2018-12-31"
    }
}
{
    "fieldValue": {
        "contact": 2,
        "field": 7,
        "value": "2020-05-19T02:45:00-05:00"
    }
}
{
    "fieldValue": {
        "contact": 2,
        "field": 6,
        "value": "||Option 2||"
    }
}
{
    "fieldValue": {
        "contact": 2,
        "field": 6,
        "value": "||Option 1||Option 3||Option 4||"
    }
}
Path Params
string
required

ID of the fieldValue to update

Body Params
fieldValue
object
boolean
Defaults to false

If true, this will populate the missing required fields for this contact with default values

Responses

Language
Credentials
Header
URL
LoadingLoading…
Response
Choose an example:
application/json