Merge Marketing Automation

Lists

The List object is used to represent a list of contacts in the remote system.

The List object

Properties

nameString

Optional

The list's name.

typeString

Optional

The list's type.

remote_created_atString

Optional

When the list was created in the remote system.

remote_updated_atString

Optional

When the list was last updated in the remote system.

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.

field_mappingsObject

Optional

modified_atString

Required

This is the datetime that this object was last updated by Merge

remote_dataRemoteData[]

Optional

The List object

JSON


{
  "name": "New Customer List",
  "type": "Static",
  "remote_created_at": "2022-12-23T00:00:00Z",
  "remote_updated_at": "2022-12-23T00:00:00Z",
  "remote_was_deleted": true,
  "id": "4747cbc6-6040-430a-475r-aafacbadrt36",
  "remote_id": "25",
Show advanced fields
}

GET

/lists

Returns a list of List 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 List",
      "type": "Static",
      "remote_created_at": "2022-12-23T00:00:00Z",
      "remote_updated_at": "2022-12-23T00:00:00Z",
      "remote_was_deleted": true,
      "id": "4747cbc6-6040-430a-475r-aafacbadrt36",
      "remote_id": "25",
Show advanced fields
    }
  ]
}

ActiveCampaign

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

nameString

remote_created_atString

remote_dataRemoteData[]

pathstring

dataobject

remote_idString

remote_updated_atString

Customer.io

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

nameString

remote_dataRemoteData[]

pathstring

dataobject

remote_idString

typeString

getResponse

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

nameString

remote_created_atString

remote_dataRemoteData[]

pathstring

dataobject

remote_idString

Hubspot Marketing Hub

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

nameString

remote_created_atString

remote_dataRemoteData[]

pathstring

dataobject

remote_idString

remote_updated_atString

typeString

Klaviyo

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

nameString

remote_created_atString

remote_dataRemoteData[]

pathstring

dataobject

remote_idString

remote_updated_atString

Mailchimp

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

nameString

remote_created_atString

remote_dataRemoteData[]

pathstring

dataobject

remote_idString

MessageBird

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

nameString

remote_created_atString

remote_dataRemoteData[]

pathstring

dataobject

remote_idString

remote_updated_atString

SendGrid

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

nameString

remote_dataRemoteData[]

pathstring

dataobject

remote_idString

Sendinblue

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

nameString

remote_idString

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

POST

/lists

Creates a List 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 list's name.

typeString

The list's type.

integration_paramsObject

linked_account_paramsObject

POST v1/lists

JSON


{
  "model": {
    "name": "New Customer List",
    "type": "Static"
  }
}

Response

JSON


{
  "model": {
    "name": "New Customer List",
    "type": "Static",
    "remote_created_at": "2022-12-23T00:00:00Z",
    "remote_updated_at": "2022-12-23T00:00:00Z",
    "remote_was_deleted": true,
    "id": "4747cbc6-6040-430a-475r-aafacbadrt36",
    "remote_id": "25",
Show advanced fields
  }
}

ActiveCampaign

Merge supports Passthrough Requests to this platform's API

Supported POST Model Parameters

nameString

Required

remote_created_atString

Optional

remote_idString

Optional

remote_updated_atString

Optional

Customer.io

Merge supports Passthrough Requests to this platform's API

Supported POST Model Parameters

nameString

Required

remote_idString

Optional

typeString

Optional

getResponse

Merge supports Passthrough Requests to this platform's API

Supported POST Model Parameters

nameString

Optional

remote_created_atString

Optional

remote_idString

Optional

Additional POST Parameters

integration_paramsObject

Required

sectionString

Required

section_logic_operatorString

Required

subscribers_typeString

Required

Hubspot Marketing Hub

Merge supports Passthrough Requests to this platform's API

Supported POST Model Parameters

nameString

Required

remote_created_atString

Optional

remote_idString

Optional

remote_updated_atString

Optional

MessageBird

Merge supports Passthrough Requests to this platform's API

Supported POST Model Parameters

nameString

Required

remote_created_atString

Optional

remote_idString

Optional

remote_updated_atString

Optional

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

GET

