Create a Lead

Create a new lead in the CRM system.

Method: POST
Endpoint: https://qa.one.flinkk.io/api/method/lead/create

Parameters

Headers

Name	In	Type	Required	Description
`Accept`	header	`string`	✅	Must be `application/json`.
`Content-Type`	header	`string`	✅	Must be `application/json`.
`Authorization`	header	`string`	✅	`Bearer <token>` when auth is enabled.

Body (JSON)

Field	Type	Required	Notes
`salutation`	`string`		e.g., `MR`, `MS`, `DR`.
`firstName`	`string`	✅
`lastName`	`string`	✅
`title`	`string`		Job title or role.
`company`	`string`		Company/Organization name.
`website`	`string(url)`
`description`	`string`		Free‑form description.
`requirements`	`string`		Lead requirements / interest.
`email`	`string(email)`		Must be valid email if provided.
`phone`	`string`		E.164 recommended.
`additionalPhone`	`string`		Alternate phone.
`country`	`string`
`streetAddress`	`string`
`city`	`string`
`postalCode`	`string`
`state`	`string`		State/Province.
`companySize`	`string`		e.g., `1-10`, `11-50`, `100-500`.
`annualRevenue`	`string	number`
`industry`	`string`
`source`	`string`		e.g., `Website`, `Campaign`, `Referral`.
`notes`	`string`		Internal notes.
`tags`	`string	string[]`
`priority`	`"LOW"	"MEDIUM"	"HIGH"`
`isB2B`	`boolean`		Defaults to `false`.
`customFields`	`array`		Key/Value custom fields.
`status`	`"NEW"	"QUALIFIED"	"DISQUALIFIED"`

Request Example

curl --location 'http://localhost:3008/api/method/lead/create' \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --data-raw '{
    "salutation": "DR",
    "firstName": "Daniel",
    "lastName": "Woods",
    "company": "Douglas and Ferrell Plc",
    "email": "myrena@mailinator.com",
    "phone": "+17438154638",
    "priority": "HIGH",
    "status": "NEW"
  }'

Responses

{
  "id": "lead_01K3XYZ9ABCD1234",
  "firstName": "Daniel",
  "lastName": "Woods",
  "email": "myrena@mailinator.com",
  "phone": "+17438154638",
  "company": "Douglas and Ferrell Plc",
  "status": "NEW",
  "priority": "HIGH",
  "createdAt": "2025-08-27T12:30:45Z",
  "updatedAt": "2025-08-27T12:30:45Z"
}

Introduction