Contacts
TheContact
object is used to represent a contact in the remote system.The Contact object
Properties
first_name
Stringlast_name
Stringemail
Stringphone
Stringstate
Stringcountry
EnumAF
, 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
, or - in cases where there is no clear mapping - the original value passed through.postal_code
Stringremote_created_at
Stringremote_updated_at
Stringid
Stringremote_id
String{"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"}
/contacts
Returns a list of Contact
objects.
Header Parameters
Authorization
StringX-Account-Token
StringQuery & Path Parameters
created_after
Stringcreated_before
Stringcursor
Stringinclude_deleted_data
Booleaninclude_remote_data
Booleanmodified_after
Stringmodified_before
Stringpage_size
Integerremote_id
String{"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
country
Enumemail
Stringfirst_name
Stringlast_name
Stringphone
Stringpostal_code
Stringremote_created_at
Stringremote_id
Stringremote_updated_at
Stringstate
String
Customer.io
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
email
Stringremote_id
String
getResponse
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
country
Enumemail
Stringfirst_name
Stringlast_name
Stringpostal_code
Stringremote_created_at
Stringremote_id
Stringremote_updated_at
Stringstate
String
Hubspot Marketing Hub
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
email
Stringfirst_name
Stringlast_name
Stringremote_created_at
Stringremote_id
String
Keap
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
email
Stringfirst_name
Stringlast_name
Stringphone
Stringremote_id
Stringremote_updated_at
String
Klaviyo
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
country
Enumemail
Stringfirst_name
Stringlast_name
Stringphone
Stringpostal_code
Stringremote_created_at
Stringremote_id
Stringremote_updated_at
Stringstate
String
Mailchimp
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
email
Stringfirst_name
Stringlast_name
Stringphone
Stringremote_id
Stringremote_updated_at
String
MessageBird
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
country
Enumemail
Stringfirst_name
Stringlast_name
Stringphone
Stringremote_created_at
Stringremote_id
Stringremote_updated_at
String
Podium
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
email
Stringfirst_name
Stringlast_name
Stringphone
Stringpostal_code
Stringremote_created_at
Stringremote_id
Stringremote_updated_at
Stringstate
String
SendGrid
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
country
Enumemail
Stringfirst_name
Stringlast_name
Stringphone
Stringpostal_code
Stringremote_created_at
Stringremote_id
Stringremote_updated_at
Stringstate
String
Sendinblue
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
email
Stringfirst_name
Stringlast_name
Stringphone
Stringpostal_code
Stringremote_created_at
Stringremote_id
Stringremote_updated_at
String/contacts
Creates a Contact
object with the given values.
Header Parameters
Authorization
StringX-Account-Token
StringQuery & Path Parameters
is_debug_mode
Booleanrun_async
BooleanBody Parameters
model
ObjectModel Parameters
View app-specific writable fields under “Field support by platform” in this section.first_name
Stringlast_name
Stringemail
Stringphone
Stringstate
Stringcountry
EnumAF
, 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_code
Stringintegration_params
Objectlinked_account_params
Object{"model": {"first_name": "Gil","last_name": "Feig","email": "[email protected]","phone": "+13785579223","state": "NY","country": "USA","postal_code": "string"}}
{"model": {"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"},"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}}]}

ActiveCampaign
Merge supports Passthrough Requests to this platform's API
Supported POST Model Parameters
email
Stringfirst_name
Stringlast_name
Stringphone
Stringremote_created_at
Stringremote_id
Stringremote_updated_at
String
Customer.io
Merge supports Passthrough Requests to this platform's API
Supported POST Model Parameters
email
Stringremote_id
String
getResponse
Merge supports Passthrough Requests to this platform's API
Supported POST Model Parameters
email
Stringfirst_name
Stringremote_created_at
Stringremote_id
StringAdditional POST Parameters
integration_params
Objectcampaign_id
String
Hubspot Marketing Hub
Merge supports Passthrough Requests to this platform's API
Supported POST Model Parameters
email
Stringfirst_name
Stringlast_name
Stringphone
Stringpostal_code
Stringremote_created_at
Stringremote_id
Stringremote_updated_at
Stringstate
String
Mailchimp
Merge supports Passthrough Requests to this platform's API
Supported POST Model Parameters
email
Stringremote_id
Stringremote_updated_at
StringAdditional POST Parameters
integration_params
Objectlist_remote_id
Stringstatus
String
MessageBird
Merge supports Passthrough Requests to this platform's API
Supported POST Model Parameters
country
Enumemail
Stringfirst_name
Stringlast_name
Stringphone
Stringremote_created_at
Stringremote_id
Stringremote_updated_at
String
Sendinblue
Merge supports Passthrough Requests to this platform's API
Supported POST Model Parameters
email
Stringfirst_name
Stringlast_name
Stringphone
Stringpostal_code
Stringremote_created_at
Stringremote_id
Stringremote_updated_at
String/contacts/{id}
Returns a Contact
object with the given id
.
Header Parameters
Authorization
StringX-Account-Token
StringQuery & Path Parameters
id
Stringinclude_remote_data
Boolean{"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
country
Enumemail
Stringfirst_name
Stringlast_name
Stringphone
Stringpostal_code
Stringremote_created_at
Stringremote_id
Stringremote_updated_at
Stringstate
String
Customer.io
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
email
Stringremote_id
String
getResponse
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
country
Enumemail
Stringfirst_name
Stringlast_name
Stringpostal_code
Stringremote_created_at
Stringremote_id
Stringremote_updated_at
Stringstate
String
Hubspot Marketing Hub
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
email
Stringfirst_name
Stringlast_name
Stringremote_created_at
Stringremote_id
String
Keap
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
email
Stringfirst_name
Stringlast_name
Stringphone
Stringremote_id
Stringremote_updated_at
String
Klaviyo
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
country
Enumemail
Stringfirst_name
Stringlast_name
Stringphone
Stringpostal_code
Stringremote_created_at
Stringremote_id
Stringremote_updated_at
Stringstate
String
Mailchimp
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
email
Stringfirst_name
Stringlast_name
Stringphone
Stringremote_id
Stringremote_updated_at
String
MessageBird
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
country
Enumemail
Stringfirst_name
Stringlast_name
Stringphone
Stringremote_created_at
Stringremote_id
Stringremote_updated_at
String
Podium
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
email
Stringfirst_name
Stringlast_name
Stringphone
Stringpostal_code
Stringremote_created_at
Stringremote_id
Stringremote_updated_at
Stringstate
String
SendGrid
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
country
Enumemail
Stringfirst_name
Stringlast_name
Stringphone
Stringpostal_code
Stringremote_created_at
Stringremote_id
Stringremote_updated_at
Stringstate
String
Sendinblue
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
email
Stringfirst_name
Stringlast_name
Stringphone
Stringpostal_code
Stringremote_created_at
Stringremote_id
Stringremote_updated_at
String/contacts/meta/post
Returns metadata for MKTGContact
POSTs.
Header Parameters
Authorization
StringX-Account-Token
String{"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
country
Enumemail
Stringfirst_name
Stringlast_name
Stringphone
Stringpostal_code
Stringremote_created_at
Stringremote_id
Stringremote_updated_at
Stringstate
String
Customer.io
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
email
Stringremote_id
String
getResponse
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
country
Enumemail
Stringfirst_name
Stringlast_name
Stringpostal_code
Stringremote_created_at
Stringremote_id
Stringremote_updated_at
Stringstate
String
Hubspot Marketing Hub
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
email
Stringfirst_name
Stringlast_name
Stringremote_created_at
Stringremote_id
String
Keap
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
email
Stringfirst_name
Stringlast_name
Stringphone
Stringremote_id
Stringremote_updated_at
String
Klaviyo
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
country
Enumemail
Stringfirst_name
Stringlast_name
Stringphone
Stringpostal_code
Stringremote_created_at
Stringremote_id
Stringremote_updated_at
Stringstate
String
Mailchimp
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
email
Stringfirst_name
Stringlast_name
Stringphone
Stringremote_id
Stringremote_updated_at
String
MessageBird
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
country
Enumemail
Stringfirst_name
Stringlast_name
Stringphone
Stringremote_created_at
Stringremote_id
Stringremote_updated_at
String
Podium
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
email
Stringfirst_name
Stringlast_name
Stringphone
Stringpostal_code
Stringremote_created_at
Stringremote_id
Stringremote_updated_at
Stringstate
String
SendGrid
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
country
Enumemail
Stringfirst_name
Stringlast_name
Stringphone
Stringpostal_code
Stringremote_created_at
Stringremote_id
Stringremote_updated_at
Stringstate
String
Sendinblue
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
email
Stringfirst_name
Stringlast_name
Stringphone
Stringpostal_code
Stringremote_created_at
Stringremote_id
Stringremote_updated_at
String