Sign in

v1

latestOpenAPI 3.0.02026-07-2491237338.9 KB
Custom Events

Update an event property definition

Updates an event property definition's label and description.

patch/event/definitions/{name}/properties/{propertyName}

Path parameters

namestring required
Example:unique_event_name

Name of the custom event.

propertyNamestring required
Example:unique_property_name

Name of the custom event property.

Request body

labelstring

The label of the event property definition.

descriptionstring

The description of the event property definition.

Example request

{
  "label": "New label",
  "description": "Describes the event property"
}

Response

Successfully updated the event property definition.

namestring

The name of the custom property.

labelstring

The label of the property, used for display purposes.

descriptionstring

The description of the property.

createTimestring date-time

The time at which this object is created, formatted in RFC 3339. e.g., 2022-06-01T12:00:00.000Z.

type'STRING' | 'NUMBER' | 'TIMESTAMP' | 'URL'

The data type of the property.

  • STRING: Indicates a property that receives plain text strings.
  • NUMBER: Indicates a property that receives numeric values with up to one decimal.
  • TIMESTAMP: Indicates a property that receives epoch millisecond.
  • URL: Indicates a property that receives URLs, formatted as strings starting with http:// or https://.

Example response

{
  "name": "propertyName",
  "label": "Property Label",
  "description": "Describes this property",
  "createTime": "2024-08-22T00:00:00.000Z"
}