Campaigns
The Campaign object is used to represent a marketing campaign in the remote system.
Properties
nameString
Optional
The campaign's name.
unique_opensInteger
Optional
The campaign's unique opens.
remote_created_atString
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 by third party webhooks.
idString
Required
remote_idString
Optional
The third-party API ID of the matching object.
created_atString
Required
modified_atString
Required
This is the datetime that this object was last updated by Merge
field_mappingsObject
Optional
remote_dataRemoteData[]
Optional
The Campaign object
JSON
{
  "name": "New Customer Campaign",
  "unique_opens": "190",
  "remote_created_at": "2022-12-23T00:00:00Z",
  "emails_sent": "200",
  "remote_was_deleted": true,
  "id": "3737cbc6-6040-430a-475r-aafacbadrf47",
  "remote_id": "30",
  "created_at": "2021-09-15T00:00:00Z",
  "modified_at": "2021-10-16T00:00:00Z",
Show advanced fields
}
GET
/campaigns

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

US
EU

Returns a list of Campaign objects.


Header Parameters
AuthorizationString
Required
Token-based authentication with required prefix "Bearer"
X-Account-TokenString
Required
Token identifying the end user.
Query & Path Parameters
created_afterString
Optional
If provided, will only return objects created after this datetime.
created_beforeString
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_afterString
Optional
If provided, only objects synced by Merge after this date time will be returned.
modified_beforeString
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.
Response
JSON
{
  "next": "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
  "previous": "cj1sZXdwd2VycWVtY29zZnNkc2NzUWxNMEUxTXk0ME16UXpNallsTWtJ",
  "results": [
    {
      "name": "New Customer Campaign",
      "unique_opens": "190",
      "remote_created_at": "2022-12-23T00:00:00Z",
      "emails_sent": "200",
      "remote_was_deleted": true,
      "id": "3737cbc6-6040-430a-475r-aafacbadrf47",
      "remote_id": "30",
      "created_at": "2021-09-15T00:00:00Z",
      "modified_at": "2021-10-16T00:00:00Z",
Show advanced fields
    }
  ]
}
Field support by platform
ActiveCampaign
ActiveCampaign

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

emails_sentInteger
nameString
remote_created_atString
remote_dataRemoteData[]
pathstring
datastring
remote_idString
unique_opensInteger
Customer.io
Customer.io

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

emails_sentInteger
nameString
remote_created_atString
remote_dataRemoteData[]
pathstring
datastring
remote_idString
getResponse
getResponse

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

nameString
remote_created_atString
remote_dataRemoteData[]
pathstring
datastring
remote_idString
Hubspot Marketing Hub
Hubspot Marketing Hub

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

emails_sentInteger
nameString
remote_dataRemoteData[]
pathstring
datastring
remote_idString
Klaviyo
Klaviyo

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

nameString
remote_created_atString
remote_dataRemoteData[]
pathstring
datastring
remote_idString
Mailchimp
Mailchimp

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

emails_sentInteger
nameString
remote_created_atString
remote_dataRemoteData[]
pathstring
datastring
remote_idString
unique_opensInteger
Podium
Podium

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

nameString
remote_created_atString
remote_idString
SendGrid
SendGrid

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

nameString
remote_created_atString
remote_dataRemoteData[]
pathstring
datastring
remote_idString
Sendinblue
Sendinblue

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

emails_sentInteger
nameString
remote_created_atString
remote_dataRemoteData[]
pathstring
datastring
remote_idString
unique_opensInteger
Not seeing a platform that you're looking for? Submit a request for it here.
Hint: Use the /linked-accounts endpoint to pull platform support information.
POST
/campaigns

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

US
EU

Creates a Campaign object with the given values.


Header Parameters
AuthorizationString
Required
Token-based authentication with required prefix "Bearer"
X-Account-TokenString
Required
Token identifying the end user.
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
POST v1/campaigns
JSON
{
  "model": {
    "name": "New Customer Campaign",
    "unique_opens": "190",
    "emails_sent": "200"
  }
}
Response
JSON
{
  "model": {
    "name": "New Customer Campaign",
    "unique_opens": "190",
    "remote_created_at": "2022-12-23T00:00:00Z",
    "emails_sent": "200",
    "remote_was_deleted": true,
    "id": "3737cbc6-6040-430a-475r-aafacbadrf47",
    "remote_id": "30",
    "created_at": "2021-09-15T00:00:00Z",
    "modified_at": "2021-10-16T00:00:00Z",
Show advanced fields
  }
}
Field support by platform
getResponse
getResponse

