Create Lead

this api endpoint (post) (post) creates a new customer if the request succeeds, it returns a lead object docid\ datefzmzfytk1y4i2gdzj permissions customers create webhook event customer events docid\ vpxf3upxl n7gflcvvism body parameters name string the customer's first name email string the customer's email address country string ( appendix docid\ kfbmx4q3dxjtduqf75yx1 ) a two letter country code (iso 3166) representing the customer's country priority string the possible values are low , normal , medium and high the defaults is normal lead status string the possible values are qualified , unqualified , contacted , followup , new lead or attempt to contact last name string the customer's last name locale string ( appendix docid\ kfbmx4q3dxjtduqf75yx1 ) the customer's language the default is english en timezone offset string the utc timezone offset for this customer example +03 00 phone string the customer's primary phone number billing information object billing details are optional but recommended as they might be crucial for accounting and tax purposes "billing information" { "phone" "08421234", "name" "james doe" "representative" "representative doe", "email" "john doe\@tamio com", "address" "my street", "city" "frankfrt", "postcode" "abc1234", "country" "de", "locale" "en", "vat" "de1234567", "is company" true } phone string the customer's billing phone name string the customer's billing name or company representative string the name of the contact person for this address is company boolean this attribute shows whether this address belongs to a business or an individual the default value is false email string the customer's billing email address string the customer's address city string the customer's city postcode string the customer's postcode state string ( appendix docid\ kfbmx4q3dxjtduqf75yx1 ) the customer's state (if supported) country string ( appendix docid\ kfbmx4q3dxjtduqf75yx1 ) the customer's billing country in iso 3166 format vat number string the customer's vat number (if supported) locale string ( appendix docid\ kfbmx4q3dxjtduqf75yx1 ) the preferred language of the representative for this address shipping information object the shipping details are optional however it is recommended to collect them as soon as possible if you are planning to sell physical goods to this customer "shipping information" { "phone" "08421234", "name" "james doe" "email" "john doe\@tamio com", "address" "my street", "city" "frankfrt", "postcode" "abc1234", "country" "de", "locale" "en" } phone string the customer's billing phone name string the customer's billing name or company email string the customer's billing email address string the customer's address city string the customer's city postcode string the customer's postcode state string ( appendix docid\ kfbmx4q3dxjtduqf75yx1 ) the customer's state (if supported) country string ( appendix docid\ kfbmx4q3dxjtduqf75yx1 ) the customer's billing country in iso 3166 format locale string ( appendix docid\ kfbmx4q3dxjtduqf75yx1 ) the preferred language of the representative for this address same shipping address boolean the shipping address will be generated from the customer's billing information if set to true var myheaders = new headers(); myheaders append("accept", "application/json"); myheaders append("authorization", "bearer your token here"); var data = { name 'john', last name 'doe', country 'de', email 'john doe\@tamio com' }; var body = json stringify(data); var requestoptions = { method 'post', headers myheaders, body body }; fetch("https //api tamio com/v2/leads/create", requestoptions) then(response => response text()) then(result => console log(result)) catch(error => console log('error', error));curl location request post 'https //api tamio com/v2/leads/create' \\ \ header 'accept application/json' \\ \ header 'authorization bearer your token here' \ data raw '{"name" "john","country" "de","email" "john doe\@plugnpaid com","last name" "doe"}'var myheaders = new headers(); myheaders append("accept", "application/json"); myheaders append("authorization", "bearer your token here"); var data = { name 'john', last name 'doe', country 'de', email 'john doe\@tamio com' }; var body = json stringify(data); var requestoptions = { method 'post', headers myheaders, body body }; fetch("https //api tamio com/v2/leads/create", requestoptions) then(response => response text()) then(result => console log(result)) catch(error => console log('error', error));{ "status" 200, "lead" { "id" "c5f3b078 5520 4694 a4d1 d45885a6314e", "email" "john doe\@tamio com", "name" "john", "last name" "doe", "country" "de", "locale" "en", "billing addresses" \[], "shipping addresses" \[], "created at" 1664635710, "stripe customer id" null, "object" "customer", "teammate id" null, "timezone offset" "+00 00", "category" "lead", "priority" "normal", "source" "import", "affiliate partner id" null, "lead status" "new lead" } }