List
object is used to represent a list of contacts in the remote system.id
UUIDremote_id
Stringcreated_at
DateTime (ISO 8601)modified_at
DateTime (ISO 8601)name
Stringtype
Stringremote_created_at
DateTime (ISO 8601)remote_updated_at
DateTime (ISO 8601)remote_was_deleted
Booleanfield_mappings
Objectremote_data
RemoteData[]https://api.merge.dev/api/mktg/v1/lists
Returns a list of List
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
name
Stringremote_created_at
DateTime (ISO 8601)remote_data
RemoteData[]path
stringdata
stringremote_id
Stringremote_updated_at
DateTime (ISO 8601)![Customer.io](https://merge-api-production.s3.amazonaws.com/media/customer_io_square.png)
Supported Response Fields
name
Stringremote_data
RemoteData[]path
stringdata
stringremote_id
Stringtype
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
name
Stringremote_created_at
DateTime (ISO 8601)remote_data
RemoteData[]path
stringdata
stringremote_id
Stringremote_updated_at
DateTime (ISO 8601)type
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
Stringremote_updated_at
DateTime (ISO 8601)![Mailchimp](https://merge-api-production.s3.amazonaws.com/media/mailchimp_square_FoKtczJ.png)
Supported Response Fields
name
Stringremote_created_at
DateTime (ISO 8601)remote_data
RemoteData[]path
stringdata
stringremote_id
String![MessageBird](https://merge-api-production.s3.amazonaws.com/media/messagebird_square_y8wjgQQ.png)
Supported Response Fields
name
Stringremote_created_at
DateTime (ISO 8601)remote_data
RemoteData[]path
stringdata
stringremote_id
Stringremote_updated_at
DateTime (ISO 8601)![SendGrid](https://merge-api-production.s3.amazonaws.com/media/sendgrid_square.png)
Supported Response Fields
name
Stringremote_data
RemoteData[]path
stringdata
stringremote_id
String![Sendinblue](https://merge-api-production.s3.amazonaws.com/media/sendinblue_square.png)
Supported Response Fields
name
Stringremote_id
Stringhttps://api.merge.dev/api/mktg/v1/lists
Creates a List
object with the given values.
is_debug_mode
Booleanrun_async
Booleanmodel
Objectname
Stringtype
Stringintegration_params
Objectlinked_account_params
Object![ActiveCampaign](https://merge-api-production.s3.amazonaws.com/media/ActiveCampaign_square.jpg)
Supported POST Model Parameters
name
Stringremote_created_at
DateTime (ISO 8601)remote_id
Stringremote_updated_at
DateTime (ISO 8601)![Customer.io](https://merge-api-production.s3.amazonaws.com/media/customer_io_square.png)
Supported POST Model Parameters
name
Stringremote_id
Stringtype
String![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
StringAdditional POST Parameters
integration_params
Objectsection
Stringsection_logic_operator
Stringsubscribers_type
String![Hubspot Marketing Hub](https://merge-api-production.s3.amazonaws.com/media/PlatformHubspot.png)
Supported POST Model Parameters
name
Stringremote_created_at
DateTime (ISO 8601)remote_id
Stringremote_updated_at
DateTime (ISO 8601)![MessageBird](https://merge-api-production.s3.amazonaws.com/media/messagebird_square_y8wjgQQ.png)
Supported POST Model Parameters
name
Stringremote_created_at
DateTime (ISO 8601)remote_id
Stringremote_updated_at
DateTime (ISO 8601)https://api.merge.dev/api/mktg/v1/lists/{id}
Returns a List
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
name
Stringremote_created_at
DateTime (ISO 8601)remote_data
RemoteData[]path
stringdata
stringremote_id
Stringremote_updated_at
DateTime (ISO 8601)![Customer.io](https://merge-api-production.s3.amazonaws.com/media/customer_io_square.png)
Supported Response Fields
name
Stringremote_data
RemoteData[]path
stringdata
stringremote_id
Stringtype
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
name
Stringremote_created_at
DateTime (ISO 8601)remote_data
RemoteData[]path
stringdata
stringremote_id
Stringremote_updated_at
DateTime (ISO 8601)type
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
Stringremote_updated_at
DateTime (ISO 8601)![Mailchimp](https://merge-api-production.s3.amazonaws.com/media/mailchimp_square_FoKtczJ.png)
Supported Response Fields
name
Stringremote_created_at
DateTime (ISO 8601)remote_data
RemoteData[]path
stringdata
stringremote_id
String![MessageBird](https://merge-api-production.s3.amazonaws.com/media/messagebird_square_y8wjgQQ.png)
Supported Response Fields
name
Stringremote_created_at
DateTime (ISO 8601)remote_data
RemoteData[]path
stringdata
stringremote_id
Stringremote_updated_at
DateTime (ISO 8601)![SendGrid](https://merge-api-production.s3.amazonaws.com/media/sendgrid_square.png)
Supported Response Fields
name
Stringremote_data
RemoteData[]path
stringdata
stringremote_id
String![Sendinblue](https://merge-api-production.s3.amazonaws.com/media/sendinblue_square.png)
Supported Response Fields
name
Stringremote_id
Stringhttps://api.merge.dev/api/mktg/v1/lists/{parent_id}/subscribers
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
name
Stringremote_created_at
DateTime (ISO 8601)remote_data
RemoteData[]path
stringdata
stringremote_id
Stringremote_updated_at
DateTime (ISO 8601)![Customer.io](https://merge-api-production.s3.amazonaws.com/media/customer_io_square.png)
Supported Response Fields
name
Stringremote_data
RemoteData[]path
stringdata
stringremote_id
Stringtype
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
name
Stringremote_created_at
DateTime (ISO 8601)remote_data
RemoteData[]path
stringdata
stringremote_id
Stringremote_updated_at
DateTime (ISO 8601)type
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
Stringremote_updated_at
DateTime (ISO 8601)![Mailchimp](https://merge-api-production.s3.amazonaws.com/media/mailchimp_square_FoKtczJ.png)
Supported Response Fields
name
Stringremote_created_at
DateTime (ISO 8601)remote_data
RemoteData[]path
stringdata
stringremote_id
String![MessageBird](https://merge-api-production.s3.amazonaws.com/media/messagebird_square_y8wjgQQ.png)
Supported Response Fields
name
Stringremote_created_at
DateTime (ISO 8601)remote_data
RemoteData[]path
stringdata
stringremote_id
Stringremote_updated_at
DateTime (ISO 8601)![SendGrid](https://merge-api-production.s3.amazonaws.com/media/sendgrid_square.png)
Supported Response Fields
name
Stringremote_data
RemoteData[]path
stringdata
stringremote_id
String![Sendinblue](https://merge-api-production.s3.amazonaws.com/media/sendinblue_square.png)
Supported Response Fields
name
Stringremote_id
Stringhttps://api.merge.dev/api/mktg/v1/lists/meta/post
Returns metadata for MKTGList
POSTs.
![ActiveCampaign](https://merge-api-production.s3.amazonaws.com/media/ActiveCampaign_square.jpg)
Supported POST Model Parameters
name
Stringremote_created_at
DateTime (ISO 8601)remote_id
Stringremote_updated_at
DateTime (ISO 8601)![Customer.io](https://merge-api-production.s3.amazonaws.com/media/customer_io_square.png)
Supported POST Model Parameters
name
Stringremote_id
Stringtype
String![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
StringAdditional POST Parameters
integration_params
Objectsection
Stringsection_logic_operator
Stringsubscribers_type
String![Hubspot Marketing Hub](https://merge-api-production.s3.amazonaws.com/media/PlatformHubspot.png)
Supported POST Model Parameters
name
Stringremote_created_at
DateTime (ISO 8601)remote_id
Stringremote_updated_at
DateTime (ISO 8601)![MessageBird](https://merge-api-production.s3.amazonaws.com/media/messagebird_square_y8wjgQQ.png)
Supported POST Model Parameters
name
Stringremote_created_at
DateTime (ISO 8601)remote_id
Stringremote_updated_at
DateTime (ISO 8601)