Templates
The
Template object is used to represent a template for a marketing asset in the remote system.Properties
idUUIDremote_idStringThe 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.
nameStringThe template's name.
typeEnumThe template's type. Possible values include:
EMAIL, MESSAGE. In cases where there is no clear mapping, the original value passed through will be returned. To receive all enum values in the original format, use the show_enum_origins query parameter. Learn more.contentsStringThe template contents.
ownerUUIDThe template's owner.
remote_created_atDateTime (ISO 8601)When the template was created in the remote system.
remote_updated_atDateTime (ISO 8601)When the template was last updated in the remote system.
remote_was_deletedBooleanIndicates 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_mappingsObjectremote_dataRemoteData[]The RemoteData object
The
RemoteData object is used to represent the full data pulled from the third-party API for an object.Properties
pathStringThe third-party API path that is being called.
dataAnyThe data returned from the third-party for this object in its original, unnormalized format.
GET
/templates
https://api.merge.dev/api/mktg/v1/templates
US
EU
APAC
Returns a list of Template 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
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_dataBooleanOptional
Whether to include the original data Merge fetched from the third-party to produce these models.
include_shell_dataBooleanOptional
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_sizeIntegerOptional
Number of results to return per page.
remote_idStringOptional
The API provider's ID for the given object.
Field support by integration
Use the /linked-accounts endpoint to pull platform support information
ActiveCampaign
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
contentsStringnameStringownerUUIDremote_dataRemoteData[]pathstringdatastringremote_idStringremote_updated_atDateTime (ISO 8601)
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
contentsStringnameStringremote_created_atDateTime (ISO 8601)remote_dataRemoteData[]pathstringdatastringremote_idStringtypeEnum
Hubspot Marketing Hub
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
nameStringremote_dataRemoteData[]pathstringdatastringremote_idStringremote_updated_atDateTime (ISO 8601)typeEnum
Klaviyo
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
contentsStringnameStringremote_created_atDateTime (ISO 8601)remote_dataRemoteData[]pathstringdatastringremote_idStringremote_updated_atDateTime (ISO 8601)
Mailchimp
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
nameStringremote_created_atDateTime (ISO 8601)remote_dataRemoteData[]pathstringdatastringremote_idStringremote_updated_atDateTime (ISO 8601)typeEnum
Podium
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
contentsStringnameStringownerUUIDremote_created_atDateTime (ISO 8601)remote_idStringremote_updated_atDateTime (ISO 8601)typeEnum
SendGrid
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
contentsStringnameStringownerUUIDremote_dataRemoteData[]pathstringdatastringremote_idStringremote_updated_atDateTime (ISO 8601)typeEnumPOST
/templates
https://api.merge.dev/api/mktg/v1/templates
US
EU
APAC
Creates a Template object with the given values.
Query & path parameters
is_debug_modeBooleanOptional
Whether to include debug fields (such as log file links) in the response.
run_asyncBooleanOptional
Whether or not third-party updates should be run asynchronously.
Body parameters
modelObjectRequired
Find available fields below under “Model Parameters”.
Model parameters
View app-specific writable fields under “Field support by platform” in this section.nameStringThe template's name.
typeEnumThe template's type. Must pass in one of the following choices:
EMAIL, MESSAGE.contentsStringThe template contents.
ownerUUIDThe template's owner. Must pass in a valid Merge ID, which can be obtained from the
id field in the Owner object.integration_paramsObjectlinked_account_paramsObjectField support by integration
Use the /linked-accounts endpoint to pull platform support information
Mailchimp
On top of normalized Common Models, Merge also supports Passthrough Requests for this platform's API
Supported POST Model Parameters
nameStringRequired
remote_created_atDateTime (ISO 8601)Optional
remote_idStringOptional
remote_updated_atDateTime (ISO 8601)Optional
typeEnumOptional
Additional POST Parameters
contentsStringRequired
To include the correct model fields when making POST requests, use the GET /templates/meta/post endpoint. Learn more in our /meta guide.
GET
/templates/{id}
https://api.merge.dev/api/mktg/v1/templates/{id}
US
EU
APAC
Returns a Template 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
Use the /linked-accounts endpoint to pull platform support information
ActiveCampaign
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
contentsStringnameStringownerUUIDremote_dataRemoteData[]pathstringdatastringremote_idStringremote_updated_atDateTime (ISO 8601)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
contentsStringnameStringremote_created_atDateTime (ISO 8601)remote_dataRemoteData[]pathstringdatastringremote_idStringtypeEnumHubspot Marketing Hub
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
nameStringremote_dataRemoteData[]pathstringdatastringremote_idStringremote_updated_atDateTime (ISO 8601)typeEnumKlaviyo
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
contentsStringnameStringremote_created_atDateTime (ISO 8601)remote_dataRemoteData[]pathstringdatastringremote_idStringremote_updated_atDateTime (ISO 8601)Mailchimp
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
nameStringremote_created_atDateTime (ISO 8601)remote_dataRemoteData[]pathstringdatastringremote_idStringremote_updated_atDateTime (ISO 8601)typeEnumPodium
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
contentsStringnameStringownerUUIDremote_created_atDateTime (ISO 8601)remote_idStringremote_updated_atDateTime (ISO 8601)typeEnumSendGrid
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
contentsStringnameStringownerUUIDremote_dataRemoteData[]pathstringdatastringremote_idStringremote_updated_atDateTime (ISO 8601)typeEnumGET
/templates/meta/post
https://api.merge.dev/api/mktg/v1/templates/meta/post
US
EU
APAC
Returns metadata for MKTGTemplate POSTs.
Field support by integration
Use the /linked-accounts endpoint to pull platform support information
Mailchimp
On top of normalized Common Models, Merge also supports Passthrough Requests for this platform's API
Supported POST Model Parameters
nameStringRequired
remote_created_atDateTime (ISO 8601)Optional
remote_idStringOptional
remote_updated_atDateTime (ISO 8601)Optional
typeEnumOptional
Additional POST Parameters
contentsStringRequired