Create an event property definition

Defines a new property for the event definition.

Log in to see full request history
Path Params
string
required

Name of the custom event.

Body Params
string
required
length ≤ 50

The unique name of the custom property.

string
required
length ≤ 50

The label of the property.

string

The description of the property.

string
required

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://.
Responses

Response body
object
string

The name of the custom property.

string
length ≤ 50

The label of the property, used for display purposes.

string

The description of the property.

date-time

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

string

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://.

STRING NUMBER TIMESTAMP URL

Language
Credentials