---
title: "Adds a new Lead"
method: POST
path: "/Entity/Lead"
tags: ["Entity"]
---

# Adds a new Lead

`POST /Entity/Lead`

If valid, the Lead will be created directly in Infinity.
            
Contact and Company Notes, and Job Description must not exceed the max upload size configured in Infinity.
            
A Photo must not exceed the max upload size configured in Infinity.
            
The max upload size can be retrieved from the /Reference/MaxUploadSize method (In KB).

The OwningConsultantId is optional, but if passed, it must be an active user id.
            
Only one of LinkedCompanyId and LinkedContactId can be passed for manual linking and must refer to a valid record on the database.

Automatic contact linking only occurs if both LinkedCompanyId and LinkedContactId are not supplied
            
Tags should be passed in as a comma-delimited string.

## Query parameters

- `automaticallyLinkToContacts` boolean, required

## Request body

- LeadRequest
  - `Description` string, nullable
  - `Forename` string, nullable
  - `Surname` string, nullable
  - `ContactNotes` string, nullable
  - `JobTitle` string, nullable
  - `Company` string, nullable
  - `CompanyNotes` string, nullable
  - `PhoneNumber` string, nullable
  - `MobileNumber` string, nullable
  - `EmailAddress` string, nullable
  - `LinkedInUrl` string, nullable
  - `WebsiteUrl` string, nullable
  - `Address` string, nullable
  - `Source` string, nullable
  - `Tags` string, nullable
  - `OwningConsultantId` integer, nullable
  - `LinkedCompanyId` integer, nullable
  - `LinkedContactId` integer, nullable
  - `ClientJobTitle` string, nullable
  - `JobDescription` string, nullable
  - `Photo` string, byte, nullable — A Base64 image to display against the Lead The image cannot exceed the max upload size configured in Infinity.

## Response `200`

OK - Created ID

- integer

## Other responses

- `400` — BadRequest
- `401` — Unauthorized
- `404` — NotFound

---

[API](https://skmtc.dev/vslcloud/apis/infinity-api.md) · [All operations](https://skmtc.dev/vslcloud/apis/infinity-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/vslcloud/infinity-api/revisions/54661781612a/schema)