Create an Event

Create an Event object

Parameter

Accessible via URL https://api.channel.io/open/v3/users/{userId}/events and HTTP POST

📘

Present parameters in POST body. This method accepts application/json

Parameter

Example

Required

Description

Parameter type

userId

5ec3a01fe2b3f4d2cbc5

Required

ID of User

Path

Example

POST https://api.channel.io/open/v3/users/5ec3a01fe2b3f4d2cbc5/events

Your POST request body should look like

{
  "name": "string",
  "property": {
    "additionalProp1": {},
    "additionalProp2": {},
    "additionalProp3": {}
  } 
}

Response

Returns a newly created Event object.

{
  "event": {
    "id": "string",
    "channelId": "string",
    "personId": "string",
    "personType": "user",
    "name": "string",
    "property": {
      "additionalProp1": {},
      "additionalProp2": {},
      "additionalProp3": {}
    },
    "createdAt": 1598406956929,
    "expireAt": 1598406956929
  }
}