# Add New Lead

`POST /api/leads`



- **Group:** Leads
- **Since:** v0.0.0
- **Authentication:** `authtoken` header, created under Setup > API > API Management
- **HTML version:** /apiguide/leads/post-lead/

## Headers

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `authtoken` | String | **required** | Authentication token, generated from admin area |

## Parameters

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `source` | String | **required** | Mandatory Lead source. |
| `status` | String | **required** | Mandatory Lead Status. |
| `name` | String | **required** | Mandatory Lead Name. |
| `assigned` | String | **required** | Mandatory Lead assigned. |
| `client_id` | String | optional | Optional Lead From Customer. |
| `tags` | String | optional | Optional Lead tags. |
| `contact` | String | optional | Optional Lead contact. |
| `title` | String | optional | Optional Position. |
| `email` | String | optional | Optional Lead Email Address. |
| `website` | String | optional | Optional Lead Website. |
| `phonenumber` | String | optional | Optional Lead Phone. |
| `company` | String | optional | Optional Lead company. |
| `address` | String | optional | Optional Lead address. |
| `city` | String | optional | Optional Lead City. |
| `zip` | String | optional | Optional Zip code. |
| `state` | String | optional | Optional Lead state. |
| `country` | String | optional | Optional Lead Country. |
| `default_language` | String | optional | Optional Lead Default Language. |
| `description` | String | optional | Optional Lead description. |
| `custom_contact_date` | String | optional | Optional Lead From Customer. |
| `contacted_today` | String | optional | Optional Lead Contacted Today. |
| `is_public` | String | optional | Optional Lead google sheet id. |

## Example request

```bash
curl -X POST "https://yoursite.com/api/leads" \
  -H "authtoken: YOUR_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{ "source": "...", "status": "...", "name": "...", "assigned": "..." }'
```

## Success response

### Success-Response:

```json
HTTP/1.1 200 OK
{
  "status": true,
  "message": "Lead add successful."
}
```

## Error responses

### Error-Response:

```json
HTTP/1.1 404 Not Found
{
  "status": false,
  "message": "Lead add fail."
}
```

---

Perfex CRM REST API by Themesic Interactive. Full reference: /apiguide/