Merge supports Passthrough Requests to this platform's API

Supported POST Model Parameters

nameString
Required
remote_created_atString
Optional
remote_idString
Optional
Mailchimp
Mailchimp

Merge supports Passthrough Requests to this platform's API

Supported POST Model Parameters

emails_sentInteger
Optional
nameString
Required
remote_created_atString
Optional
remote_idString
Optional
Sendinblue
Sendinblue

Merge supports Passthrough Requests to this platform's API

Supported POST Model Parameters

emails_sentInteger
Optional
nameString
Required
remote_created_atString
Optional
remote_idString
Optional

Additional POST Parameters

integration_paramsObject
Required
sender_emailString
Required
Klaviyo
Klaviyo
Coming soon
Not seeing a platform that you're looking for? Submit a request for it here.
Hint: Use the /linked-accounts endpoint to pull platform support information.
GET
/campaigns/{id}

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

US
EU

Returns a Campaign object with the given id.


Header Parameters
AuthorizationString
Required
Token-based authentication with required prefix "Bearer"
X-Account-TokenString
Required
Token identifying the end user.
Query & Path Parameters
idString
Required
include_remote_dataBoolean
Optional
Whether to include the original data Merge fetched from the third-party to produce these models.
Response
JSON
{
  "name": "New Customer Campaign",
  "unique_opens": "190",
  "remote_created_at": "2022-12-23T00:00:00Z",
  "emails_sent": "200",
  "remote_was_deleted": true,
  "id": "3737cbc6-6040-430a-475r-aafacbadrf47",
  "remote_id": "30",
  "created_at": "2021-09-15T00:00:00Z",
  "modified_at": "2021-10-16T00:00:00Z",
Show advanced fields
}
Field support by platform
ActiveCampaign
ActiveCampaign

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

emails_sentInteger
nameString
remote_created_atString
remote_dataRemoteData[]
pathstring
datastring
remote_idString
unique_opensInteger
Customer.io
Customer.io

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

emails_sentInteger
nameString
remote_created_atString
remote_dataRemoteData[]
pathstring
datastring
remote_idString
getResponse
getResponse

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

nameString
remote_created_atString
remote_dataRemoteData[]
pathstring
datastring
remote_idString
Hubspot Marketing Hub
Hubspot Marketing Hub

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

emails_sentInteger
nameString
remote_dataRemoteData[]
pathstring
datastring
remote_idString
Klaviyo
Klaviyo

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

nameString
remote_created_atString
remote_dataRemoteData[]
pathstring
datastring
remote_idString
Mailchimp
Mailchimp

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

emails_sentInteger
nameString
remote_created_atString
remote_dataRemoteData[]
pathstring
datastring
remote_idString
unique_opensInteger
Podium
Podium

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

nameString
remote_created_atString
remote_idString
SendGrid
SendGrid

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

nameString
remote_created_atString
remote_dataRemoteData[]
pathstring
datastring
remote_idString
Sendinblue
Sendinblue

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

emails_sentInteger
nameString
remote_created_atString
remote_dataRemoteData[]
pathstring
datastring
remote_idString
unique_opensInteger
Not seeing a platform that you're looking for? Submit a request for it here.
Hint: Use the /linked-accounts endpoint to pull platform support information.
GET
/campaigns/{parent_id}/contacts

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

US
EU

Returns a list of Contact objects.


