Contacts
The Contact object is used to represent a contact in the remote system.
Properties

first_nameString
Optional
The contact's first name.

last_nameString
Optional
The contact's last name.

emailString
Optional
The contact's email.

phoneString
Optional
The contact's phone.

stateString
Optional
The contact's state.

countryEnum
Optional
The contact's country. Possible values include: AF, AX, AL, DZ, AS, AD, AO, AI, AQ, AG, AR, AM, AW, AU, AT, AZ, BS, BH, BD, BB, BY, BE, BZ, BJ, BM, BT, BO, BQ, BA, BW, BV, BR, IO, BN, BG, BF, BI, CV, KH, CM, CA, KY, CF, TD, CL, CN, CX, CC, CO, KM, CG, CD, CK, CR, CI, HR, CU, CW, CY, CZ, DK, DJ, DM, DO, EC, EG, SV, GQ, ER, EE, SZ, ET, FK, FO, FJ, FI, FR, GF, PF, TF, GA, GM, GE, DE, GH, GI, GR, GL, GD, GP, GU, GT, GG, GN, GW, GY, HT, HM, VA, HN, HK, HU, IS, IN, ID, IR, IQ, IE, IM, IL, IT, JM, JP, JE, JO, KZ, KE, KI, KW, KG, LA, LV, LB, LS, LR, LY, LI, LT, LU, MO, MG, MW, MY, MV, ML, MT, MH, MQ, MR, MU, YT, MX, FM, MD, MC, MN, ME, MS, MA, MZ, MM, NA, NR, NP, NL, NC, NZ, NI, NE, NG, NU, NF, KP, MK, MP, NO, OM, PK, PW, PS, PA, PG, PY, PE, PH, PN, PL, PT, PR, QA, RE, RO, RU, RW, BL, SH, KN, LC, MF, PM, VC, WS, SM, ST, SA, SN, RS, SC, SL, SG, SX, SK, SI, SB, SO, ZA, GS, KR, SS, ES, LK, SD, SR, SJ, SE, CH, SY, TW, TJ, TZ, TH, TL, TG, TK, TO, TT, TN, TR, TM, TC, TV, UG, UA, AE, GB, UM, US, UY, UZ, VU, VE, VN, VG, VI, WF, EH, YE, ZM, ZW. In cases where there is no clear mapping, the original value passed through will be returned.

postal_codeString
Optional
The contact's postal code.

remote_created_atString
Optional
When the contact was created in the remote system.

remote_updated_atString
Optional
When the contact 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.

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 Contact object
JSON
{
"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
}

GET
/contacts

