Events
The Event object is used to represent a marketing event, such as a webinar or email, in the remote system.
Properties
emailsArray
The marketing emails about this event.
messagesArray
The messages about this event.
idUUID
remote_idString
The third-party API ID of the matching object.
created_atDateTime (ISO 8601)
The datetime that this object was created by Merge.
modified_atDateTime (ISO 8601)
The datetime that this object was modified by Merge.
nameString
The event's name.
descriptionString
The event's description.
remote_created_atDateTime (ISO 8601)
When the event was created in the remote system.
start_timeDateTime (ISO 8601)
When the event starts.
end_timeDateTime (ISO 8601)
When the event ends.
remote_was_deletedBoolean
Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. Learn more.
field_mappingsObject
remote_dataRemoteData[]
The RemoteData object
The RemoteData object is used to represent the full data pulled from the third-party API for an object.
Properties
pathString
The third-party API path that is being called.
dataAny
The data returned from the third-party for this object in its original, unnormalized format.
GET
/events

https://api.merge.dev/api/mktg/v1/events

US
EU
APAC

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.
cursorString
Optional
The pagination cursor value.
include_deleted_dataBoolean
Optional
Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. Learn more.
include_remote_dataBoolean
Optional
Whether to include the original data Merge fetched from the third-party to produce these models.
include_shell_dataBoolean
Optional
Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
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_sizeInteger
Optional
Number of results to return per page. The maximum limit is 100.
remote_idString
Optional
The API provider's ID for the given object.
Field support by integration
Use the /linked-accounts endpoint to pull platform support information
Customer.io
Customer.io
Not seeing an integration that you're looking for?
GET
/events/{id}

https://api.merge.dev/api/mktg/v1/events/{id}

US
EU
APAC

Returns an Event object with the given id.


Query & path parameters
idUUID
Required
include_remote_dataBoolean
Optional
Whether to include the original data Merge fetched from the third-party to produce these models.
include_shell_dataBoolean
Optional
Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
Field support by integration
Use the /linked-accounts endpoint to pull platform support information
Customer.io
Customer.io
Not seeing an integration that you're looking for?
GET
/events/{parent_id}/contacts

https://api.merge.dev/api/mktg/v1/events/{parent_id}/contacts

US
EU
APAC

Returns a list of Contact objects.


Query & path parameters
cursorString
Optional
The pagination cursor value.
include_deleted_dataBoolean
Optional
Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. Learn more.
include_remote_dataBoolean
Optional
Whether to include the original data Merge fetched from the third-party to produce these models.
include_shell_dataBoolean
Optional
Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
page_sizeInteger
Optional
Number of results to return per page. The maximum limit is 100.
parent_idUUID
Required
Field support by integration
Use the /linked-accounts endpoint to pull platform support information
Customer.io
Customer.io
Not seeing an integration that you're looking for?