Templates
The Template object is used to represent a template for a marketing asset in the remote system.
Properties
idUUID
Required
remote_idString
Optional
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
nameString
Optional
The template's name.
typeEnum
Optional
The template's type. Possible values include: EMAIL, MESSAGE. In cases where there is no clear mapping, the original value passed through will be returned.
contentsString
Optional
The template contents.
ownerUUID
Optional
The template's owner.
remote_created_atDateTime (ISO 8601)
Optional
When the template was created in the remote system.
remote_updated_atDateTime (ISO 8601)
Optional
When the template was last updated in the remote system.
remote_was_deletedBoolean
Required
Indicates whether or not this object has been deleted in the third party platform.
field_mappingsObject
Optional
remote_dataRemoteData[]
Optional
GET
/templates

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

US
EU

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.
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_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.
remote_idString
Optional
The API provider's ID for the given object.
Field support by integration
See all supported fields
Use the /linked-accounts endpoint to pull platform support information
ActiveCampaign
ActiveCampaign
Customer.io
Customer.io
Hubspot Marketing Hub
Hubspot Marketing Hub
Klaviyo
Klaviyo
Mailchimp
Mailchimp
Podium
Podium
SendGrid
SendGrid
POST
/templates

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

US
EU

Creates a Template object with the given values.


Query & Path Parameters
is_debug_modeBoolean
Optional
Whether to include debug fields (such as log file links) in the response.
run_asyncBoolean
Optional
Whether or not third-party updates should be run asynchronously.
Body Parameters
modelObject
Required
Find available fields below under “Model Parameters”.
Model Parameters
View app-specific writable fields under “Field support by platform” in this section.
nameString
The template's name.
typeEnum
The template's type. Must pass in one of the following choices: EMAIL, MESSAGE.
contentsString
The template contents.
ownerUUID
The template's owner. Must pass in a valid Merge ID, which can be obtained from the id field in the Owner object.
integration_paramsObject
linked_account_paramsObject
Field support by integration
See all supported fields
Use the /linked-accounts endpoint to pull platform support information
Mailchimp
Mailchimp
Not seeing an integration that you're looking for? Submit a request for it.
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

Returns a Template 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.
Field support by integration
See all supported fields
Use the /linked-accounts endpoint to pull platform support information
ActiveCampaign
ActiveCampaign
Customer.io
Customer.io
Hubspot Marketing Hub
Hubspot Marketing Hub
Klaviyo
Klaviyo
Mailchimp
Mailchimp
Podium
Podium
SendGrid
SendGrid
GET
/templates/meta/post

https://api.merge.dev/api/mktg/v1/templates/meta/post

US
EU

Returns metadata for MKTGTemplate POSTs.


Field support by integration
See all supported fields
Use the /linked-accounts endpoint to pull platform support information
Mailchimp
Mailchimp
Not seeing an integration that you're looking for? Submit a request for it.
Previous
Messages
Next Up
Users