Events
The
Event object is used to represent a marketing event, such as a webinar or email, in the remote system.Properties
emailsArrayRequired
The marketing emails about this event.
messagesArrayRequired
The messages about this event.
nameStringOptional
The event's name.
descriptionStringOptional
The event's description.
remote_created_atDateTime (ISO 8601)Optional
When the event was created in the remote system.
start_timeDateTime (ISO 8601)Optional
When the event starts.
end_timeDateTime (ISO 8601)Optional
When the event ends.
remote_was_deletedBooleanRequired
Indicates whether or not this object has been deleted in the third party platform.
idUUIDRequired
remote_idStringOptional
The third-party API ID of the matching object.
created_atDateTime (ISO 8601)Required
modified_atDateTime (ISO 8601)Required
This is the datetime that this object was last updated by Merge
field_mappingsObjectOptional
remote_dataRemoteData[]Optional
GET
/events
https://api.merge.dev/api/mktg/v1/events
US
EU
Returns a list of Event objects.
Query & Path Parameters
created_afterDateTime (ISO 8601)Optional
If provided, will only return objects created after this datetime.
created_beforeDateTime (ISO 8601)Optional
If provided, will only return objects created before this datetime.
cursorStringOptional
The pagination cursor value.
include_deleted_dataBooleanOptional
Whether to include data that was marked as deleted by third party webhooks.
include_remote_dataBooleanOptional
Whether to include the original data Merge fetched from the third-party to produce these models.
modified_afterDateTime (ISO 8601)Optional
If provided, only objects synced by Merge after this date time will be returned.
modified_beforeDateTime (ISO 8601)Optional
If provided, only objects synced by Merge before this date time will be returned.
page_sizeIntegerOptional
Number of results to return per page.
remote_idStringOptional
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
descriptionStringremote_created_atDateTime (ISO 8601)remote_idStringGET
/events/{id}
https://api.merge.dev/api/mktg/v1/events/{id}
US
EU
Returns an Event object with the given id.
Query & Path Parameters
idUUIDRequired
include_remote_dataBooleanOptional
Whether to include the original data Merge fetched from the third-party to produce these models.
Field support by integration
See all supported fieldsCustomer.io
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API.
Supported Response Fields
descriptionStringremote_created_atDateTime (ISO 8601)remote_idStringGET
/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
cursorStringOptional
The pagination cursor value.
include_deleted_dataBooleanOptional
Whether to include data that was marked as deleted by third party webhooks.
include_remote_dataBooleanOptional
Whether to include the original data Merge fetched from the third-party to produce these models.
page_sizeIntegerOptional
Number of results to return per page.
parent_idUUIDRequired
Field support by integration
See all supported fieldsCustomer.io
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API.
Supported Response Fields
descriptionStringremote_created_atDateTime (ISO 8601)remote_idString