Campaigns
The
Campaign object is used to represent a marketing campaign in the remote system.Properties
idUUIDRequired
remote_idStringOptional
The third-party API ID of the matching object.
created_atDateTime (ISO 8601)Required
The datetime that this object was created by Merge.
modified_atDateTime (ISO 8601)Required
The datetime that this object was modified by Merge.
nameStringOptional
The campaign's name.
unique_opensIntegerOptional
The campaign's unique opens.
remote_created_atDateTime (ISO 8601)Optional
When the campaign was created in the remote system.
emails_sentIntegerOptional
The campaign's number of emails sent.
remote_was_deletedBooleanRequired
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_mappingsObjectOptional
remote_dataRemoteData[]Optional
GET
/campaigns
https://api.merge.dev/api/mktg/v1/campaigns
US
EU
APAC
Returns a list of Campaign 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
See all supported fieldsUse 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
emails_sentIntegernameStringremote_created_atDateTime (ISO 8601)remote_dataRemoteData[]pathstringdatastringremote_idStringunique_opensInteger
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
emails_sentIntegernameStringremote_created_atDateTime (ISO 8601)remote_dataRemoteData[]pathstringdatastringremote_idString
getResponse
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_idString
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
emails_sentIntegernameStringremote_dataRemoteData[]pathstringdatastringremote_idString
Klaviyo
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_idString
Mailchimp
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
emails_sentIntegernameStringremote_created_atDateTime (ISO 8601)remote_dataRemoteData[]pathstringdatastringremote_idStringunique_opensInteger
Podium
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_idString
SendGrid
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_idString
Sendinblue
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
emails_sentIntegernameStringremote_created_atDateTime (ISO 8601)remote_dataRemoteData[]pathstringdatastringremote_idStringunique_opensIntegerPOST
/campaigns
https://api.merge.dev/api/mktg/v1/campaigns
US
EU
APAC
Creates a Campaign 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 campaign's name.
unique_opensIntegerThe campaign's unique opens.
emails_sentIntegerThe campaign's number of emails sent.
integration_paramsObjectlinked_account_paramsObjectField support by integration
See all supported fieldsUse the /linked-accounts endpoint to pull platform support information
getResponse
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
Mailchimp
On top of normalized Common Models, Merge also supports Passthrough Requests for this platform's API
Supported POST Model Parameters
emails_sentIntegerOptional
nameStringRequired
remote_created_atDateTime (ISO 8601)Optional
remote_idStringOptional
Sendinblue
On top of normalized Common Models, Merge also supports Passthrough Requests for this platform's API
Supported POST Model Parameters
emails_sentIntegerOptional
nameStringRequired
remote_created_atDateTime (ISO 8601)Optional
remote_idStringOptional
Additional POST Parameters
integration_paramsObjectRequired
sender_emailStringRequired
Klaviyo
To include the correct model fields when making POST requests, use the GET /campaigns/meta/post endpoint. Learn more in our /meta guide.
GET
/campaigns/{id}
https://api.merge.dev/api/mktg/v1/campaigns/{id}
US
EU
APAC
Returns a Campaign 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
See all supported fieldsUse 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
emails_sentIntegernameStringremote_created_atDateTime (ISO 8601)remote_dataRemoteData[]pathstringdatastringremote_idStringunique_opensIntegerCustomer.io
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
emails_sentIntegernameStringremote_created_atDateTime (ISO 8601)remote_dataRemoteData[]pathstringdatastringremote_idStringgetResponse
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_idStringHubspot 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
emails_sentIntegernameStringremote_dataRemoteData[]pathstringdatastringremote_idStringKlaviyo
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_idStringMailchimp
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
emails_sentIntegernameStringremote_created_atDateTime (ISO 8601)remote_dataRemoteData[]pathstringdatastringremote_idStringunique_opensIntegerPodium
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_idStringSendGrid
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_idStringSendinblue
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
emails_sentIntegernameStringremote_created_atDateTime (ISO 8601)remote_dataRemoteData[]pathstringdatastringremote_idStringunique_opensIntegerGET
/campaigns/{parent_id}/contacts
https://api.merge.dev/api/mktg/v1/campaigns/{parent_id}/contacts
US
EU
APAC
Returns a list of Contact objects.
Query & Path Parameters
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).
page_sizeIntegerOptional
Number of results to return per page.
parent_idUUIDRequired
Field support by integration
See all supported fieldsUse 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
emails_sentIntegernameStringremote_created_atDateTime (ISO 8601)remote_dataRemoteData[]pathstringdatastringremote_idStringunique_opensIntegerCustomer.io
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
emails_sentIntegernameStringremote_created_atDateTime (ISO 8601)remote_dataRemoteData[]pathstringdatastringremote_idStringgetResponse
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_idStringHubspot 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
emails_sentIntegernameStringremote_dataRemoteData[]pathstringdatastringremote_idStringKlaviyo
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_idStringMailchimp
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
emails_sentIntegernameStringremote_created_atDateTime (ISO 8601)remote_dataRemoteData[]pathstringdatastringremote_idStringunique_opensIntegerPodium
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_idStringSendGrid
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_idStringSendinblue
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
emails_sentIntegernameStringremote_created_atDateTime (ISO 8601)remote_dataRemoteData[]pathstringdatastringremote_idStringunique_opensIntegerGET
/campaigns/meta/post
https://api.merge.dev/api/mktg/v1/campaigns/meta/post
US
EU
APAC
Returns metadata for MKTGCampaign POSTs.
Field support by integration
See all supported fieldsUse the /linked-accounts endpoint to pull platform support information
getResponse
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
Mailchimp
On top of normalized Common Models, Merge also supports Passthrough Requests for this platform's API
Supported POST Model Parameters
emails_sentIntegerOptional
nameStringRequired
remote_created_atDateTime (ISO 8601)Optional
remote_idStringOptional
Sendinblue
On top of normalized Common Models, Merge also supports Passthrough Requests for this platform's API
Supported POST Model Parameters
emails_sentIntegerOptional
nameStringRequired
remote_created_atDateTime (ISO 8601)Optional
remote_idStringOptional
Additional POST Parameters
integration_paramsObjectRequired
sender_emailStringRequired
Klaviyo