{
"name": "propertyName",
"label": "Property Label",
"description": "Describes this property",
"createTime": "2024-08-22T00:00:00.000Z",
"type": "STRING"
}{
"error": {
"status": 404,
"code": "NOT_FOUND",
"message": "The requested resource does not exist.",
"target": "",
"docUrl": "",
"requestId": "req_1KjtKI80IKoaJNa6n6p",
"whatsappApiError": {
"message": "HSM Template creation failed",
"code": 200002,
"type": "OAuthException",
"is_transient": false,
"error_subcode": 2388109,
"error_user_msg": "This message template cannot be created.",
"error_user_title": "Message Cannot Be Submitted",
"fbtrace_id": "AVGjJ7ia2zJkrHG",
"error_data": "<string>"
},
"metaBusinessAgentApiError": {
"title": "<string>",
"detail": "<string>",
"type": "<string>",
"status": 123,
"requestId": "<string>"
}
}
}Custom Events
Create an event property definition
Defines a new property for the event definition.
POST
https://api.ycloud.com/v2
/
event
/
definitions
/
{name}
/
properties
{
"name": "propertyName",
"label": "Property Label",
"description": "Describes this property",
"createTime": "2024-08-22T00:00:00.000Z",
"type": "STRING"
}{
"error": {
"status": 404,
"code": "NOT_FOUND",
"message": "The requested resource does not exist.",
"target": "",
"docUrl": "",
"requestId": "req_1KjtKI80IKoaJNa6n6p",
"whatsappApiError": {
"message": "HSM Template creation failed",
"code": 200002,
"type": "OAuthException",
"is_transient": false,
"error_subcode": 2388109,
"error_user_msg": "This message template cannot be created.",
"error_user_title": "Message Cannot Be Submitted",
"fbtrace_id": "AVGjJ7ia2zJkrHG",
"error_data": "<string>"
},
"metaBusinessAgentApiError": {
"title": "<string>",
"detail": "<string>",
"type": "<string>",
"status": 123,
"requestId": "<string>"
}
}
}Authorizations
Path Parameters
Name of the custom event.
Pattern:
[a-z0-9_]{1,50}Example:
"unique_event_name"
Body
application/json
Contains the properties of the custom event property definition to be created.
The unique name of the custom property.
Maximum string length:
50Pattern:
^[a-z][a-z0-9_]{1,50}$Example:
"unique_property_name"
The label of the property.
Maximum string length:
50Example:
"Property Label"
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 withhttp://orhttps://.
Available options:
STRING, NUMBER, TIMESTAMP, URL Example:
"STRING"
The description of the property.
Example:
"Describes this property"
Response
Successfully created an event property.
Represents a custom property of a custom event definition.
The name of the custom property.
Example:
"propertyName"
The label of the property, used for display purposes.
Maximum string length:
50Example:
"Property Label"
The description of the property.
Example:
"Describes this property"
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 withhttp://orhttps://.
Available options:
STRING, NUMBER, TIMESTAMP, URL