Merge Marketing Automation

Messages

The Message object is used to represent a text message, in-app message or a message sent via another channel in the remote system.

The Message object

Properties

from_nameString

Optional

The message's from-name.

send_dateString

Optional

When the message was sent.

bodyString

Optional

The message's body.

remote_was_deletedBoolean

Required

Indicates whether or not this object has been deleted by third party webhooks.

idString

Required

remote_idString

Optional

The third-party API ID of the matching object.

field_mappingsObject

Optional

modified_atString

Required

This is the datetime that this object was last updated by Merge

remote_dataRemoteData[]

Optional

The Message object

JSON


{
  "from_name": "Merge",
  "send_date": "2022-12-23T00:00:00Z",
  "body": "Here's what's new in December!",
  "remote_was_deleted": true,
  "id": "3734cbc6-6040-430a-475r-aafacbadr6wq",
  "remote_id": "20",
Show advanced fields
}

GET

/messages

Returns a list of Message 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, only objects synced by Merge after this date time will be returned.

modified_beforeString

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.

remote_idString

Optional

The API provider's ID for the given object.

Response

JSON


{
  "next": "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
  "previous": "cj1sZXdwd2VycWVtY29zZnNkc2NzUWxNMEUxTXk0ME16UXpNallsTWtJ",
  "results": [
    {
      "from_name": "Merge",
      "send_date": "2022-12-23T00:00:00Z",
      "body": "Here's what's new in December!",
      "remote_was_deleted": true,
      "id": "3734cbc6-6040-430a-475r-aafacbadr6wq",
      "remote_id": "20",
Show advanced fields
    }
  ]
}

Customer.io

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

bodyString

from_nameString

remote_dataRemoteData[]

pathstring

dataobject

remote_idString

send_dateString

Klaviyo

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

bodyString

remote_idString

send_dateString

MessageBird

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

bodyString

from_nameString

remote_dataRemoteData[]

pathstring

dataobject

remote_idString

send_dateString

Sendinblue

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

bodyString

from_nameString

remote_dataRemoteData[]

pathstring

dataobject

remote_idString

send_dateString

Hint: Use the /linked-accounts endpoint to pull platform support information.

GET

/messages/{id}

Returns a Message 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


{
  "from_name": "Merge",
  "send_date": "2022-12-23T00:00:00Z",
  "body": "Here's what's new in December!",
  "remote_was_deleted": true,
  "id": "3734cbc6-6040-430a-475r-aafacbadr6wq",
  "remote_id": "20",
Show advanced fields
}

Customer.io

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

bodyString

from_nameString

remote_dataRemoteData[]

pathstring

dataobject

remote_idString

send_dateString

Klaviyo

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

bodyString

remote_idString

send_dateString

MessageBird

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

bodyString

from_nameString

remote_dataRemoteData[]

pathstring

dataobject

remote_idString

send_dateString

Sendinblue

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

bodyString

from_nameString

remote_dataRemoteData[]

pathstring

dataobject

remote_idString

send_dateString

Hint: Use the /linked-accounts endpoint to pull platform support information.

GET

/messages/{parent_id}/recipients

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",
      "remote_was_deleted": true,
      "id": "5858cbc6-6040-430a-475r-aafacbadrg64",
      "remote_id": "35",
Show advanced fields
    }
  ]
}