Campaigns
TheCampaign
object is used to represent a marketing campaign in the remote system.The Campaign object
Properties
name
Stringunique_opens
Integerremote_created_at
Stringemails_sent
Integerid
Stringremote_id
String{"name": "New Customer Campaign","unique_opens": "190","remote_created_at": "2022-12-23T00:00:00Z","emails_sent": "200","id": "3737cbc6-6040-430a-475r-aafacbadrf47","remote_id": "30"}
/campaigns
Returns a list of Campaign
objects.
Header Parameters
Authorization
StringX-Account-Token
StringQuery & Path Parameters
created_after
Stringcreated_before
Stringcursor
Stringinclude_deleted_data
Booleaninclude_remote_data
Booleanmodified_after
Stringmodified_before
Stringpage_size
Integerremote_id
String{"next": "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw","previous": "cj1sZXdwd2VycWVtY29zZnNkc2NzUWxNMEUxTXk0ME16UXpNallsTWtJ","results": [{"name": "New Customer Campaign","unique_opens": "190","remote_created_at": "2022-12-23T00:00:00Z","emails_sent": "200","id": "3737cbc6-6040-430a-475r-aafacbadrf47","remote_id": "30"}]}

ActiveCampaign
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
emails_sent
Integername
Stringremote_created_at
Stringremote_id
Stringunique_opens
Integer
Customer.io
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
emails_sent
Integername
Stringremote_created_at
Stringremote_id
String
getResponse
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
name
Stringremote_created_at
Stringremote_id
String
Hubspot Marketing Hub
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
emails_sent
Integername
Stringremote_id
String
Klaviyo
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
name
Stringremote_created_at
Stringremote_id
String
Mailchimp
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
emails_sent
Integername
Stringremote_created_at
Stringremote_id
Stringunique_opens
Integer
Podium
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
name
Stringremote_created_at
Stringremote_id
String
SendGrid
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
name
Stringremote_created_at
Stringremote_id
String
Sendinblue
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
emails_sent
Integername
Stringremote_created_at
Stringremote_id
Stringunique_opens
Integer/campaigns
Creates a Campaign
object with the given values.
Header Parameters
Authorization
StringX-Account-Token
StringQuery & Path Parameters
is_debug_mode
Booleanrun_async
BooleanBody Parameters
model
ObjectModel Parameters
View app-specific writable fields under “Field support by platform” in this section.name
Stringunique_opens
Integeremails_sent
Integerintegration_params
Objectlinked_account_params
Object{"model": {"name": "New Customer Campaign","unique_opens": "190","emails_sent": "200"}}
{"model": {"name": "New Customer Campaign","unique_opens": "190","remote_created_at": "2022-12-23T00:00:00Z","emails_sent": "200","id": "3737cbc6-6040-430a-475r-aafacbadrf47","remote_id": "30"},"warnings": [{"source": {"pointer": "/age"},"title": "Unrecognized Field","detail": "An unrecognized field, age, was passed in with request data.","problem_type": "UNRECOGNIZED_FIELD"}],"errors": [{"source": {"pointer": "/model/custom_fields"},"title": "Missing Required Field","detail": "custom_fields is a required field on model.","problem_type": "MISSING_REQUIRED_FIELD"}],"logs": [{"log_id": "99433219-8017-4acd-bb3c-ceb23d663832","dashboard_view": "https://app.merge.dev/logs/99433219-8017-4acd-bb3c-ceb23d663832","log_summary": {"url": "https://harvest.greenhouse.io/v1/candidates/","method": "POST","status_code": 200}}]}

getResponse
Merge supports Passthrough Requests to this platform's API
Supported POST Model Parameters
name
Stringremote_created_at
Stringremote_id
String
Mailchimp
Merge supports Passthrough Requests to this platform's API
Supported POST Model Parameters
emails_sent
Integername
Stringremote_created_at
Stringremote_id
String
Sendinblue
Merge supports Passthrough Requests to this platform's API
Supported POST Model Parameters
emails_sent
Integername
Stringremote_created_at
Stringremote_id
StringAdditional POST Parameters
integration_params
Objectsender_email
String
Klaviyo
/campaigns/{id}
Returns a Campaign
object with the given id
.
Header Parameters
Authorization
StringX-Account-Token
StringQuery & Path Parameters
id
Stringinclude_remote_data
Boolean{"name": "New Customer Campaign","unique_opens": "190","remote_created_at": "2022-12-23T00:00:00Z","emails_sent": "200","id": "3737cbc6-6040-430a-475r-aafacbadrf47","remote_id": "30"}

