leads create

POST {{baseUrl}}/leads

Creates a Lead object with the given values.

Request Params

KeyDatatypeRequiredDescription
is_debug_modebooleanWhether to include debug fields (such as log file links) in the response.
run_asyncbooleanWhether or not third-party updates should be run asynchronously.

Request Body

[{"name"=>"remote_id", "value"=>"19202938", "datatype"=>"number"}, {"name"=>"owner", "value"=>"0358cbc6-2040-430a-848e-aafacbadf3aa", "datatype"=>"string"}, {"name"=>"lead_source", "value"=>"API Blogger", "datatype"=>"string"}, {"name"=>"title", "value"=>"Co-Founder", "datatype"=>"string"}, {"name"=>"company", "value"=>"Merge API", "datatype"=>"string"}, {"name"=>"first_name", "value"=>"Gil", "datatype"=>"string"}, {"name"=>"last_name", "value"=>"Feig", "datatype"=>"string"}, {"name"=>"remote_updated_at", "value"=>"2022-02-10T00:00:00Z", "datatype"=>"string"}, {"name"=>"remote_created_at", "value"=>"2021-11-10T00:00:00Z", "datatype"=>"string"}, {"name"=>"converted_date", "value"=>"2022-03-10T00:00:00Z", "datatype"=>"string"}, {"name"=>"converted_contact", "value"=>"urn:uuid:4a89cec8-9faa-07c7-3d16-b090cc2ac8a9", "datatype"=>"string"}, {"name"=>"converted_account", "value"=>"9c9de072-29cf-48e3-9578-1ca5b145b40e", "datatype"=>"string"}, {"name"=>"integration_params", "value"=>"{\"consectetur__6e\":{}}", "datatype"=>"string"}, {"name"=>"linked_account_params", "value"=>"{\"dolor4\":{},\"qui_2b2\":{}}", "datatype"=>"string"}]

HEADERS

KeyDatatypeRequiredDescription
X-Account-Tokenstring(Required) Token identifying the end user.
Content-Typestring
Acceptstring

RESPONSES

status: Created

{"errors":[{"detail":"custom_fields is a required field on model.","problem_type":"MISSING_REQUIRED_FIELD","title":"Missing Required Field","source":{"pointer":"amet aute enim commodo"}},{"detail":"custom_fields is a required field on model.","problem_type":"MISSING_REQUIRED_FIELD","title":"Missing Required Field","source":{"pointer":"tempor"}}],"model":{"id":"1b12c841-9834-dfe9-dcec-121576df4842","remote_id":"19202938","owner":"0358cbc6-2040-430a-848e-aafacbadf3aa","lead_source":"API Blogger","title":"Co-Founder","company":"Merge API","first_name":"Gil","last_name":"Feig","addresses":[{"street_1":"50 Bowling Green Dr","street_2":"Golden Gate Park","city":"San Francisco","state":"CA","postal_code":"94122","country":"SL","address_type":"BILLING"},{"street_1":"50 Bowling Green Dr","street_2":"Golden Gate Park","city":"San Francisco","state":"CA","postal_code":"94122","country":"NF","address_type":"BILLING"}],"email_addresses":[{"email_address":"hello@merge.dev","email_address_type":"Work"}],"phone_numbers":[{"phone_number":"+16789932455","phone_number_type":"Mobile"}],"remote_updated_at":"2022-02-10T00:00:00Z","remote_created_at":"2021-11-10T00:00:00Z","converted_date":"2022-03-10T00:00:00Z","converted_contact":"urn:uuid:62ae5ee0-98f4-9e68-e27f-bafd4ff227c9","converted_account":"9c9de072-29cf-48e3-9578-1ca5b145b40e"},"warnings":[{"detail":"An unrecognized field, age, was passed in with request data.","problem_type":"UNRECOGNIZED_FIELD","title":"Unrecognized Field","source":{"pointer":"nost"}},{"detail":"An unrecognized field, age, was passed in with request data.","problem_type":"UNRECOGNIZED_FIELD","title":"Unrecognized Field","source":{"pointer":"do laborum ullamco"}}],"logs":[{"dashboard_view":"https://app.merge.dev/logs/99433219-8017-4acd-bb3c-ceb23d663832","log_id":"99433219-8017-4acd-bb3c-ceb23d663832","log_summary":{"method":"POST","status_code":200,"url":"https://harvest.greenhouse.io/v1/candidates/"}},{"dashboard_view":"https://app.merge.dev/logs/99433219-8017-4acd-bb3c-ceb23d663832","log_id":"99433219-8017-4acd-bb3c-ceb23d663832","log_summary":{"method":"POST","status_code":200,"url":"https://harvest.greenhouse.io/v1/candidates/"}}]}