Header Parameters
AuthorizationString
Required
Token-based authentication with required prefix "Bearer"
X-Account-TokenString
Required
Token identifying the end user.
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_idString
Required
Response
JSON
{
  "next": "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
  "previous": "cj1sZXdwd2VycWVtY29zZnNkc2NzUWxNMEUxTXk0ME16UXpNallsTWtJ",
  "results": [
    {
      "first_name": "Gil",
      "last_name": "Feig",
      "email": "[email protected]",
      "phone": "+13785579223",
      "state": "NY",
      "country": "US",
      "postal_code": "string",
      "remote_created_at": "2022-12-23T00:00:00Z",
      "remote_updated_at": "2022-12-23T00:00:00Z",
      "remote_was_deleted": true,
      "id": "5858cbc6-6040-430a-475r-aafacbadrg64",
      "remote_id": "35",
      "created_at": "2021-09-15T00:00:00Z",
      "modified_at": "2021-10-16T00:00:00Z",
Show advanced fields
    }
  ]
}
Field support by platform
ActiveCampaign
ActiveCampaign

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

emails_sentInteger
nameString
remote_created_atString
remote_dataRemoteData[]
pathstring
datastring
remote_idString
unique_opensInteger
Customer.io
Customer.io

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

emails_sentInteger
nameString
remote_created_atString
remote_dataRemoteData[]
pathstring
datastring
remote_idString
getResponse
getResponse

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

nameString
remote_created_atString
remote_dataRemoteData[]
pathstring
datastring
remote_idString
Hubspot Marketing Hub
Hubspot Marketing Hub

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

emails_sentInteger
nameString
remote_dataRemoteData[]
pathstring
datastring
remote_idString
Klaviyo
Klaviyo

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

nameString
remote_created_atString
remote_dataRemoteData[]
pathstring
datastring
remote_idString
Mailchimp
Mailchimp

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

emails_sentInteger
nameString
remote_created_atString
remote_dataRemoteData[]
pathstring
datastring
remote_idString
unique_opensInteger
Podium
Podium

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

nameString
remote_created_atString
remote_idString
SendGrid
SendGrid

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

nameString
remote_created_atString
remote_dataRemoteData[]
pathstring
datastring
remote_idString
Sendinblue
Sendinblue

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

emails_sentInteger
nameString
remote_created_atString
remote_dataRemoteData[]
pathstring
datastring
remote_idString
unique_opensInteger
Not seeing a platform that you're looking for? Submit a request for it here.
Hint: Use the /linked-accounts endpoint to pull platform support information.
GET
/campaigns/meta/post

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

US
EU

Returns metadata for MKTGCampaign POSTs.


Header Parameters
AuthorizationString
Required
Token-based authentication with required prefix "Bearer"
X-Account-TokenString
Required
Token identifying the end user.
Response
JSON
{
  "request_schema": {},
  "remote_field_classes": {},
  "status": {
    "linked_account_status": "COMPLETE",
    "can_make_request": true
  },
  "has_conditional_params": true,
  "has_required_linked_account_params": true
}
Field support by platform
ActiveCampaign
ActiveCampaign

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

emails_sentInteger
nameString
remote_created_atString
remote_dataRemoteData[]
pathstring
datastring
remote_idString
unique_opensInteger
Customer.io
Customer.io

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

emails_sentInteger
nameString
remote_created_atString
remote_dataRemoteData[]
pathstring
datastring
remote_idString
getResponse
getResponse

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

nameString
remote_created_atString
remote_dataRemoteData[]
pathstring
datastring
remote_idString
Hubspot Marketing Hub
Hubspot Marketing Hub

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

emails_sentInteger
nameString
remote_dataRemoteData[]
pathstring
datastring
remote_idString
Klaviyo
Klaviyo

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

nameString
remote_created_atString
remote_dataRemoteData[]
pathstring
datastring
remote_idString
Mailchimp
Mailchimp

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

emails_sentInteger
nameString
remote_created_atString
remote_dataRemoteData[]
pathstring
datastring
remote_idString
unique_opensInteger
Podium
Podium

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

nameString
remote_created_atString
remote_idString
SendGrid
SendGrid

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

nameString
remote_created_atString
remote_dataRemoteData[]
pathstring
datastring
remote_idString
Sendinblue
Sendinblue

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

emails_sentInteger
nameString
remote_created_atString
remote_dataRemoteData[]
pathstring
datastring
remote_idString
unique_opensInteger
Not seeing a platform that you're looking for? Submit a request for it here.
Hint: Use the /linked-accounts endpoint to pull platform support information.
Previous
Automations
Next Up
Contacts