Update a contact property

Last updated June 17, 2020

PUT /properties/v1/contacts/properties/named/:property_name

Method Details

HTTP Methods:

PUT

Content Type:

application/json

Response Format:

json

Requires Authentication?

Yes

Rate Limited?

Yes

Headers

User-Agent

Products:

Marketing & CRM

Required Scope:

contacts

This endpoint is used to update a specified contact property.

See the page for creating a property for more details about how type and fieldtype related to each other.

Use case for this endpoint: If you previously created an enumerated property with specific options, and the options change in your system, you can use this endpoint to update the options available .

Note: If you're updating the options for a property with "type": "enumeration," you must include all of the options that you want to use with the property; there is no way to append or remove a single option.

Example URL to PUT: https://api.hubapi.com/properties/v1/contacts/properties/named/custom_field?hapikey=demo

Response details

  • Returns a 200 response when a property is successfully updated.
  • Returns a 400 error with more details in the response body if there is a problem with the data.
Required parameters How to use Description
OAuth Access Token or API Key Authorization: Bearer {token} header
or hapikey={key} query parameter.
Used to authenticate the request. Please see this page for more details about authentication.
Property name Used in the request URL You must include the property name in the URL that you're using to make the request. This property name can only include lower case letters and numbers, and MUST start with a lower case letter. Also, the name of the property that you include in your URL here MUST be identical to the property name that you include in the JSON request body (seen below)
Property JSON Used in the request body See the documentation for creating a contact property for more details on the available options you can use.
Optional parameters How to use Description
Enumerated options "options": {list of options}
Used in the request body.
The list of options for enumerated properties. NOTE: If you're including this field, it will OVERWRITE the existing options. There is not a way to just append or remove a single option, so you'll need to include all of the options you want to keep when updating a property.
Optional JSON data Used in the request body. See the documentation for creating a contact for more details on the available options you can use.