Operations API
Leads

Create Lead

This API endpoint (POST) creates a new customer. If the request succeeds, it returns a Lead Object. Permissions: customers.create Webhook event: customer-created

Body Parameters

name string * The customer's first name.



email string * The customer's email address.



country string (Country Codes) * 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 (Language Codes) 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.

JSON

  • 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 (State Codes) The customer's state (if supported).
  • country string (Country Codes) * The customer's billing country in ISO 3166 format.
  • vat_number string The customer's VAT number (if supported).
  • locale string (Language Codes) 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.

JSON

  • 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 (State Codes) The customer's state (if supported).
  • country string (Country Codes) * The customer's billing country in ISO 3166 format.
  • locale string (Language Codes) 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.