Create a new event

Create a marketing-automation event on a customer account. An event records an activity (for example a customer interaction, a transaction, or an external trigger) that may launch a marketing-automation scenario configured for the corresponding event type.

What happens when an event is created

  • An event record is created and its server-generated event_id is returned.
  • If the corresponding event type is wired to a marketing-automation scenario, that scenario is launched and the event's data is passed to it.
  • Property records supplied alongside the event are stored as the event's properties; their values are available to the marketing-automation scenario.

Related operations

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
event
object
required

Event resource.

property_records
array of objects
length ≤ 1000

Additional properties of the event. This parameter contain values in GET response only if query parameter include_property_records is set to true.

property_records
Headers
string
Defaults to cs, en-gb;q=0.8

The unique ID of the language code by ISO 639-1.

Responses

error.error_data.invalid_params[] array lists the parameters that caused the failure, each carrying a reason code. See the BadRequestErrorBody schema for the generic reason taxonomy. Operations with domain-specific business rules document additional reasons at the operation level.

429

Too many requests - more than the resource limit.

503

Temporary state when the service is temporarily unavailable, overloaded or there is a maintenance window.

Language
Credentials
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json