Events

The Event object is used to represent a marketing event, such as a webinar or email, in the remote system.

The Event object

Properties

emailsArray
Required
The marketing emails about this event.
messagesArray
Required
The messages about this event.
nameString
Optional
The event's name.
descriptionString
Optional
The event's description.
remote_created_atString
Optional
When the event was created in the remote system.
start_timeString
Optional
When the event starts.
end_timeString
Optional
When the event ends.
idString
Required
remote_idString
Optional
The third-party API ID of the matching object.
The Event object
JSON
{
  "name": "New Customer Webinar",
  "description": "Webinar for new customers to learn more about the product.",
  "remote_created_at": "2022-12-23T00:00:00Z",
  "emails": [
    "2634cbc6-6040-430a-475r-aafacbadf9he"
  ],
  "messages": [
    "3734cbc6-6040-430a-475r-aafacbadr6wq"
  ],
  "start_time": "2022-01-03T00:00:00Z",
  "end_time": "2022-01-03T01:00:00Z",
  "id": "5648cbc6-6040-430a-475r-aafacbadf8ry",
  "remote_id": "10"
}
GET

/events

Returns a list of Event objects.


Header Parameters

AuthorizationString
Required
Token-based authentication with required prefix "Bearer"
X-Account-TokenString
Required
Token identifying the end user.

Query & Path Parameters

created_afterString
Optional
If provided, will only return objects created after this datetime.
created_beforeString
Optional
If provided, will only return objects created before this datetime.
cursorString
Optional
The pagination cursor value.
include_deleted_dataBoolean
Optional
Whether to include data that was marked as deleted by third party webhooks.
include_remote_dataBoolean
Optional
Whether to include the original data Merge fetched from the third-party to produce these models.
modified_afterString
Optional
If provided, will only return objects modified after this datetime.
modified_beforeString
Optional
If provided, will only return objects modified before this datetime.
page_sizeInteger
Optional
Number of results to return per page.
remote_idString
Optional
The API provider's ID for the given object.
Response
JSON
{
  "next": "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
  "previous": "cj1sZXdwd2VycWVtY29zZnNkc2NzUWxNMEUxTXk0ME16UXpNallsTWtJ",
  "results": [
    {
      "name": "New Customer Webinar",
      "description": "Webinar for new customers to learn more about the product.",
      "remote_created_at": "2022-12-23T00:00:00Z",
      "emails": [
        "2634cbc6-6040-430a-475r-aafacbadf9he"
      ],
      "messages": [
        "3734cbc6-6040-430a-475r-aafacbadr6wq"
      ],
      "start_time": "2022-01-03T00:00:00Z",
      "end_time": "2022-01-03T01:00:00Z",
      "id": "5648cbc6-6040-430a-475r-aafacbadf8ry",
      "remote_id": "10"
    }
  ]
}
Field support by platform

Customer.io

Customer.io

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

descriptionString
remote_created_atString
remote_idString
Not seeing a platform that you're looking for? Submit a request for it here.
Hint: Use the /linked-accounts endpoint to pull platform support information.
GET

/events/{id}

Returns an Event object with the given id.


Header Parameters

AuthorizationString
Required
Token-based authentication with required prefix "Bearer"
X-Account-TokenString
Required
Token identifying the end user.

Query & Path Parameters

idString
Required
include_remote_dataBoolean
Optional
Whether to include the original data Merge fetched from the third-party to produce these models.
Response
JSON
{
  "name": "New Customer Webinar",
  "description": "Webinar for new customers to learn more about the product.",
  "remote_created_at": "2022-12-23T00:00:00Z",
  "emails": [
    "2634cbc6-6040-430a-475r-aafacbadf9he"
  ],
  "messages": [
    "3734cbc6-6040-430a-475r-aafacbadr6wq"
  ],
  "start_time": "2022-01-03T00:00:00Z",
  "end_time": "2022-01-03T01:00:00Z",
  "id": "5648cbc6-6040-430a-475r-aafacbadf8ry",
  "remote_id": "10"
}
Field support by platform

Customer.io

Customer.io

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

descriptionString
remote_created_atString
remote_idString
Not seeing a platform that you're looking for? Submit a request for it here.
Hint: Use the /linked-accounts endpoint to pull platform support information.
GET

/events/{parent_id}/contacts

Returns a list of Contact objects.


Header Parameters

AuthorizationString
Required
Token-based authentication with required prefix "Bearer"
X-Account-TokenString
Required
Token identifying the end user.

Query & Path Parameters

cursorString
Optional
The pagination cursor value.
include_deleted_dataBoolean
Optional
Whether to include data that was marked as deleted by third party webhooks.
include_remote_dataBoolean
Optional
Whether to include the original data Merge fetched from the third-party to produce these models.
page_sizeInteger
Optional
Number of results to return per page.
parent_idString
Required
Response
JSON
{
  "next": "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
  "previous": "cj1sZXdwd2VycWVtY29zZnNkc2NzUWxNMEUxTXk0ME16UXpNallsTWtJ",
  "results": [
    {
      "first_name": "Gil",
      "last_name": "Feig",
      "email": "[email protected]",
      "phone": "+13785579223",
      "state": "NY",
      "country": "USA",
      "postal_code": "string",
      "remote_created_at": "2022-12-23T00:00:00Z",
      "remote_updated_at": "2022-12-23T00:00:00Z",
      "id": "5858cbc6-6040-430a-475r-aafacbadrg64",
      "remote_id": "35"
    }
  ]
}
Field support by platform

Customer.io

Customer.io

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

descriptionString
remote_created_atString
remote_idString
Not seeing a platform that you're looking for? Submit a request for it here.
Hint: Use the /linked-accounts endpoint to pull platform support information.

Previous

Emails

Next Up

Lists