CRM

Create a Lead

Creates a new Lead.

post/admin/crm/leads

Request

  • Base URL: https://demo.splynx.com/api/2.0
  • URL: https://demo.splynx.com/api/2.0/admin/crm/leads
  • Auth: HTTP basic

Request body

billing_typestring

Billing type: 'recurring', 'prepaid_monthly'

partner_idnumber required

Partner id. You can get it at page "Administration / Partners"

location_idnumber required

Location id. You can get it at page "Administration / Locations"

added_bystring

Added by: 'api', 'admin', 'widget'

added_by_idnumber

Added by id

namestring required

Full name

emailstring

Email

billing_emailstring

Billing email

phonestring

Phone number

categorystring required

Category: 'person' (for private person) or 'company' (for company). Default value: 'person'

street_1string

Address part #1

zip_codestring

Zip

citystring

City

date_addstring

Date of adding. Format: 'YYYY-MM-DD'. Default value: current date

last_updatestring

Last date update customer.

subdivision_idnumber

State/province ID

lead_labelsnumber[]

Array of lead labels (ids)

Example request

{
  "billing_type": "recurring",
  "partner_id": 1,
  "location_id": 1,
  "added_by": "admin",
  "added_by_id": 1,
  "name": "Lead Name",
  "email": "test@mail.com",
  "billing_email": "test@mail.com",
  "phone": "555-0135",
  "category": "person",
  "street_1": "2nd Street",
  "last_update": "2022-04-21 05:09:06",
  "subdivision_id": 1,
  "contacts": [
    {
      "id": 1,
      "type": "email",
      "value": "john.doe@domain.com",
      "label": "primary",
      "country_code": "380",
      "is_primary": true
    }
  ]
}

Response

idnumber required

Lead ID

Example response

{
  "id": 1
}

Changes

No recorded changes to this operation across all 1 revision of this API.