Campaigns
The Campaign object is used to represent a marketing campaign 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 campaign's name.

unique_opensInteger
Optional
The campaign's unique opens.

remote_created_atDateTime (ISO 8601)
Optional
When the campaign was created in the remote system.

emails_sentInteger
Optional
The campaign's number of emails sent.

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
/campaigns

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

US
EU

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.

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
getResponse
getResponse
Hubspot Marketing Hub
Hubspot Marketing Hub
Klaviyo
Klaviyo
Mailchimp
Mailchimp
Podium
Podium
SendGrid
SendGrid
Sendinblue
Sendinblue
POST
/campaigns

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

US
EU

Creates a Campaign 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 campaign's name.

unique_opensInteger
The campaign's unique opens.

emails_sentInteger
The campaign's number of emails sent.

integration_paramsObject

linked_account_paramsObject

Field support by integration
See all supported fields
Use the /linked-accounts endpoint to pull platform support information
getResponse
getResponse
Mailchimp
Mailchimp
Sendinblue
Sendinblue
Klaviyo
Klaviyo
Coming soon
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

Returns a Campaign 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
getResponse
getResponse
Hubspot Marketing Hub
Hubspot Marketing Hub
Klaviyo
Klaviyo
Mailchimp
Mailchimp
Podium
Podium
SendGrid
SendGrid
Sendinblue
Sendinblue
GET
/campaigns/{parent_id}/contacts

https://api.merge.dev/api/mktg/v1/campaigns/{parent_id}/contacts

US
EU

Returns a list of Contact objects.


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_idUUID
Required

Field support by integration
See all supported fields
Use the /linked-accounts endpoint to pull platform support information
ActiveCampaign
ActiveCampaign
Customer.io
Customer.io
getResponse
getResponse
Hubspot Marketing Hub
Hubspot Marketing Hub
Klaviyo
Klaviyo
Mailchimp
Mailchimp
Podium
Podium
SendGrid
SendGrid
Sendinblue
Sendinblue
GET
/campaigns/meta/post

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

US
EU

Returns metadata for MKTGCampaign POSTs.


Field support by integration
See all supported fields
Use the /linked-accounts endpoint to pull platform support information
ActiveCampaign
ActiveCampaign
Customer.io
Customer.io
getResponse
getResponse
Hubspot Marketing Hub
Hubspot Marketing Hub
Klaviyo
Klaviyo
Mailchimp
Mailchimp
Podium
Podium
SendGrid
SendGrid
Sendinblue
Sendinblue