Update an event property

Update property

curl --request PATCH \
  --url https://api.hubapi.com/events/2026-09/event-definitions/{eventName}/property/{propertyName} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "description": "<string>",
  "displayOrder": 123,
  "hidden": true,
  "label": "<string>",
  "options": [
    {
      "displayOrder": 123,
      "hidden": true,
      "label": "<string>",
      "value": "<string>",
      "description": "<string>"
    }
  ]
}
'

import requests

url = "https://api.hubapi.com/events/2026-09/event-definitions/{eventName}/property/{propertyName}"

payload = {
    "description": "<string>",
    "displayOrder": 123,
    "hidden": True,
    "label": "<string>",
    "options": [
        {
            "displayOrder": 123,
            "hidden": True,
            "label": "<string>",
            "value": "<string>",
            "description": "<string>"
        }
    ]
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PATCH',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    description: '<string>',
    displayOrder: 123,
    hidden: true,
    label: '<string>',
    options: [
      {
        displayOrder: 123,
        hidden: true,
        label: '<string>',
        value: '<string>',
        description: '<string>'
      }
    ]
  })
};

fetch('https://api.hubapi.com/events/2026-09/event-definitions/{eventName}/property/{propertyName}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.hubapi.com/events/2026-09/event-definitions/{eventName}/property/{propertyName}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'description' => '<string>',
    'displayOrder' => 123,
    'hidden' => true,
    'label' => '<string>',
    'options' => [
        [
                'displayOrder' => 123,
                'hidden' => true,
                'label' => '<string>',
                'value' => '<string>',
                'description' => '<string>'
        ]
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.hubapi.com/events/2026-09/event-definitions/{eventName}/property/{propertyName}"

	payload := strings.NewReader("{\n  \"description\": \"<string>\",\n  \"displayOrder\": 123,\n  \"hidden\": true,\n  \"label\": \"<string>\",\n  \"options\": [\n    {\n      \"displayOrder\": 123,\n      \"hidden\": true,\n      \"label\": \"<string>\",\n      \"value\": \"<string>\",\n      \"description\": \"<string>\"\n    }\n  ]\n}")

	req, _ := http.NewRequest("PATCH", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.patch("https://api.hubapi.com/events/2026-09/event-definitions/{eventName}/property/{propertyName}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"description\": \"<string>\",\n  \"displayOrder\": 123,\n  \"hidden\": true,\n  \"label\": \"<string>\",\n  \"options\": [\n    {\n      \"displayOrder\": 123,\n      \"hidden\": true,\n      \"label\": \"<string>\",\n      \"value\": \"<string>\",\n      \"description\": \"<string>\"\n    }\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.hubapi.com/events/2026-09/event-definitions/{eventName}/property/{propertyName}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"description\": \"<string>\",\n  \"displayOrder\": 123,\n  \"hidden\": true,\n  \"label\": \"<string>\",\n  \"options\": [\n    {\n      \"displayOrder\": 123,\n      \"hidden\": true,\n      \"label\": \"<string>\",\n      \"value\": \"<string>\",\n      \"description\": \"<string>\"\n    }\n  ]\n}"

response = http.request(request)
puts response.read_body

{
  "description": "<string>",
  "fieldType": "<string>",
  "groupName": "<string>",
  "label": "<string>",
  "name": "<string>",
  "options": [
    {
      "hidden": true,
      "label": "<string>",
      "value": "<string>",
      "description": "<string>",
      "displayOrder": 123
    }
  ],
  "type": "<string>",
  "archived": true,
  "archivedAt": "2023-11-07T05:31:56Z",
  "calculated": true,
  "calculationFormula": "<string>",
  "createdAt": "2023-11-07T05:31:56Z",
  "createdUserId": "<string>",
  "currencyPropertyName": "<string>",
  "dataSensitivity": "highly_sensitive",
  "dateDisplayHint": "absolute",
  "displayOrder": 123,
  "externalOptions": true,
  "formField": true,
  "hasUniqueValue": true,
  "hidden": false,
  "hubspotDefined": true,
  "modificationMetadata": {
    "archivable": true,
    "readOnlyDefinition": true,
    "readOnlyValue": true,
    "readOnlyOptions": true
  },
  "numberDisplayHint": "currency",
  "referencedObjectType": "<string>",
  "sensitiveDataCategories": [
    "<string>"
  ],
  "showCurrencySymbol": true,
  "textDisplayHint": "domain_name",
  "updatedAt": "2023-11-07T05:31:56Z",
  "updatedUserId": "<string>"
}

{
  "message": "Invalid input (details will vary based on the error)",
  "correlationId": "aeb5f871-7f07-4993-9211-075dc63e7cbf",
  "category": "VALIDATION_ERROR",
  "links": {
    "knowledge-base": "https://www.hubspot.com/products/service/knowledge-base"
  }
}

PATCH

events

2026-09

event-definitions

{eventName}

property

{propertyName}

Update property

curl --request PATCH \
  --url https://api.hubapi.com/events/2026-09/event-definitions/{eventName}/property/{propertyName} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "description": "<string>",
  "displayOrder": 123,
  "hidden": true,
  "label": "<string>",
  "options": [
    {
      "displayOrder": 123,
      "hidden": true,
      "label": "<string>",
      "value": "<string>",
      "description": "<string>"
    }
  ]
}
'

import requests

url = "https://api.hubapi.com/events/2026-09/event-definitions/{eventName}/property/{propertyName}"

payload = {
    "description": "<string>",
    "displayOrder": 123,
    "hidden": True,
    "label": "<string>",
    "options": [
        {
            "displayOrder": 123,
            "hidden": True,
            "label": "<string>",
            "value": "<string>",
            "description": "<string>"
        }
    ]
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PATCH',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    description: '<string>',
    displayOrder: 123,
    hidden: true,
    label: '<string>',
    options: [
      {
        displayOrder: 123,
        hidden: true,
        label: '<string>',
        value: '<string>',
        description: '<string>'
      }
    ]
  })
};

fetch('https://api.hubapi.com/events/2026-09/event-definitions/{eventName}/property/{propertyName}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.hubapi.com/events/2026-09/event-definitions/{eventName}/property/{propertyName}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'description' => '<string>',
    'displayOrder' => 123,
    'hidden' => true,
    'label' => '<string>',
    'options' => [
        [
                'displayOrder' => 123,
                'hidden' => true,
                'label' => '<string>',
                'value' => '<string>',
                'description' => '<string>'
        ]
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.hubapi.com/events/2026-09/event-definitions/{eventName}/property/{propertyName}"

	payload := strings.NewReader("{\n  \"description\": \"<string>\",\n  \"displayOrder\": 123,\n  \"hidden\": true,\n  \"label\": \"<string>\",\n  \"options\": [\n    {\n      \"displayOrder\": 123,\n      \"hidden\": true,\n      \"label\": \"<string>\",\n      \"value\": \"<string>\",\n      \"description\": \"<string>\"\n    }\n  ]\n}")

	req, _ := http.NewRequest("PATCH", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.patch("https://api.hubapi.com/events/2026-09/event-definitions/{eventName}/property/{propertyName}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"description\": \"<string>\",\n  \"displayOrder\": 123,\n  \"hidden\": true,\n  \"label\": \"<string>\",\n  \"options\": [\n    {\n      \"displayOrder\": 123,\n      \"hidden\": true,\n      \"label\": \"<string>\",\n      \"value\": \"<string>\",\n      \"description\": \"<string>\"\n    }\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.hubapi.com/events/2026-09/event-definitions/{eventName}/property/{propertyName}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"description\": \"<string>\",\n  \"displayOrder\": 123,\n  \"hidden\": true,\n  \"label\": \"<string>\",\n  \"options\": [\n    {\n      \"displayOrder\": 123,\n      \"hidden\": true,\n      \"label\": \"<string>\",\n      \"value\": \"<string>\",\n      \"description\": \"<string>\"\n    }\n  ]\n}"

response = http.request(request)
puts response.read_body

{
  "description": "<string>",
  "fieldType": "<string>",
  "groupName": "<string>",
  "label": "<string>",
  "name": "<string>",
  "options": [
    {
      "hidden": true,
      "label": "<string>",
      "value": "<string>",
      "description": "<string>",
      "displayOrder": 123
    }
  ],
  "type": "<string>",
  "archived": true,
  "archivedAt": "2023-11-07T05:31:56Z",
  "calculated": true,
  "calculationFormula": "<string>",
  "createdAt": "2023-11-07T05:31:56Z",
  "createdUserId": "<string>",
  "currencyPropertyName": "<string>",
  "dataSensitivity": "highly_sensitive",
  "dateDisplayHint": "absolute",
  "displayOrder": 123,
  "externalOptions": true,
  "formField": true,
  "hasUniqueValue": true,
  "hidden": false,
  "hubspotDefined": true,
  "modificationMetadata": {
    "archivable": true,
    "readOnlyDefinition": true,
    "readOnlyValue": true,
    "readOnlyOptions": true
  },
  "numberDisplayHint": "currency",
  "referencedObjectType": "<string>",
  "sensitiveDataCategories": [
    "<string>"
  ],
  "showCurrencySymbol": true,
  "textDisplayHint": "domain_name",
  "updatedAt": "2023-11-07T05:31:56Z",
  "updatedUserId": "<string>"
}

{
  "message": "Invalid input (details will vary based on the error)",
  "correlationId": "aeb5f871-7f07-4993-9211-075dc63e7cbf",
  "category": "VALIDATION_ERROR",
  "links": {
    "knowledge-base": "https://www.hubspot.com/products/service/knowledge-base"
  }
}

Supported products

Required Scopes

Authorizations

Authorization

string

header

required

The access token received from the authorization server in the OAuth 2.0 flow.

Path Parameters

eventName

string

required

The unique identifier of the event whose property you want to update.

propertyName

string

required

The name of the property to be updated within the specified event.

Body

application/json

description

string

A description of the property that will be shown as help text in HubSpot.

displayOrder

integer<int32>

For not hidden properties, indicates the order to display the property on the record's activity timeline (ex: displayOrder: 0 is at the top).

hidden

boolean

Controls whether or not this property is displayed on the record's activity timeline.

label

string

Human readable label for the property. Used in HubSpot UI.

options

object[]

A list of available options for the property if it is an enumeration. NOTE: This field is only applicable for enumerated properties.

Show child attributes

Response

successful operation

A HubSpot property

description

string

required

A description of the property.

fieldType

string

required

The field type of the property.

groupName

string

required

The name of the group to which this property belongs.

label

string

required

The display label for the property.

name

string

required

The unique name of the property.

options

object[]

required

An array of options available for this property, applicable if the property supports multiple values.

Show child attributes

type

string

required

The data type of the property.

archived

boolean

Indicates whether the property is archived.

archivedAt

string<date-time>

The date and time when this property was archived, in ISO 8601 format.

calculated

boolean

Indicates whether the property is calculated.

calculationFormula

string

The formula used to calculate the property's value, if applicable.

createdAt

string<date-time>

The date and time when this property was created, in ISO 8601 format.

createdUserId

string

The ID of the user who created this property.

currencyPropertyName

string

The name of the currency property associated with this property.

dataSensitivity

enum<string>

The sensitivity level of the data, with valid values including 'non_sensitive', 'sensitive', and 'highly_sensitive'.

Available options:

highly_sensitive,

non_sensitive,

sensitive

dateDisplayHint

enum<string>

A hint for displaying date properties, with valid values including 'absolute', 'absolute_with_relative', 'time_since', and 'time_until'.

Available options:

absolute,

absolute_with_relative,

time_since,

time_until

displayOrder

integer<int32>

The order in which this property is displayed relative to other properties.

externalOptions

boolean

Indicates whether the property options are external.

formField

boolean

Indicates whether the property is a form field.

hasUniqueValue

boolean

Indicates whether the property has a unique value.

hidden

boolean

Indicates whether the property is hidden.

Example:

false

hubspotDefined

boolean

Indicates whether the property is defined by HubSpot.

modificationMetadata

object

Show child attributes

numberDisplayHint

enum<string>

A hint for displaying number properties, with valid values including 'unformatted', 'formatted', 'currency', 'percentage', 'duration', and 'probability'.

Available options:

currency,

duration,

formatted,

percentage,

probability,

unformatted

referencedObjectType

string

The type of object that this property references.

sensitiveDataCategories

string[]

An array of categories indicating the sensitivity of the data.

showCurrencySymbol

boolean

Indicates whether a currency symbol is shown for the property.

textDisplayHint

enum<string>

A hint for displaying text properties, with valid values including 'unformatted_single_line', 'multi_line', 'email', 'phone_number', 'domain_name', 'ip_address', 'physical_address', and 'postal_code'.

Available options:

domain_name,

email,

ip_address,

multi_line,

phone_number,

physical_address,

postal_code,

unformatted_single_line

updatedAt

string<date-time>

The date and time when this property was last updated, in ISO 8601 format.

updatedUserId

string

The ID of the user who last updated this property.

Last modified on September 9, 2026

Account & Settings

App Management

Authentication

Automation

CMS

Communication preferences

Conversations

CRM

Data studio

Events

Files

Marketing

Meetings

Revenue

Webhooks

Webhooks journal

Update an event property

Authorizations

Path Parameters

Body

Response