Campaign
object is used to represent a marketing campaign in the remote system.id
UUIDremote_id
Stringcreated_at
DateTime (ISO 8601)modified_at
DateTime (ISO 8601)name
Stringunique_opens
Integerremote_created_at
DateTime (ISO 8601)emails_sent
Integerremote_was_deleted
Booleanfield_mappings
Objectremote_data
RemoteData[]https://api.merge.dev/api/mktg/v1/campaigns
Returns a list of Campaign
objects.
created_after
DateTime (ISO 8601)created_before
DateTime (ISO 8601)cursor
Stringinclude_deleted_data
Booleaninclude_remote_data
Booleanmodified_after
DateTime (ISO 8601)modified_before
DateTime (ISO 8601)page_size
Integerremote_id
String![ActiveCampaign](https://merge-api-production.s3.amazonaws.com/media/ActiveCampaign_square.jpg)
Supported Response Fields
emails_sent
Integername
Stringremote_created_at
DateTime (ISO 8601)remote_data
RemoteData[]path
stringdata
stringremote_id
Stringunique_opens
Integer![Customer.io](https://merge-api-production.s3.amazonaws.com/media/customer_io_square.png)
Supported Response Fields
emails_sent
Integername
Stringremote_created_at
DateTime (ISO 8601)remote_data
RemoteData[]path
stringdata
stringremote_id
String![getResponse](https://merge-api-production.s3.amazonaws.com/media/getresponse_square.png)
Supported Response Fields
name
Stringremote_created_at
DateTime (ISO 8601)remote_data
RemoteData[]path
stringdata
stringremote_id
String![Hubspot Marketing Hub](https://merge-api-production.s3.amazonaws.com/media/PlatformHubspot.png)
Supported Response Fields
emails_sent
Integername
Stringremote_data
RemoteData[]path
stringdata
stringremote_id
String![Klaviyo](https://merge-api-production.s3.amazonaws.com/media/klaviyo_square.png)
Supported Response Fields
name
Stringremote_created_at
DateTime (ISO 8601)remote_data
RemoteData[]path
stringdata
stringremote_id
String![Mailchimp](https://merge-api-production.s3.amazonaws.com/media/mailchimp_square_FoKtczJ.png)
Supported Response Fields
emails_sent
Integername
Stringremote_created_at
DateTime (ISO 8601)remote_data
RemoteData[]path
stringdata
stringremote_id
Stringunique_opens
Integer![Podium](https://merge-api-production.s3.amazonaws.com/media/podium_square.png)
Supported Response Fields
name
Stringremote_created_at
DateTime (ISO 8601)remote_id
String![SendGrid](https://merge-api-production.s3.amazonaws.com/media/sendgrid_square.png)
Supported Response Fields
name
Stringremote_created_at
DateTime (ISO 8601)remote_data
RemoteData[]path
stringdata
stringremote_id
String![Sendinblue](https://merge-api-production.s3.amazonaws.com/media/sendinblue_square.png)
Supported Response Fields
emails_sent
Integername
Stringremote_created_at
DateTime (ISO 8601)remote_data
RemoteData[]path
stringdata
stringremote_id
Stringunique_opens
Integerhttps://api.merge.dev/api/mktg/v1/campaigns
Creates a Campaign
object with the given values.
is_debug_mode
Booleanrun_async
Booleanmodel
Objectname
Stringunique_opens
Integeremails_sent
Integerintegration_params
Objectlinked_account_params
Object![getResponse](https://merge-api-production.s3.amazonaws.com/media/getresponse_square.png)
Supported POST Model Parameters
name
Stringremote_created_at
DateTime (ISO 8601)remote_id
String![Mailchimp](https://merge-api-production.s3.amazonaws.com/media/mailchimp_square_FoKtczJ.png)
Supported POST Model Parameters
emails_sent
Integername
Stringremote_created_at
DateTime (ISO 8601)remote_id
String![Sendinblue](https://merge-api-production.s3.amazonaws.com/media/sendinblue_square.png)
Supported POST Model Parameters
emails_sent
Integername
Stringremote_created_at
DateTime (ISO 8601)remote_id
StringAdditional POST Parameters
integration_params
Objectsender_email
String![Klaviyo](https://merge-api-production.s3.amazonaws.com/media/__sized__/klaviyo_square-thumbnail-144x144.png)
https://api.merge.dev/api/mktg/v1/campaigns/{id}
Returns a Campaign
object with the given id
.
id
UUIDinclude_remote_data
Boolean![ActiveCampaign](https://merge-api-production.s3.amazonaws.com/media/ActiveCampaign_square.jpg)
Supported Response Fields
emails_sent
Integername
Stringremote_created_at
DateTime (ISO 8601)remote_data
RemoteData[]path
stringdata
stringremote_id
Stringunique_opens
Integer![Customer.io](https://merge-api-production.s3.amazonaws.com/media/customer_io_square.png)
Supported Response Fields
emails_sent
Integername
Stringremote_created_at
DateTime (ISO 8601)remote_data
RemoteData[]path
stringdata
stringremote_id
String![getResponse](https://merge-api-production.s3.amazonaws.com/media/getresponse_square.png)
Supported Response Fields
name
Stringremote_created_at
DateTime (ISO 8601)remote_data
RemoteData[]path
stringdata
stringremote_id
String![Hubspot Marketing Hub](https://merge-api-production.s3.amazonaws.com/media/PlatformHubspot.png)
Supported Response Fields
emails_sent
Integername
Stringremote_data
RemoteData[]path
stringdata
stringremote_id
String![Klaviyo](https://merge-api-production.s3.amazonaws.com/media/klaviyo_square.png)
Supported Response Fields
name
Stringremote_created_at
DateTime (ISO 8601)remote_data
RemoteData[]path
stringdata
stringremote_id
String![Mailchimp](https://merge-api-production.s3.amazonaws.com/media/mailchimp_square_FoKtczJ.png)
Supported Response Fields
emails_sent
Integername
Stringremote_created_at
DateTime (ISO 8601)remote_data
RemoteData[]path
stringdata
stringremote_id
Stringunique_opens
Integer![Podium](https://merge-api-production.s3.amazonaws.com/media/podium_square.png)
Supported Response Fields
name
Stringremote_created_at
DateTime (ISO 8601)remote_id
String![SendGrid](https://merge-api-production.s3.amazonaws.com/media/sendgrid_square.png)
Supported Response Fields
name
Stringremote_created_at
DateTime (ISO 8601)remote_data
RemoteData[]path
stringdata
stringremote_id
String![Sendinblue](https://merge-api-production.s3.amazonaws.com/media/sendinblue_square.png)
Supported Response Fields
emails_sent
Integername
Stringremote_created_at
DateTime (ISO 8601)remote_data
RemoteData[]path
stringdata
stringremote_id
Stringunique_opens
Integerhttps://api.merge.dev/api/mktg/v1/campaigns/{parent_id}/contacts
Returns a list of Contact
objects.
cursor
Stringinclude_deleted_data
Booleaninclude_remote_data
Booleanpage_size
Integerparent_id
UUID![ActiveCampaign](https://merge-api-production.s3.amazonaws.com/media/ActiveCampaign_square.jpg)
Supported Response Fields
emails_sent
Integername
Stringremote_created_at
DateTime (ISO 8601)remote_data
RemoteData[]path
stringdata
stringremote_id
Stringunique_opens
Integer![Customer.io](https://merge-api-production.s3.amazonaws.com/media/customer_io_square.png)
Supported Response Fields
emails_sent
Integername
Stringremote_created_at
DateTime (ISO 8601)remote_data
RemoteData[]path
stringdata
stringremote_id
String![getResponse](https://merge-api-production.s3.amazonaws.com/media/getresponse_square.png)
Supported Response Fields
name
Stringremote_created_at
DateTime (ISO 8601)remote_data
RemoteData[]path
stringdata
stringremote_id
String![Hubspot Marketing Hub](https://merge-api-production.s3.amazonaws.com/media/PlatformHubspot.png)
Supported Response Fields
emails_sent
Integername
Stringremote_data
RemoteData[]path
stringdata
stringremote_id
String![Klaviyo](https://merge-api-production.s3.amazonaws.com/media/klaviyo_square.png)
Supported Response Fields
name
Stringremote_created_at
DateTime (ISO 8601)remote_data
RemoteData[]path
stringdata
stringremote_id
String![Mailchimp](https://merge-api-production.s3.amazonaws.com/media/mailchimp_square_FoKtczJ.png)
Supported Response Fields
emails_sent
Integername
Stringremote_created_at
DateTime (ISO 8601)remote_data
RemoteData[]path
stringdata
stringremote_id
Stringunique_opens
Integer![Podium](https://merge-api-production.s3.amazonaws.com/media/podium_square.png)
Supported Response Fields
name
Stringremote_created_at
DateTime (ISO 8601)remote_id
String![SendGrid](https://merge-api-production.s3.amazonaws.com/media/sendgrid_square.png)
Supported Response Fields
name
Stringremote_created_at
DateTime (ISO 8601)remote_data
RemoteData[]path
stringdata
stringremote_id
String![Sendinblue](https://merge-api-production.s3.amazonaws.com/media/sendinblue_square.png)
Supported Response Fields
emails_sent
Integername
Stringremote_created_at
DateTime (ISO 8601)remote_data
RemoteData[]path
stringdata
stringremote_id
Stringunique_opens
Integerhttps://api.merge.dev/api/mktg/v1/campaigns/meta/post
Returns metadata for MKTGCampaign
POSTs.
![getResponse](https://merge-api-production.s3.amazonaws.com/media/getresponse_square.png)
Supported POST Model Parameters
name
Stringremote_created_at
DateTime (ISO 8601)remote_id
String![Mailchimp](https://merge-api-production.s3.amazonaws.com/media/mailchimp_square_FoKtczJ.png)
Supported POST Model Parameters
emails_sent
Integername
Stringremote_created_at
DateTime (ISO 8601)remote_id
String![Sendinblue](https://merge-api-production.s3.amazonaws.com/media/sendinblue_square.png)
Supported POST Model Parameters
emails_sent
Integername
Stringremote_created_at
DateTime (ISO 8601)remote_id
StringAdditional POST Parameters
integration_params
Objectsender_email
String![Klaviyo](https://merge-api-production.s3.amazonaws.com/media/__sized__/klaviyo_square-thumbnail-144x144.png)