# Creates a new referral to share client data with a connected firm.

**POST /api/v1/referrals**

The connection must be accepted before referrals can be sent.


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


## Authentication methods
- Personal access token & O auth2


## Parameters
### Headers
- **X-PLANNR-ACCOUNT-UUID** (string)




### Body: application/json (object)

- **connection_uuid** (string)
  The UUID of an accepted referral connection.
- **client_uuids** (array)
  Array of client account UUIDs to refer.
- **advice_type** (string)
  |

  The type of advice being referred. Options: investments, protection, mortgages, estate_planning, other, pensions and tax

  | Value | Description |
  | ----- | ----------- |
  |investments|Investments|
  |protection|Protection|
  |mortgages|Mortgages|
  |estate_planning|Estate Planning|
  |other|Other|
  |pensions|Pensions|
  |tax|Tax|
- **duration_months** (integer)
  Duration in months for the referral. Options: 1, 2, 3, 6. Null for lifetime.
- **shared_data** (array)
  Data categories to share. Options: basic_details, contact_details, income, expenditure, dependants, investments_and_plans, pensions, liabilities, protection, cash_accounts, goals and notes
- **sla_deadline** (string(date))
  SLA deadline for the recipient to respond.
- **note** (string)
  Additional notes about the referral.


## Responses
### 200


#### Body: application/json (object)
- **uuid** (string)
  The UUID of the resource.
- **direction** (string)
  The direction of the referral relative to the current firm. Possible values: sent, received
- **connection** (object)
  The referral connection this referral belongs to
- **clients** (array[object])
  The original client accounts being referred
- **cloned_clients** (array[object])
  The cloned client accounts in the recipient firm
- **advice_type** (string)
  The type of advice. Possible values: investments, protection, mortgages, estate_planning, other, pensions and tax
- **duration_months** (integer)
  Duration in months (1, 2, 3, or 6). Null for lifetime.
- **shared_data** (array[string])
  Data categories being shared. Possible values: basic_details, contact_details, income, expenditure, dependants, investments_and_plans, pensions, liabilities, protection, cash_accounts, goals and notes
- **note** (string)
  Additional notes about the referral
- **sla_deadline** (string)
  SLA deadline for recipient to respond
- **status** (string)
  The status of the referral. Possible values: pending, accepted, rejected and expired
- **rejection_reason** (string)
  Reason for rejection (only present if rejected)
- **sender_firm** (object)
  The firm that sent the referral
- **recipient_firm** (object)
  The firm that received the referral
- **sender_account** (object)
  The account that sent the referral
- **recipient_account** (object)
  The account that received the referral
- **created_at** (string)
  The timestamp of when the resource was created.
- **updated_at** (string)
  The timestamp of when the resource was updated.
- **expires_at** (string)
  The datetime when the referral expires


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