ActiveCampaign
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
emails_sent
Integername
Stringremote_created_at
Stringremote_id
Stringunique_opens
Integer
Customer.io
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
emails_sent
Integername
Stringremote_created_at
Stringremote_id
String
getResponse
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
name
Stringremote_created_at
Stringremote_id
String
Hubspot Marketing Hub
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
emails_sent
Integername
Stringremote_id
String
Klaviyo
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
name
Stringremote_created_at
Stringremote_id
String
Mailchimp
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
emails_sent
Integername
Stringremote_created_at
Stringremote_id
Stringunique_opens
Integer
Podium
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
name
Stringremote_created_at
Stringremote_id
String
SendGrid
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
name
Stringremote_created_at
Stringremote_id
String
Sendinblue
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
emails_sent
Integername
Stringremote_created_at
Stringremote_id
Stringunique_opens
Integer/campaigns/{parent_id}/contacts
Returns a list of Contact
objects.
Header Parameters
Authorization
StringX-Account-Token
StringQuery & Path Parameters
cursor
Stringinclude_deleted_data
Booleaninclude_remote_data
Booleanpage_size
Integerparent_id
String{"next": "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw","previous": "cj1sZXdwd2VycWVtY29zZnNkc2NzUWxNMEUxTXk0ME16UXpNallsTWtJ","results": [{"first_name": "Gil","last_name": "Feig","email": "[email protected]","phone": "+13785579223","state": "NY","country": "USA","postal_code": "string","remote_created_at": "2022-12-23T00:00:00Z","remote_updated_at": "2022-12-23T00:00:00Z","id": "5858cbc6-6040-430a-475r-aafacbadrg64","remote_id": "35"}]}

ActiveCampaign
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
emails_sent
Integername
Stringremote_created_at
Stringremote_id
Stringunique_opens
Integer
Customer.io
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
emails_sent
Integername
Stringremote_created_at
Stringremote_id
String
getResponse
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
name
Stringremote_created_at
Stringremote_id
String
Hubspot Marketing Hub
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
emails_sent
Integername
Stringremote_id
String
Klaviyo
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
name
Stringremote_created_at
Stringremote_id
String
Mailchimp
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
emails_sent
Integername
Stringremote_created_at
Stringremote_id
Stringunique_opens
Integer
Podium
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
name
Stringremote_created_at
Stringremote_id
String
SendGrid
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
name
Stringremote_created_at
Stringremote_id
String
Sendinblue
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
emails_sent
Integername
Stringremote_created_at
Stringremote_id
Stringunique_opens
Integer/campaigns/meta/post
Returns metadata for MKTGCampaign
POSTs.
Header Parameters
Authorization
StringX-Account-Token
String{"request_schema": {},"remote_field_classes": {},"status": {"linked_account_status": "string","can_make_request": true},"has_conditional_params": true,"has_required_linked_account_params": true}

ActiveCampaign
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
emails_sent
Integername
Stringremote_created_at
Stringremote_id
Stringunique_opens
Integer
Customer.io
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
emails_sent
Integername
Stringremote_created_at
Stringremote_id
String
getResponse
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
name
Stringremote_created_at
Stringremote_id
String
Hubspot Marketing Hub
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
emails_sent
Integername
Stringremote_id
String
Klaviyo
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
name
Stringremote_created_at
Stringremote_id
String
Mailchimp
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
emails_sent
Integername
Stringremote_created_at
Stringremote_id
Stringunique_opens
Integer
Podium
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
name
Stringremote_created_at
Stringremote_id
String
SendGrid
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
name
Stringremote_created_at
Stringremote_id
String
Sendinblue
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
emails_sent
Integername
Stringremote_created_at
Stringremote_id
Stringunique_opens
Integer