Campaign
object is used to represent a marketing campaign in the remote system.name
Stringunique_opens
Integerremote_created_at
Stringemails_sent
Integerremote_was_deleted
Booleanid
Stringremote_id
Stringcreated_at
Stringmodified_at
Stringfield_mappings
Objectremote_data
RemoteData[]{"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}
https://api.merge.dev/api/mktg/v1/campaigns
Returns a list of Campaign
objects.
Authorization
StringX-Account-Token
Stringcreated_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","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}]}

Merge supports Passthrough Requests to this platform's API
Supported Response Fields
emails_sent
Integername
Stringremote_created_at
Stringremote_data
RemoteData[]path
stringdata
stringremote_id
Stringunique_opens
Integer
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
emails_sent
Integername
Stringremote_created_at
Stringremote_data
RemoteData[]path
stringdata
stringremote_id
String
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
name
Stringremote_created_at
Stringremote_data
RemoteData[]path
stringdata
stringremote_id
String
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
emails_sent
Integername
Stringremote_data
RemoteData[]path
stringdata
stringremote_id
String
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
name
Stringremote_created_at
Stringremote_data
RemoteData[]path
stringdata
stringremote_id
String
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
emails_sent
Integername
Stringremote_created_at
Stringremote_data
RemoteData[]path
stringdata
stringremote_id
Stringunique_opens
Integer
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
name
Stringremote_created_at
Stringremote_id
String
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
name
Stringremote_created_at
Stringremote_data
RemoteData[]path
stringdata
stringremote_id
String
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
emails_sent
Integername
Stringremote_created_at
Stringremote_data
RemoteData[]path
stringdata
stringremote_id
Stringunique_opens
Integerhttps://api.merge.dev/api/mktg/v1/campaigns
Creates a Campaign
object with the given values.
Authorization
StringX-Account-Token
Stringis_debug_mode
Booleanrun_async
Booleanmodel
Objectname
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","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}}

Merge supports Passthrough Requests to this platform's API
Supported POST Model Parameters
name
Stringremote_created_at
Stringremote_id
String
Merge supports Passthrough Requests to this platform's API
Supported POST Model Parameters
emails_sent
Integername
Stringremote_created_at
Stringremote_id
String
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
https://api.merge.dev/api/mktg/v1/campaigns/{id}
Returns a Campaign
object with the given id
.
Authorization
StringX-Account-Token
Stringid
Stringinclude_remote_data
Boolean{"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}

Merge supports Passthrough Requests to this platform's API
Supported Response Fields
emails_sent
Integername
Stringremote_created_at
Stringremote_data
RemoteData[]path
stringdata
stringremote_id
Stringunique_opens
Integer
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
emails_sent
Integername
Stringremote_created_at
Stringremote_data
RemoteData[]path
stringdata
stringremote_id
String
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
name
Stringremote_created_at
Stringremote_data
RemoteData[]path
stringdata
stringremote_id
String
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
emails_sent
Integername
Stringremote_data
RemoteData[]path
stringdata
stringremote_id
String
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
name
Stringremote_created_at
Stringremote_data
RemoteData[]path
stringdata
stringremote_id
String
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
emails_sent
Integername
Stringremote_created_at
Stringremote_data
RemoteData[]path
stringdata
stringremote_id
Stringunique_opens
Integer
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
name
Stringremote_created_at
Stringremote_id
String
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
name
Stringremote_created_at
Stringremote_data
RemoteData[]path
stringdata
stringremote_id
String
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
emails_sent
Integername
Stringremote_created_at
Stringremote_data
RemoteData[]path
stringdata
stringremote_id
Stringunique_opens
Integerhttps://api.merge.dev/api/mktg/v1/campaigns/{parent_id}/contacts
Returns a list of Contact
objects.
Authorization
StringX-Account-Token
Stringcursor
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": "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}]}

Merge supports Passthrough Requests to this platform's API
Supported Response Fields
emails_sent
Integername
Stringremote_created_at
Stringremote_data
RemoteData[]path
stringdata
stringremote_id
Stringunique_opens
Integer
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
emails_sent
Integername
Stringremote_created_at
Stringremote_data
RemoteData[]path
stringdata
stringremote_id
String
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
name
Stringremote_created_at
Stringremote_data
RemoteData[]path
stringdata
stringremote_id
String
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
emails_sent
Integername
Stringremote_data
RemoteData[]path
stringdata
stringremote_id
String
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
name
Stringremote_created_at
Stringremote_data
RemoteData[]path
stringdata
stringremote_id
String
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
emails_sent
Integername
Stringremote_created_at
Stringremote_data
RemoteData[]path
stringdata
stringremote_id
Stringunique_opens
Integer
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
name
Stringremote_created_at
Stringremote_id
String
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
name
Stringremote_created_at
Stringremote_data
RemoteData[]path
stringdata
stringremote_id
String
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
emails_sent
Integername
Stringremote_created_at
Stringremote_data
RemoteData[]path
stringdata
stringremote_id
Stringunique_opens
Integerhttps://api.merge.dev/api/mktg/v1/campaigns/meta/post
Returns metadata for MKTGCampaign
POSTs.
Authorization
StringX-Account-Token
String{"request_schema": {},"remote_field_classes": {},"status": {"linked_account_status": "COMPLETE","can_make_request": true},"has_conditional_params": true,"has_required_linked_account_params": true}

Merge supports Passthrough Requests to this platform's API
Supported Response Fields
emails_sent
Integername
Stringremote_created_at
Stringremote_data
RemoteData[]path
stringdata
stringremote_id
Stringunique_opens
Integer
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
emails_sent
Integername
Stringremote_created_at
Stringremote_data
RemoteData[]path
stringdata
stringremote_id
String
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
name
Stringremote_created_at
Stringremote_data
RemoteData[]path
stringdata
stringremote_id
String
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
emails_sent
Integername
Stringremote_data
RemoteData[]path
stringdata
stringremote_id
String
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
name
Stringremote_created_at
Stringremote_data
RemoteData[]path
stringdata
stringremote_id
String
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
emails_sent
Integername
Stringremote_created_at
Stringremote_data
RemoteData[]path
stringdata
stringremote_id
Stringunique_opens
Integer
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
name
Stringremote_created_at
Stringremote_id
String
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
name
Stringremote_created_at
Stringremote_data
RemoteData[]path
stringdata
stringremote_id
String
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
emails_sent
Integername
Stringremote_created_at
Stringremote_data
RemoteData[]path
stringdata
stringremote_id
Stringunique_opens
Integer