Create an event definition

post https://api.ycloud.com/v2/event/definitions

Creates a custom event definition.

Response

Response body

object

name

string

The name of the custom event definition.

label

string

length ≤ 50

The label of the event definition, used for display purposes.

description

string

The description of the event definition.

objectType

string

Type of the object that the event will be associated with.

CONTACT: Indicates that the object is a contact.

CONTACT

createTime

date-time

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

properties

array of objects

The list of property definitions for the event definition.

properties

object

name

string

The name of the custom property.

label

string

length ≤ 50

The label of the property, used for display purposes.

description

string

The description of the property.

createTime

date-time

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

type

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

Header


xxxxxxxxxx
1
curl --request POST \
2
     --url https://api.ycloud.com/v2/event/definitions \
3
     --header 'accept: application/json' \
4
     --header 'content-type: application/json' \
5
     --data '
6
{
7
  "objectType": "CONTACT"
8
}
9
'


xxxxxxxxxx
16
 
1
{
2
  "name": "propertyName",
3
  "label": "Property Label",
4
  "description": "Describes this property",
5
  "objectType": "CONTACT",
6
  "createTime": "2024-08-22T00:00:00.000Z",
7
  "properties": [
8
    {
9
      "name": "propertyName",
10
      "label": "Property Label",
11
      "description": "Describes this property",
12
      "createTime": "2024-08-22T00:00:00.000Z",
13
      "type": "STRING"
14
    }
15
  ]
16
}

200Successfully created an event definition.