Campaigns

The Campaign object is used to represent a marketing campaign in the remote system.

The Campaign object

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.

idString

Required

remote_idString

Optional

The third-party API ID of the matching object.

The Campaign object

JSON


{
  "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"
}

GET

/campaigns

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, will only return objects modified after this datetime.

modified_beforeString

Optional

If provided, will only return objects modified before this datetime.

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",
      "id": "3737cbc6-6040-430a-475r-aafacbadrf47",
      "remote_id": "30"
    }
  ]
}

ActiveCampaign

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

emails_sentInteger

nameString

remote_created_atString

remote_idString

unique_opensInteger

Customer.io

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

emails_sentInteger

nameString

remote_created_atString

remote_idString

getResponse

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

nameString

remote_created_atString

remote_idString

Hubspot Marketing Hub

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

emails_sentInteger

nameString

remote_idString

Klaviyo

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

nameString

remote_created_atString

remote_idString

Mailchimp

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

emails_sentInteger

nameString

remote_created_atString

remote_idString

unique_opensInteger

Podium

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

nameString

remote_created_atString

remote_idString

SendGrid

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

nameString

remote_created_atString

remote_idString

Sendinblue

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

emails_sentInteger

nameString

remote_created_atString

remote_idString

unique_opensInteger

Hint: Use the /linked-accounts endpoint to pull platform support information.

POST

/campaigns

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",
    "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

nameString

Required

remote_created_atString

Optional

remote_idString

Optional

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

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

Coming Soon

Hint: Use the /linked-accounts endpoint to pull platform support information.

GET

/campaigns/{id}

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",
  "id": "3737cbc6-6040-430a-475r-aafacbadrf47",
  "remote_id": "30"
}

ActiveCampaign

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

emails_sentInteger

nameString

remote_created_atString

remote_idString

unique_opensInteger

Customer.io

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

emails_sentInteger

nameString

remote_created_atString

remote_idString

getResponse

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

nameString

remote_created_atString

remote_idString

Hubspot Marketing Hub

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

emails_sentInteger

nameString

remote_idString

Klaviyo

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

nameString

remote_created_atString

remote_idString

Mailchimp

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

emails_sentInteger

nameString

remote_created_atString

remote_idString

unique_opensInteger

Podium

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

nameString

remote_created_atString

remote_idString

SendGrid

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

nameString

remote_created_atString

remote_idString

Sendinblue

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

emails_sentInteger

nameString

remote_created_atString

remote_idString

unique_opensInteger

Hint: Use the /linked-accounts endpoint to pull platform support information.

GET

/campaigns/{parent_id}/contacts

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": "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_sentInteger

nameString

remote_created_atString

remote_idString

unique_opensInteger

Customer.io

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

emails_sentInteger

nameString

remote_created_atString

remote_idString

getResponse

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

nameString

remote_created_atString

remote_idString

Hubspot Marketing Hub

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

emails_sentInteger

nameString

remote_idString

Klaviyo

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

nameString

remote_created_atString

remote_idString

Mailchimp

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

emails_sentInteger

nameString

remote_created_atString

remote_idString

unique_opensInteger

Podium

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

nameString

remote_created_atString

remote_idString

SendGrid

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

nameString

remote_created_atString

remote_idString

Sendinblue

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

emails_sentInteger

nameString

remote_created_atString

remote_idString

unique_opensInteger

Hint: Use the /linked-accounts endpoint to pull platform support information.

GET

/campaigns/meta/post

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": "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_sentInteger

nameString

remote_created_atString

remote_idString

unique_opensInteger

Customer.io

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

emails_sentInteger

nameString

remote_created_atString

remote_idString

getResponse

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

nameString

remote_created_atString

remote_idString

Hubspot Marketing Hub

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

emails_sentInteger

nameString

remote_idString

Klaviyo

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

nameString

remote_created_atString

remote_idString

Mailchimp

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

emails_sentInteger

nameString

remote_created_atString

remote_idString

unique_opensInteger

Podium

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

nameString

remote_created_atString

remote_idString

SendGrid

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

nameString

remote_created_atString

remote_idString

Sendinblue

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

emails_sentInteger

nameString

remote_created_atString

remote_idString

unique_opensInteger

Hint: Use the /linked-accounts endpoint to pull platform support information.

Automations

Campaigns

The Campaign object

Properties

/campaigns

Header Parameters

Query & Path Parameters

ActiveCampaign

Customer.io

getResponse

Hubspot Marketing Hub

Klaviyo

Mailchimp

Podium

SendGrid

Sendinblue

/campaigns

Header Parameters

Query & Path Parameters

Body Parameters

Model Parameters

getResponse

Mailchimp

Sendinblue

Klaviyo

/campaigns/{id}

Header Parameters

Query & Path Parameters

ActiveCampaign

Customer.io

getResponse

Hubspot Marketing Hub

Klaviyo

Mailchimp

Podium

SendGrid

Sendinblue

/campaigns/{parent_id}/contacts

Header Parameters

Query & Path Parameters

ActiveCampaign

Customer.io

getResponse

Hubspot Marketing Hub

Klaviyo

Mailchimp

Podium

SendGrid

Sendinblue

/campaigns/meta/post

Header Parameters

ActiveCampaign

Customer.io

getResponse

Hubspot Marketing Hub

Klaviyo

Mailchimp

Podium

SendGrid

Sendinblue

Previous

Next Up

Get Started

API Reference