https://api.merge.dev/api/mktg/v1/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

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": [
{
"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


countryEnum

emailString

first_nameString

last_nameString

phoneString

postal_codeString

remote_created_atString

remote_dataRemoteData[]
pathstring
datastring

remote_idString

remote_updated_atString

stateString
Customer.io
Customer.io

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


emailString

remote_dataRemoteData[]
pathstring
datastring

remote_idString
getResponse
getResponse

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


countryEnum

emailString

first_nameString

last_nameString

postal_codeString

remote_created_atString

remote_dataRemoteData[]
pathstring
datastring

remote_idString

remote_updated_atString

stateString
Hubspot Marketing Hub
Hubspot Marketing Hub

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


emailString

first_nameString

last_nameString

remote_created_atString

remote_idString
Keap
Keap

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


emailString

first_nameString

last_nameString

phoneString

remote_idString

remote_updated_atString
Klaviyo
Klaviyo

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


countryEnum

emailString

first_nameString

last_nameString

phoneString

postal_codeString

remote_created_atString

remote_dataRemoteData[]
pathstring
datastring

remote_idString

remote_updated_atString

stateString
Mailchimp
Mailchimp

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


emailString

first_nameString

last_nameString

phoneString

remote_dataRemoteData[]
pathstring
datastring

remote_idString

remote_updated_atString
MessageBird
MessageBird

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


countryEnum

emailString

first_nameString

last_nameString

phoneString

remote_created_atString

remote_dataRemoteData[]
pathstring
datastring

remote_idString

remote_updated_atString
Podium
Podium

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


emailString

first_nameString

last_nameString

phoneString

postal_codeString

remote_created_atString

remote_idString

remote_updated_atString

stateString
SendGrid
SendGrid

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


countryEnum

emailString

first_nameString

last_nameString

phoneString

postal_codeString

remote_created_atString

remote_dataRemoteData[]
pathstring
datastring

remote_idString

remote_updated_atString

stateString
Sendinblue
Sendinblue

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


emailString

first_nameString

last_nameString

phoneString

postal_codeString

remote_created_atString

remote_dataRemoteData[]
pathstring
datastring

remote_idString

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

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

US
EU

Creates a Contact 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.

first_nameString
The contact's first name.

last_nameString
The contact's last name.

emailString
The contact's email.

phoneString
The contact's phone.

stateString
The contact's state.

countryEnum
The contact's country. Must pass in one of the following choices: AF, AX, AL, DZ, AS, AD, AO, AI, AQ, AG, AR, AM, AW, AU, AT, AZ, BS, BH, BD, BB, BY, BE, BZ, BJ, BM, BT, BO, BQ, BA, BW, BV, BR, IO, BN, BG, BF, BI, CV, KH, CM, CA, KY, CF, TD, CL, CN, CX, CC, CO, KM, CG, CD, CK, CR, CI, HR, CU, CW, CY, CZ, DK, DJ, DM, DO, EC, EG, SV, GQ, ER, EE, SZ, ET, FK, FO, FJ, FI, FR, GF, PF, TF, GA, GM, GE, DE, GH, GI, GR, GL, GD, GP, GU, GT, GG, GN, GW, GY, HT, HM, VA, HN, HK, HU, IS, IN, ID, IR, IQ, IE, IM, IL, IT, JM, JP, JE, JO, KZ, KE, KI, KW, KG, LA, LV, LB, LS, LR, LY, LI, LT, LU, MO, MG, MW, MY, MV, ML, MT, MH, MQ, MR, MU, YT, MX, FM, MD, MC, MN, ME, MS, MA, MZ, MM, NA, NR, NP, NL, NC, NZ, NI, NE, NG, NU, NF, KP, MK, MP, NO, OM, PK, PW, PS, PA, PG, PY, PE, PH, PN, PL, PT, PR, QA, RE, RO, RU, RW, BL, SH, KN, LC, MF, PM, VC, WS, SM, ST, SA, SN, RS, SC, SL, SG, SX, SK, SI, SB, SO, ZA, GS, KR, SS, ES, LK, SD, SR, SJ, SE, CH, SY, TW, TJ, TZ, TH, TL, TG, TK, TO, TT, TN, TR, TM, TC, TV, UG, UA, AE, GB, UM, US, UY, UZ, VU, VE, VN, VG, VI, WF, EH, YE, ZM, ZW.

postal_codeString
The contact's postal code.

integration_paramsObject

linked_account_paramsObject

POST v1/contacts
JSON
{
"model": {
"first_name": "Gil",
"last_name": "Feig",
"email": "[email protected]",
"phone": "+13785579223",
"state": "NY",
"country": "US",
"postal_code": "string"
}
}
Response
JSON
{
"model": {
"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 POST Model Parameters


emailString
Required

first_nameString
Optional

last_nameString
Optional

phoneString
Optional

remote_created_atString
Optional

remote_idString
Optional

remote_updated_atString
Optional
Customer.io
Customer.io

Merge supports Passthrough Requests to this platform's API

Supported POST Model Parameters


emailString
Required

remote_idString
Optional
getResponse
getResponse

Merge supports Passthrough Requests to this platform's API

Supported POST Model Parameters


emailString
Optional

first_nameString
Optional

remote_created_atString
Optional

remote_idString
Optional

Additional POST Parameters


integration_paramsObject
Required
campaign_idString
Required
Hubspot Marketing Hub
Hubspot Marketing Hub

Merge supports Passthrough Requests to this platform's API

Supported POST Model Parameters


emailString
Optional

first_nameString
Required

last_nameString
Optional

phoneString
Optional

postal_codeString
Optional

remote_created_atString
Optional

remote_idString
Optional

remote_updated_atString
Optional

stateString
Optional
Mailchimp
Mailchimp

Merge supports Passthrough Requests to this platform's API

Supported POST Model Parameters


emailString
Required

remote_idString
Optional

remote_updated_atString
Optional

Additional POST Parameters


integration_paramsObject
Required
list_remote_idString
Required
statusString
Required
MessageBird
MessageBird

Merge supports Passthrough Requests to this platform's API

Supported POST Model Parameters


countryEnum
Optional

emailString
Optional

first_nameString
Required

last_nameString
Optional

phoneString
Optional

remote_created_atString
Optional

remote_idString
Optional

remote_updated_atString
Optional
Sendinblue
Sendinblue

Merge supports Passthrough Requests to this platform's API

Supported POST Model Parameters


emailString
Optional

first_nameString
Optional

last_nameString
Optional

phoneString
Required

postal_codeString
Optional

remote_created_atString
Optional

remote_idString
Optional

remote_updated_atString
Optional
Hint: Use the /linked-accounts endpoint to pull platform support information.
GET
/contacts/{id}

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

US
EU

Returns a Contact 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
{
"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


countryEnum

emailString

first_nameString

last_nameString

phoneString

postal_codeString

remote_created_atString

remote_dataRemoteData[]
pathstring
datastring

remote_idString

remote_updated_atString

stateString
Customer.io
Customer.io

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


emailString

remote_dataRemoteData[]
pathstring
datastring

remote_idString
getResponse
getResponse

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


countryEnum

emailString

first_nameString

last_nameString

postal_codeString

remote_created_atString

remote_dataRemoteData[]
pathstring
datastring

remote_idString

remote_updated_atString

stateString
Hubspot Marketing Hub
Hubspot Marketing Hub

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


emailString

first_nameString

last_nameString

remote_created_atString

remote_idString
Keap
Keap

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


emailString

first_nameString

last_nameString

phoneString

remote_idString

remote_updated_atString
Klaviyo
Klaviyo

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


countryEnum

emailString

first_nameString

last_nameString

phoneString

postal_codeString

remote_created_atString

remote_dataRemoteData[]
pathstring
datastring

remote_idString

remote_updated_atString

stateString
Mailchimp
Mailchimp

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


emailString

first_nameString

last_nameString

phoneString

remote_dataRemoteData[]
pathstring
datastring

remote_idString

remote_updated_atString
MessageBird
MessageBird

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


countryEnum

emailString

first_nameString

last_nameString

phoneString

remote_created_atString

remote_dataRemoteData[]
pathstring
datastring

remote_idString

remote_updated_atString
Podium
Podium

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


emailString

first_nameString

last_nameString

phoneString

postal_codeString

remote_created_atString

remote_idString

remote_updated_atString

stateString
SendGrid
SendGrid

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


countryEnum

emailString

first_nameString

last_nameString

phoneString

postal_codeString

remote_created_atString

remote_dataRemoteData[]
pathstring
datastring

remote_idString

remote_updated_atString

stateString
Sendinblue
Sendinblue

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


emailString

first_nameString

last_nameString

phoneString

postal_codeString

remote_created_atString

remote_dataRemoteData[]
pathstring
datastring

remote_idString

remote_updated_atString
Hint: Use the /linked-accounts endpoint to pull platform support information.
GET
/contacts/meta/post

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

US
EU

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


countryEnum

emailString

first_nameString

last_nameString

phoneString

postal_codeString

remote_created_atString

remote_dataRemoteData[]
pathstring
datastring

remote_idString

remote_updated_atString

stateString
Customer.io
Customer.io

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


emailString

remote_dataRemoteData[]
pathstring
datastring

remote_idString
getResponse
getResponse

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


countryEnum

emailString

first_nameString

last_nameString

postal_codeString

remote_created_atString

remote_dataRemoteData[]
pathstring
datastring

remote_idString

remote_updated_atString

stateString
Hubspot Marketing Hub
Hubspot Marketing Hub

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


emailString

first_nameString

last_nameString

remote_created_atString

remote_idString
Keap
Keap

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


emailString

first_nameString

last_nameString

phoneString

remote_idString

remote_updated_atString
Klaviyo
Klaviyo

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


countryEnum

emailString

first_nameString

last_nameString

phoneString

postal_codeString

remote_created_atString

remote_dataRemoteData[]
pathstring
datastring

remote_idString

remote_updated_atString

stateString
Mailchimp
Mailchimp

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


emailString

first_nameString

last_nameString

phoneString

remote_dataRemoteData[]
pathstring
datastring

remote_idString

remote_updated_atString
MessageBird
MessageBird

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


countryEnum

emailString

first_nameString

last_nameString

phoneString

remote_created_atString

remote_dataRemoteData[]
pathstring
datastring

remote_idString

remote_updated_atString
Podium
Podium

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


emailString

first_nameString

last_nameString

phoneString

postal_codeString

remote_created_atString

remote_idString

remote_updated_atString

stateString
SendGrid
SendGrid

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


countryEnum

emailString

first_nameString

last_nameString

phoneString

postal_codeString

remote_created_atString

remote_dataRemoteData[]
pathstring
datastring

remote_idString

remote_updated_atString

stateString
Sendinblue
Sendinblue

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


emailString

first_nameString

last_nameString

phoneString

postal_codeString

remote_created_atString

remote_dataRemoteData[]
pathstring
datastring

remote_idString

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