---
title: "Adds a Prospect"
method: POST
path: "/Prospect"
tags: ["Prospects"]
---

# Adds a Prospect

`POST /Prospect`

## Request

- Base URL: `https://api.insightly.com/v3.1`
- URL: `https://api.insightly.com/v3.1/Prospect`
- Auth: none declared. Required headers: `Authorization`

If you have trouble with creating a Prospect, try creating Prospects via the web interface, and then access those Prospects via the API. This way you            can see examples of the fields and sub-elements attached to the Prospect. A common source of problems during write/update request is caused when users omit            required fields, or insert invalid data in a field (e.g. reference a CATEGORY_ID that does not exist in the user's Insightly instance.

## Headers

- `Authorization` string, required

## Request body

- object
  - `PROSPECT_ID` integer
  - `SALUTATION` string, string
  - `FIRST_NAME` string, string
  - `LAST_NAME` string, string
  - `ORGANISATION_NAME` string, string
  - `TITLE` string, string
  - `EMAIL_ADDRESS` string, string, required
  - `PHONE` string, string
  - `MOBILE` string, string
  - `FAX` string, string
  - `WEBSITE` string, string
  - `ADDRESS_STREET` string, string
  - `ADDRESS_CITY` string, string
  - `ADDRESS_STATE` string, string
  - `ADDRESS_POSTCODE` string, string
  - `ADDRESS_COUNTRY` string, string
  - `INDUSTRY` string, string
  - `EMPLOYEE_COUNT` integer
  - `DESCRIPTION` string, string
  - `DO_NOT_EMAIL` boolean
  - `DO_NOT_CALL` boolean
  - `OPTED_OUT` boolean
  - `OWNER_USER_ID` integer
  - `DO_NOT_SYNC` boolean
  - `GRADE_PROFILE_ID` integer
  - `CUSTOMFIELDS` APICustomField[]
    - `FIELD_NAME` string
    - `FIELD_VALUE` object

## Response `201`

Request succeeded.

- object
  - `PROSPECT_ID` integer
  - `LEAD_ID` integer
  - `CONTACT_ID` integer
  - `ORGANISATION_ID` integer
  - `SALUTATION` string, string
  - `FIRST_NAME` string, string
  - `LAST_NAME` string, string
  - `ORGANISATION_NAME` string, string
  - `TITLE` string, string
  - `EMAIL_ADDRESS` string, string, required
  - `PHONE` string, string
  - `MOBILE` string, string
  - `FAX` string, string
  - `WEBSITE` string, string
  - `ADDRESS_STREET` string, string
  - `ADDRESS_CITY` string, string
  - `ADDRESS_STATE` string, string
  - `ADDRESS_POSTCODE` string, string
  - `ADDRESS_COUNTRY` string, string
  - `INDUSTRY` string, string
  - `EMPLOYEE_COUNT` integer
  - `SCORE` integer
  - `GRADE` string, string
  - `DESCRIPTION` string, string
  - `DO_NOT_EMAIL` boolean
  - `DO_NOT_CALL` boolean
  - `OPTED_OUT` boolean
  - `LAST_ACTIVITY_DATE_UTC` string, date-time
  - `CREATED_USER_ID` integer
  - `OWNER_USER_ID` integer
  - `DATE_CREATED_UTC` string, date-time
  - `DATE_UPDATED_UTC` string, date-time
  - `DO_NOT_SYNC` boolean
  - `LEAD_CONVERSION_DATE_UTC` string, date-time
  - `GRADE_PROFILE_ID` integer
  - `CUSTOMFIELDS` APICustomField[]
    - `FIELD_NAME` string
    - `FIELD_VALUE` object
  - `TAGS` APITag[]
    - `TAG_NAME` string

## Other responses

- `400`: Data validation error.
- `401`: Authentication failed.
- `402`: Record limit reached.

---

[API](https://skmtc.dev/insightly/apis/insightly-api-v3-1.md) - [All operations](https://skmtc.dev/insightly/apis/insightly-api-v3-1/llms.txt) - [OpenAPI document](https://skmtc.dev/insightly/apis/insightly-api-v3-1/revisions/e7df0c3b65fb?raw)