# Create a lead

**POST /api/v1/leads**

The caller is recorded as the creator and is not assigned by default. An introducer is recorded as the lead's
introducer. The email, phone number and address become the lead's primary contact details.


## Servers
- https://api.plannrcrm.com: https://api.plannrcrm.com ()


## Authentication methods
- Personal access token & O auth2


## Parameters



### Body: application/json (object)

- **title** (string | null)
  Title of the lead.

- **first_name** (string)
  First name of the lead.

- **last_name** (string)
  Last name of the lead.

- **entity_name** (string | null)
  Entity name for non-individual leads.

- **client_type** (string)


  Client type of the lead. One of individual, joint, trust and business. Defaults to individual.

  | Value | Description |
  | ----- | ----------- |
  |individual|Individual|
  |joint|Joint|
  |trust|Trust|
  |business|Business|

- **date_of_birth** (string(date) | null)
  Date of birth. The lead must be at least 18 years old.

- **email** (string(email) | null)
  Email address of the lead, stored as the primary email. Required when no phone number is given.

- **phone** (string | null)
  Phone number of the lead, stored as the primary phone number. Required when no email is given. Assumed to be a GB number when no country code is given.

- **address** (object | null)
  Optional address, stored as the primary address.

- **status** (string)


  Status of the lead. One of new, contacted, pending_call_back, awaiting_client_action, meeting_booked and uncontactable. Defaults to new.

  | Value | Description |
  | ----- | ----------- |
  |new|New|
  |contacted|Contacted|
  |pending_call_back|Pending Call Back|
  |awaiting_client_action|Awaiting Client Action|
  |meeting_booked|Meeting Booked|
  |uncontactable|Uncontactable|

- **is_vulnerable** (string | null)


  Whether the lead is vulnerable. One of yes, no and possibly.

  | Value | Description |
  | ----- | ----------- |
  |yes|Yes|
  |no|No|
  |possibly|Possibly|

- **source_uuid** (string(uuid))
  UUID of an unarchived lead source in the firm.

- **sub_source_uuid** (string(uuid) | null)
  UUID of an unarchived sub-source belonging to the chosen lead source.

- **campaign** (string | null)
  Campaign the lead came from.

- **assigned_account_uuid** (string(uuid) | null)
  UUID of the employee to assign the lead to. Assigning anyone other than yourself requires the leads:updateAll permission.

- **introduced_by_uuid** (string(uuid) | null)
  UUID of an introducer in the firm. Not accepted from an introducer, who is recorded as the introducer automatically.

- **lead_interest_uuids** (array[string(uuid)])
  UUIDs of unarchived lead interests in the firm.

- **custom_fields** (object)
  Custom field values keyed by the custom field reference. Only references configured for leads are accepted.



## Responses
### 200


#### Body: application/json (object)
- **uuid** (string)

- **title** (string)

- **first_name** (string)

- **last_name** (string)

- **name** (string)

- **client_type** (string)

- **date_of_birth** (string)

- **status** (string)

- **status_changed_at** (string)

- **is_archived** (boolean)

- **is_promoted** (boolean)

- **can_update** (boolean)

- **can_archive** (boolean)

- **can_assign** (boolean)

- **can_update_introducer** (boolean)

- **source** (object)

- **sub_source** (object)

- **assigned_account** (object)

- **introduced_by** (object)

- **created_by** (object)

- **archived_by** (object)

- **promoted_by** (object)

- **client_account** (object)

- **primary_email** (object)

- **primary_phone_number** (object)

- **primary_address** (object)

- **interests** (array[object])

- **custom_fields** (array[object])

- **created_at** (string)

- **updated_at** (string)


### 403
Unauthorized

#### Body: application/json (object)
- **message** (string)
  A human-readable description of the error.


### 422
Validation error

#### Body: application/json (object)
- **message** (string)
  A human-readable description of the error.

- **errors** (object)
  Validation messages keyed by the field that failed.



[Powered by Bump.sh](https://bump.sh)