/lists/{id}

Returns a List 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 List",
  "type": "Static",
  "remote_created_at": "2022-12-23T00:00:00Z",
  "remote_updated_at": "2022-12-23T00:00:00Z",
  "remote_was_deleted": true,
  "id": "4747cbc6-6040-430a-475r-aafacbadrt36",
  "remote_id": "25",
Show advanced fields
}

ActiveCampaign

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

nameString

remote_created_atString

remote_dataRemoteData[]

pathstring

dataobject

remote_idString

remote_updated_atString

Customer.io

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

nameString

remote_dataRemoteData[]

pathstring

dataobject

remote_idString

typeString

getResponse

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

nameString

remote_created_atString

remote_dataRemoteData[]

pathstring

dataobject

remote_idString

Hubspot Marketing Hub

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

nameString

remote_created_atString

remote_dataRemoteData[]

pathstring

dataobject

remote_idString

remote_updated_atString

typeString

Klaviyo

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

nameString

remote_created_atString

remote_dataRemoteData[]

pathstring

dataobject

remote_idString

remote_updated_atString

Mailchimp

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

nameString

remote_created_atString

remote_dataRemoteData[]

pathstring

dataobject

remote_idString

MessageBird

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

nameString

remote_created_atString

remote_dataRemoteData[]

pathstring

dataobject

remote_idString

remote_updated_atString

SendGrid

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

nameString

remote_dataRemoteData[]

pathstring

dataobject

remote_idString

Sendinblue

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

nameString

remote_idString

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

GET

/lists/{parent_id}/subscribers

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",
      "remote_was_deleted": true,
      "id": "5858cbc6-6040-430a-475r-aafacbadrg64",
      "remote_id": "35",
Show advanced fields
    }
  ]
}

ActiveCampaign

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

nameString

remote_created_atString

remote_dataRemoteData[]

pathstring

dataobject

remote_idString

remote_updated_atString

Customer.io

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

nameString

remote_dataRemoteData[]

pathstring

dataobject

remote_idString

typeString

getResponse

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

nameString

remote_created_atString

remote_dataRemoteData[]

pathstring

dataobject

remote_idString

Hubspot Marketing Hub

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

nameString

remote_created_atString

remote_dataRemoteData[]

pathstring

dataobject

remote_idString

remote_updated_atString

typeString

Klaviyo

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

nameString

remote_created_atString

remote_dataRemoteData[]

pathstring

dataobject

remote_idString

remote_updated_atString

Mailchimp

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

nameString

remote_created_atString

remote_dataRemoteData[]

pathstring

dataobject

remote_idString

MessageBird

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

nameString

remote_created_atString

remote_dataRemoteData[]

pathstring

dataobject

remote_idString

remote_updated_atString

SendGrid

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

nameString

remote_dataRemoteData[]

pathstring

dataobject

remote_idString

Sendinblue

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

nameString

remote_idString

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

GET

/lists/meta/post

Returns metadata for MKTGList 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

nameString

remote_created_atString

remote_dataRemoteData[]

pathstring

dataobject

remote_idString

remote_updated_atString

Customer.io

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

nameString

remote_dataRemoteData[]

pathstring

dataobject

remote_idString

typeString

getResponse

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

nameString

remote_created_atString

remote_dataRemoteData[]

pathstring

dataobject

remote_idString

Hubspot Marketing Hub

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

nameString

remote_created_atString

remote_dataRemoteData[]

pathstring

dataobject

remote_idString

remote_updated_atString

typeString

Klaviyo

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

nameString

remote_created_atString

remote_dataRemoteData[]

pathstring

dataobject

remote_idString

remote_updated_atString

Mailchimp

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

nameString

remote_created_atString

remote_dataRemoteData[]

pathstring

dataobject

remote_idString

MessageBird

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

nameString

remote_created_atString

remote_dataRemoteData[]

pathstring

dataobject

remote_idString

remote_updated_atString

SendGrid

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

nameString

remote_dataRemoteData[]

pathstring

dataobject

remote_idString

Sendinblue

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

nameString

remote_idString

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

Events

Next Up

Get Started

API Reference

Previous

Next Up