Skip to main content
POST
Create lead

Authorizations

Authorization
string
header
required

Enter your JWT token in the format: Bearer

Body

Lead Serializer

name
string
required

Lead company name

Required string length: 1 - 100
contact_person
string
required

Contact person name

Required string length: 1 - 100
contact_phone
string
required

Contact phone number

Required string length: 1 - 30
contact_email
string<email>
required

Contact email address

Required string length: 1 - 50
lead_category
string<uuid>
required
source
string<uuid>
required
products
string<uuid>[]
required
reference
string | null

Generated reference string

Maximum string length: 30
lead_type
enum<string>

Lead classification: individual or company

  • individual - Individual
  • company - Company
Available options:
individual,
company
gender
enum<string> | null

Gender of individual lead (only applicable when lead_type is individual)

  • male - Male
  • female - Female
Available options:
male,
female,
,
null
partner
string<uuid>

Response

201 - application/json

Lead Serializer

id
string<uuid>
required
read-only
name
string
required

Lead company name

Maximum string length: 100
contact_person
string
required

Contact person name

Maximum string length: 100
contact_phone
string
required

Contact phone number

Maximum string length: 30
contact_email
string<email>
required

Contact email address

Maximum string length: 50
lead_category
string<uuid>
required
source
string<uuid>
required
products
string<uuid>[]
required
status
string
required
read-only

Lead status

node
string
required
read-only

Workflow Node

created_at
string<date-time>
required
read-only
updated_at
string<date-time>
required
read-only
reference
string | null

Generated reference string

Maximum string length: 30
lead_type
enum<string>

Lead classification: individual or company

  • individual - Individual
  • company - Company
Available options:
individual,
company
gender
enum<string> | null

Gender of individual lead (only applicable when lead_type is individual)

  • male - Male
  • female - Female
Available options:
male,
female,
,
null
partner
string<uuid>