Create a lead

Create a new lead in your workspace.

POST /leads

Create a lead

cURL

curl --request POST \
  --url https://{your-subdomain}.neetocrm.com/api/external/v1/leads \
  --header 'Content-Type: application/json' \
  --header 'X-Api-Key: <x-api-key>' \
  --data '
{
  "lead": {
    "name": "Eve",
    "status": "open",
    "company_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "contact_id": 1,
    "owner_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "tag_ids": [
      "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "b2c3d4e5-f6a7-8901-bcde-f12345678901"
    ]
  }
}
'

201

{
  "lead": {
    "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "name": "Eve",
    "status": "open",
    "unique_number": "L-001",
    "email": "[e-mail]",
    "phone_number": "",
    "contact_name": "Eve",
    "contact_id": null,
    "company_name": null,
    "company_id": null,
    "owner": null,
    "tags": [],
    "created_at": "2025-03-15T10:30:00.000Z",
    "updated_at": "2025-03-15T10:30:00.000Z"
  }
}

Replace {your-subdomain} with your workspace’s subdomain.
Learn how to find your subdomain in Identifying your subdomain.

Headers

X-Api-Key · string · required

X-Api-Key is used to authenticate requests using an API key. Provide your API key in this header to access protected endpoints. Refer to Authentication for more information.

Body

application/json

lead · object

Hide child attributes

lead. name · string · required

Lead name.

Example:

"Eve"

lead. status · enum<string>

Lead status.

Available options: open, converted, archived

Example:

"open"

lead. company_id · string

Unique identifier of the associated company.

Example:

"a1b2c3d4-e5f6-7890-abcd-ef1234567890"

lead. contact_id · integer

Associated contact ID.

Example:

1

lead. owner_id · string

Unique identifier of the owner.

Example:

"a1b2c3d4-e5f6-7890-abcd-ef1234567890"

lead. tag_ids · string[]

Array of tag IDs.

Example:

[
  "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "b2c3d4e5-f6a7-8901-bcde-f12345678901"
]

Response

201 - application/json

Lead created successfully.

lead · object

Hide child attributes

lead. id · string

Unique identifier for the lead.

lead. name · string

Name of the lead.

lead. status · enum<string>

Current status of the lead.

Available options: open, converted, archived

lead. unique_number · string

Auto-generated unique number for the lead.

lead. email · string | null

Email address of the lead (from associated contact).

lead. phone_number · string | null

Phone number of the lead (from associated contact).

lead. contact_name · string | null

Name of the associated contact.

lead. contact_id · string | null

Unique identifier of the associated contact.

lead. company_name · string | null

Name of the associated company.

lead. company_id · string | null

Unique identifier of the associated company.

lead. owner · object

Owner of the lead.

Hide child attributes

lead.owner. id · string

Unique identifier of the owner.

lead.owner. name · string

Name of the owner.

lead. tags · object[]

Tags associated with the lead.

Hide child attributes

lead.tags. id · string

Unique identifier for the tag.

lead.tags. name · string

Name of the tag.

lead.tags. style · string

Style/color of the tag.

lead. created_at · string<date-time>

Timestamp when the lead was created.

lead. updated_at · string<date-time>

Timestamp when the lead was last updated.