Events
The
Event
object is used to represent a marketing event, such as a webinar or email, in the remote system.Properties
emails
ArrayRequired
The marketing emails about this event.
messages
ArrayRequired
The messages about this event.
name
StringOptional
The event's name.
description
StringOptional
The event's description.
remote_created_at
DateTime (ISO 8601)Optional
When the event was created in the remote system.
start_time
DateTime (ISO 8601)Optional
When the event starts.
end_time
DateTime (ISO 8601)Optional
When the event ends.
remote_was_deleted
BooleanRequired
Indicates whether or not this object has been deleted in the third party platform.
id
UUIDRequired
remote_id
StringOptional
The third-party API ID of the matching object.
created_at
DateTime (ISO 8601)Required
modified_at
DateTime (ISO 8601)Required
This is the datetime that this object was last updated by Merge
field_mappings
ObjectOptional
remote_data
RemoteData[]Optional
GET
/events
https://api.merge.dev/api/mktg/v1/events
US
EU
Returns a list of Event
objects.
Query & Path Parameters
created_after
DateTime (ISO 8601)Optional
If provided, will only return objects created after this datetime.
created_before
DateTime (ISO 8601)Optional
If provided, will only return objects created before this datetime.
cursor
StringOptional
The pagination cursor value.
include_deleted_data
BooleanOptional
Whether to include data that was marked as deleted by third party webhooks.
include_remote_data
BooleanOptional
Whether to include the original data Merge fetched from the third-party to produce these models.
modified_after
DateTime (ISO 8601)Optional
If provided, only objects synced by Merge after this date time will be returned.
modified_before
DateTime (ISO 8601)Optional
If provided, only objects synced by Merge before this date time will be returned.
page_size
IntegerOptional
Number of results to return per page.
remote_id
StringOptional
The API provider's ID for the given object.
Field support by integration
See all supported fields
Customer.io
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API.
Supported Response Fields
description
Stringremote_created_at
DateTime (ISO 8601)remote_id
StringGET
/events/{id}
https://api.merge.dev/api/mktg/v1/events/{id}
US
EU
Returns an Event
object with the given id
.
Query & Path Parameters
id
UUIDRequired
include_remote_data
BooleanOptional
Whether to include the original data Merge fetched from the third-party to produce these models.
Field support by integration
See all supported fields
Customer.io
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API.
Supported Response Fields
description
Stringremote_created_at
DateTime (ISO 8601)remote_id
StringGET
/events/{parent_id}/contacts
https://api.merge.dev/api/mktg/v1/events/{parent_id}/contacts
US
EU
Returns a list of Contact
objects.
Query & Path Parameters
cursor
StringOptional
The pagination cursor value.
include_deleted_data
BooleanOptional
Whether to include data that was marked as deleted by third party webhooks.
include_remote_data
BooleanOptional
Whether to include the original data Merge fetched from the third-party to produce these models.
page_size
IntegerOptional
Number of results to return per page.
parent_id
UUIDRequired
Field support by integration
See all supported fields
Customer.io
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API.
Supported Response Fields
description
Stringremote_created_at
DateTime (ISO 8601)remote_id
String