Lead
object is used to represent an individual who is a potential customer.id
UUIDremote_id
Stringcreated_at
DateTime (ISO 8601)modified_at
DateTime (ISO 8601)owner
UUIDlead_source
Stringtitle
Stringcompany
Stringfirst_name
Stringlast_name
Stringaddresses
Address[]Address
object is used to represent an entity's address.created_at
DateTime (ISO 8601)modified_at
DateTime (ISO 8601)street_1
Stringstreet_2
Stringcity
Stringstate
Stringpostal_code
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
. In cases where there is no clear mapping, the original value passed through will be returned.address_type
EnumBILLING
, SHIPPING
. In cases where there is no clear mapping, the original value passed through will be returned.email_addresses
EmailAddress[]EmailAddress
object is used to represent an entity's email address.created_at
DateTime (ISO 8601)modified_at
DateTime (ISO 8601)email_address
Stringemail_address_type
Stringphone_numbers
PhoneNumber[]PhoneNumber
object is used to represent an entity's phone number.created_at
DateTime (ISO 8601)modified_at
DateTime (ISO 8601)phone_number
Stringphone_number_type
Stringremote_updated_at
DateTime (ISO 8601)remote_created_at
DateTime (ISO 8601)converted_date
DateTime (ISO 8601)converted_contact
UUIDconverted_account
UUIDremote_was_deleted
Booleanfield_mappings
Objectremote_data
RemoteData[]remote_fields
RemoteField[]https://api.merge.dev/api/crm/v1/leads
Returns a list of Lead
objects.
converted_account_id
Stringconverted_contact_id
Stringcreated_after
DateTime (ISO 8601)created_before
DateTime (ISO 8601)cursor
Stringemail_addresses
Stringexpand
Stringinclude_deleted_data
Booleaninclude_remote_data
Booleaninclude_remote_fields
Booleaninclude_shell_data
Booleanmodified_after
DateTime (ISO 8601)modified_before
DateTime (ISO 8601)owner_id
Stringpage_size
Integerphone_numbers
Stringremote_id
StringSupported Response Fields
owner
UUIDremote_created_at
DateTime (ISO 8601)remote_data
RemoteData[]path
stringdata
stringremote_id
Stringremote_updated_at
DateTime (ISO 8601)title
StringSupported Response Fields
company
Stringconverted_account
UUIDconverted_contact
UUIDconverted_date
DateTime (ISO 8601)first_name
Stringlast_name
Stringlead_source
Stringowner
UUIDremote_created_at
DateTime (ISO 8601)remote_data
RemoteData[]path
stringdata
stringremote_id
Stringremote_updated_at
DateTime (ISO 8601)title
StringSupported Response Fields
company
Stringfirst_name
Stringlast_name
Stringlead_source
Stringowner
UUIDremote_created_at
DateTime (ISO 8601)remote_data
RemoteData[]path
stringdata
stringremote_id
Stringremote_updated_at
DateTime (ISO 8601)title
StringSupported Response Fields
addresses
Address[]created_at
stringmodified_at
stringstreet_1
stringstreet_2
stringcity
stringstate
stringpostal_code
stringcountry
stringaddress_type
stringcompany
Stringemail_addresses
EmailAddress[]created_at
stringmodified_at
stringemail_address
stringemail_address_type
stringfirst_name
Stringlast_name
Stringlead_source
Stringowner
UUIDphone_numbers
PhoneNumber[]created_at
stringmodified_at
stringphone_number
stringphone_number_type
stringremote_created_at
DateTime (ISO 8601)remote_data
RemoteData[]path
stringdata
stringremote_fields
RemoteField[]remote_field_class
objectvalue
objectremote_id
Stringremote_updated_at
DateTime (ISO 8601)title
StringSupported Response Fields
company
Stringconverted_account
UUIDconverted_contact
UUIDowner
UUIDremote_created_at
DateTime (ISO 8601)remote_data
RemoteData[]path
stringdata
stringremote_id
Stringremote_updated_at
DateTime (ISO 8601)title
StringSupported Response Fields
addresses
Address[]created_at
stringmodified_at
stringstreet_1
stringstreet_2
stringcity
stringstate
stringpostal_code
stringcountry
stringaddress_type
stringcompany
Stringconverted_account
UUIDconverted_contact
UUIDconverted_date
DateTime (ISO 8601)email_addresses
EmailAddress[]created_at
stringmodified_at
stringemail_address
stringemail_address_type
stringfirst_name
Stringlast_name
Stringlead_source
Stringowner
UUIDphone_numbers
PhoneNumber[]created_at
stringmodified_at
stringphone_number
stringphone_number_type
stringremote_created_at
DateTime (ISO 8601)remote_data
RemoteData[]path
stringdata
stringremote_fields
RemoteField[]remote_field_class
objectvalue
objectremote_id
Stringremote_updated_at
DateTime (ISO 8601)title
StringSupported Response Fields
company
Stringemail_addresses
EmailAddress[]created_at
stringmodified_at
stringemail_address
stringemail_address_type
stringfirst_name
Stringlast_name
Stringlead_source
Stringowner
UUIDremote_created_at
DateTime (ISO 8601)remote_data
RemoteData[]path
stringdata
stringremote_id
Stringremote_updated_at
DateTime (ISO 8601)title
StringSupported Response Fields
owner
UUIDremote_created_at
DateTime (ISO 8601)remote_data
RemoteData[]path
stringdata
stringremote_id
Stringremote_updated_at
DateTime (ISO 8601)title
StringSupported Response Fields
company
Stringfirst_name
Stringlast_name
Stringlead_source
Stringowner
UUIDremote_created_at
DateTime (ISO 8601)remote_data
RemoteData[]path
stringdata
stringremote_id
Stringremote_updated_at
DateTime (ISO 8601)title
StringSupported Response Fields
company
Stringconverted_account
UUIDconverted_contact
UUIDconverted_date
DateTime (ISO 8601)email_addresses
EmailAddress[]created_at
stringmodified_at
stringemail_address
stringemail_address_type
stringfirst_name
Stringlast_name
Stringlead_source
Stringowner
UUIDphone_numbers
PhoneNumber[]created_at
stringmodified_at
stringphone_number
stringphone_number_type
stringremote_created_at
DateTime (ISO 8601)remote_data
RemoteData[]path
stringdata
stringremote_id
Stringremote_updated_at
DateTime (ISO 8601)title
StringSupported Response Fields
addresses
Address[]created_at
stringmodified_at
stringstreet_1
stringstreet_2
stringcity
stringstate
stringpostal_code
stringcountry
stringaddress_type
stringcompany
Stringconverted_account
UUIDconverted_contact
UUIDconverted_date
DateTime (ISO 8601)email_addresses
EmailAddress[]created_at
stringmodified_at
stringemail_address
stringemail_address_type
stringfirst_name
Stringlast_name
Stringlead_source
Stringowner
UUIDphone_numbers
PhoneNumber[]created_at
stringmodified_at
stringphone_number
stringphone_number_type
stringremote_created_at
DateTime (ISO 8601)remote_data
RemoteData[]path
stringdata
stringremote_fields
RemoteField[]remote_field_class
objectvalue
objectremote_id
Stringremote_updated_at
DateTime (ISO 8601)title
Stringhttps://api.merge.dev/api/crm/v1/leads
Creates a Lead
object with the given values.
is_debug_mode
Booleanrun_async
Booleanmodel
Objectowner
UUIDid
field in the User object.lead_source
Stringtitle
Stringcompany
Stringfirst_name
Stringlast_name
Stringaddresses
Arrayemail_addresses
Arrayphone_numbers
Arrayconverted_date
DateTime (ISO 8601)converted_contact
UUIDid
field in the Contact object.converted_account
UUIDid
field in the Account object.integration_params
Objectlinked_account_params
Objectremote_fields
ArraySupported POST Model Parameters
addresses
Address[]created_at
stringmodified_at
stringstreet_1
stringstreet_2
stringcity
stringstate
stringpostal_code
stringcountry
stringaddress_type
stringcompany
Stringemail_addresses
EmailAddress[]created_at
stringmodified_at
stringemail_address
stringemail_address_type
stringfirst_name
Stringlast_name
Stringlead_source
Stringowner
UUIDphone_numbers
PhoneNumber[]created_at
stringmodified_at
stringphone_number
stringphone_number_type
stringremote_created_at
DateTime (ISO 8601)remote_id
Stringremote_updated_at
DateTime (ISO 8601)title
StringAdditional POST Parameters
integration_params
Objectorganization_id
Stringperson_id
Stringremote_fields
Objectremote_field_class
Stringvalue
StringSupported POST Model Parameters
addresses
Address[]created_at
stringmodified_at
stringstreet_1
stringstreet_2
stringcity
stringstate
stringpostal_code
stringcountry
stringaddress_type
stringcompany
Stringconverted_account
UUIDconverted_contact
UUIDconverted_date
DateTime (ISO 8601)email_addresses
EmailAddress[]created_at
stringmodified_at
stringemail_address
stringemail_address_type
stringfirst_name
Stringlast_name
Stringlead_source
Stringowner
UUIDphone_numbers
PhoneNumber[]created_at
stringmodified_at
stringphone_number
stringphone_number_type
stringremote_created_at
DateTime (ISO 8601)remote_fields
RemoteField[]remote_field_class
objectvalue
objectremote_id
Stringremote_updated_at
DateTime (ISO 8601)title
StringSupported POST Model Parameters
addresses
Address[]created_at
stringmodified_at
stringstreet_1
stringstreet_2
stringcity
stringstate
stringpostal_code
stringcountry
stringaddress_type
stringcompany
Stringconverted_account
UUIDconverted_contact
UUIDconverted_date
DateTime (ISO 8601)email_addresses
EmailAddress[]created_at
stringmodified_at
stringemail_address
stringemail_address_type
stringfirst_name
Stringlast_name
Stringlead_source
Stringowner
UUIDphone_numbers
PhoneNumber[]created_at
stringmodified_at
stringphone_number
stringphone_number_type
stringremote_created_at
DateTime (ISO 8601)remote_fields
RemoteField[]remote_field_class
objectvalue
objectremote_id
Stringremote_updated_at
DateTime (ISO 8601)title
Stringhttps://api.merge.dev/api/crm/v1/leads/{id}
Returns a Lead
object with the given id
.
expand
Stringid
UUIDinclude_remote_data
Booleaninclude_remote_fields
BooleanSupported Response Fields
owner
UUIDremote_created_at
DateTime (ISO 8601)remote_data
RemoteData[]path
stringdata
stringremote_id
Stringremote_updated_at
DateTime (ISO 8601)title
StringSupported Response Fields
company
Stringconverted_account
UUIDconverted_contact
UUIDconverted_date
DateTime (ISO 8601)first_name
Stringlast_name
Stringlead_source
Stringowner
UUIDremote_created_at
DateTime (ISO 8601)remote_data
RemoteData[]path
stringdata
stringremote_id
Stringremote_updated_at
DateTime (ISO 8601)title
StringSupported Response Fields
company
Stringfirst_name
Stringlast_name
Stringlead_source
Stringowner
UUIDremote_created_at
DateTime (ISO 8601)remote_data
RemoteData[]path
stringdata
stringremote_id
Stringremote_updated_at
DateTime (ISO 8601)title
StringSupported Response Fields
addresses
Address[]created_at
stringmodified_at
stringstreet_1
stringstreet_2
stringcity
stringstate
stringpostal_code
stringcountry
stringaddress_type
stringcompany
Stringemail_addresses
EmailAddress[]created_at
stringmodified_at
stringemail_address
stringemail_address_type
stringfirst_name
Stringlast_name
Stringlead_source
Stringowner
UUIDphone_numbers
PhoneNumber[]created_at
stringmodified_at
stringphone_number
stringphone_number_type
stringremote_created_at
DateTime (ISO 8601)remote_data
RemoteData[]path
stringdata
stringremote_fields
RemoteField[]remote_field_class
objectvalue
objectremote_id
Stringremote_updated_at
DateTime (ISO 8601)title
StringSupported Response Fields
company
Stringconverted_account
UUIDconverted_contact
UUIDowner
UUIDremote_created_at
DateTime (ISO 8601)remote_data
RemoteData[]path
stringdata
stringremote_id
Stringremote_updated_at
DateTime (ISO 8601)title
StringSupported Response Fields
addresses
Address[]created_at
stringmodified_at
stringstreet_1
stringstreet_2
stringcity
stringstate
stringpostal_code
stringcountry
stringaddress_type
stringcompany
Stringconverted_account
UUIDconverted_contact
UUIDconverted_date
DateTime (ISO 8601)email_addresses
EmailAddress[]created_at
stringmodified_at
stringemail_address
stringemail_address_type
stringfirst_name
Stringlast_name
Stringlead_source
Stringowner
UUIDphone_numbers
PhoneNumber[]created_at
stringmodified_at
stringphone_number
stringphone_number_type
stringremote_created_at
DateTime (ISO 8601)remote_data
RemoteData[]path
stringdata
stringremote_fields
RemoteField[]remote_field_class
objectvalue
objectremote_id
Stringremote_updated_at
DateTime (ISO 8601)title
StringSupported Response Fields
company
Stringemail_addresses
EmailAddress[]created_at
stringmodified_at
stringemail_address
stringemail_address_type
stringfirst_name
Stringlast_name
Stringlead_source
Stringowner
UUIDremote_created_at
DateTime (ISO 8601)remote_data
RemoteData[]path
stringdata
stringremote_id
Stringremote_updated_at
DateTime (ISO 8601)title
StringSupported Response Fields
owner
UUIDremote_created_at
DateTime (ISO 8601)remote_data
RemoteData[]path
stringdata
stringremote_id
Stringremote_updated_at
DateTime (ISO 8601)title
StringSupported Response Fields
company
Stringfirst_name
Stringlast_name
Stringlead_source
Stringowner
UUIDremote_created_at
DateTime (ISO 8601)remote_data
RemoteData[]path
stringdata
stringremote_id
Stringremote_updated_at
DateTime (ISO 8601)title
StringSupported Response Fields
company
Stringconverted_account
UUIDconverted_contact
UUIDconverted_date
DateTime (ISO 8601)email_addresses
EmailAddress[]created_at
stringmodified_at
stringemail_address
stringemail_address_type
stringfirst_name
Stringlast_name
Stringlead_source
Stringowner
UUIDphone_numbers
PhoneNumber[]created_at
stringmodified_at
stringphone_number
stringphone_number_type
stringremote_created_at
DateTime (ISO 8601)remote_data
RemoteData[]path
stringdata
stringremote_id
Stringremote_updated_at
DateTime (ISO 8601)title
StringSupported Response Fields
addresses
Address[]created_at
stringmodified_at
stringstreet_1
stringstreet_2
stringcity
stringstate
stringpostal_code
stringcountry
stringaddress_type
stringcompany
Stringconverted_account
UUIDconverted_contact
UUIDconverted_date
DateTime (ISO 8601)email_addresses
EmailAddress[]created_at
stringmodified_at
stringemail_address
stringemail_address_type
stringfirst_name
Stringlast_name
Stringlead_source
Stringowner
UUIDphone_numbers
PhoneNumber[]created_at
stringmodified_at
stringphone_number
stringphone_number_type
stringremote_created_at
DateTime (ISO 8601)remote_data
RemoteData[]path
stringdata
stringremote_fields
RemoteField[]remote_field_class
objectvalue
objectremote_id
Stringremote_updated_at
DateTime (ISO 8601)title
Stringhttps://api.merge.dev/api/crm/v1/leads/meta/post
Returns metadata for Lead
POSTs.
Supported POST Model Parameters
addresses
Address[]created_at
stringmodified_at
stringstreet_1
stringstreet_2
stringcity
stringstate
stringpostal_code
stringcountry
stringaddress_type
stringcompany
Stringemail_addresses
EmailAddress[]created_at
stringmodified_at
stringemail_address
stringemail_address_type
stringfirst_name
Stringlast_name
Stringlead_source
Stringowner
UUIDphone_numbers
PhoneNumber[]created_at
stringmodified_at
stringphone_number
stringphone_number_type
stringremote_created_at
DateTime (ISO 8601)remote_id
Stringremote_updated_at
DateTime (ISO 8601)title
StringAdditional POST Parameters
integration_params
Objectorganization_id
Stringperson_id
Stringremote_fields
Objectremote_field_class
Stringvalue
StringSupported POST Model Parameters
addresses
Address[]created_at
stringmodified_at
stringstreet_1
stringstreet_2
stringcity
stringstate
stringpostal_code
stringcountry
stringaddress_type
stringcompany
Stringconverted_account
UUIDconverted_contact
UUIDconverted_date
DateTime (ISO 8601)email_addresses
EmailAddress[]created_at
stringmodified_at
stringemail_address
stringemail_address_type
stringfirst_name
Stringlast_name
Stringlead_source
Stringowner
UUIDphone_numbers
PhoneNumber[]created_at
stringmodified_at
stringphone_number
stringphone_number_type
stringremote_created_at
DateTime (ISO 8601)remote_fields
RemoteField[]remote_field_class
objectvalue
objectremote_id
Stringremote_updated_at
DateTime (ISO 8601)title
StringSupported POST Model Parameters
addresses
Address[]created_at
stringmodified_at
stringstreet_1
stringstreet_2
stringcity
stringstate
stringpostal_code
stringcountry
stringaddress_type
stringcompany
Stringconverted_account
UUIDconverted_contact
UUIDconverted_date
DateTime (ISO 8601)email_addresses
EmailAddress[]created_at
stringmodified_at
stringemail_address
stringemail_address_type
stringfirst_name
Stringlast_name
Stringlead_source
Stringowner
UUIDphone_numbers
PhoneNumber[]created_at
stringmodified_at
stringphone_number
stringphone_number_type
stringremote_created_at
DateTime (ISO 8601)remote_fields
RemoteField[]remote_field_class
objectvalue
objectremote_id
Stringremote_updated_at
DateTime (ISO 8601)title
Stringhttps://api.merge.dev/api/crm/v1/leads/remote-field-classes
Returns a list of RemoteFieldClass
objects.
cursor
Stringinclude_deleted_data
Booleaninclude_remote_data
Booleaninclude_remote_fields
Booleaninclude_shell_data
Booleanis_common_model_field
Booleanpage_size
Integer