# Update a new business event

**PUT /api/v1/new-business-event/{newBusinessEvent_uuid}**




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


## Authentication methods
- Personal access token & O auth2


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


### Path parameters
- **newBusinessEvent_uuid** (string)



### Body: application/json (object)

- **plan_uuid** (string(uuid))
  Plan UUID. Must be a plan belonging to the firm. Only works if the new business event is not already joined to a plan
- **contribution_type** (string)
  Type of contribution, must be one of these types: initial, increment, decrement, advice_point, pension_transfer and switch
- **contribution_type_notes** (string)
  Note for other contribution type
- **adviser_uuid** (string(uuid))
  Adviser UUID. Must be employee of the firm
- **advice_type** (string)
  Type of advice, must be one of these types: advised, execution_only, insistent_investor, existing_provision, direct_offer and client_instruction
- **conducted_by** (string)
  How the advice was conducted, must be one of these types: correspondence_only, email, face_to_face, internet, other, printed_media_campaign, unknown and telephone
- **source_of_funds** (string)
  Source of funds, must be one of these types: gift, inheritance, isa_transfer, pension_transfer, salary, savings and other
- **source_of_funds_note** (string)
  Note for other source of funds. Required if source_of_funds is "other"
- **premium_amount** (integer)
  Premium amount in pence. 10000 = £100.00
- **premium_currency** (string)
  Premium currency. Defaults to "GBP". Must be one of these types: GBP
- **premium_frequency** (string)
  Premium frequency, must be one of these types: daily, weekly, fortnightly, four_weekly, monthly, bimonthly, quarterly, biannually, annually, adhoc and one_off
- **start_date** (string(date))
  Start date of premium. Required if status is "accepted"
- **proposal_date** (string(date))
  Proposal date of the New Business Event
- **case_uuid** (string(uuid))
  Case UUID to link this to a existing case
- **is_vulnerable_client** (string)
  Is this a vulnerable client. Defaults to "no". Must be one of these types: yes, no and possibly
- **is_replacing_existing_plan** (boolean)
  Is this replacing an existing plan
- **existing_plan_uuid** (string(uuid))
  Existing Plan UUID. Must be a plan belonging to the firm.
- **existing_plan_details** (string)
  Details of existing plan. Required if is_replacing_existing_plan is true and existing_plan_uuid is empty
- **opted_out_of_pension_scheme_for_plan** (boolean)
  Did the client opt out of an employer sponsored pension scheme to take out this plan. Required if related to a plan and is a pension plan
- **opted_out_at** (string(date))
  The datetime when the pension scheme was opted out of. Required if opted_out_of_pension_scheme_for_plan is true
- **opted_out_notes** (string)
  Notes for opting out of pension scheme. Required if opted_out_of_pension_scheme_for_plan is true
- **status** (string)
  Status of the plan, must be one of these types: accepted and proposed


## Responses
### 200


#### Body: application/json (object)
- **uuid** (string)
  The UUID of the resource.
- **created_at** (string)
  The timestamp of when the resource was created.
- **updated_at** (string)
  The timestamp of when the resource was updated.
- **plan** (object)
  The plan this event belongs to (if included)
- **clients** (object)
  The clients this event belongs to
- **modelable** (object)
  This will return a plan or first client in the clients collection
- **modelable_type** (string)
  The type of model this event belongs to (plan or client)
- **firm** (object)
  The firm which this event belongs to (if included)
- **contribution_type** (string)
  The type of contribution this event represents
- **contribution_type_notes** (string)
  Notes about the contribution type
- **adviser** (object)
  The adviser attached to the event
- **advice_type** (string)
  The type of advice given
- **conducted_by** (string)
  How the advice was conducted
- **premium** (object)
  How much premium was paid
- **premium_frequency** (string)
  How often premium is paid
- **start_date** (string)
  The date the premiums started
- **proposal_date** (string)
  The date the proposal was made
- **case** (object)
  The case this event belongs to (if included)
- **is_vulnerable_client** (boolean)
  Whether the client is vulnerable
- **is_replacing_existing_plan** (boolean)
  Whether the client is replacing an existing plan
- **existing_plan** (object)
  The existing plan (if included)
- **existing_plan_details** (string)
  Details about the existing plan
- **opted_out_of_pension_scheme_for_plan** (boolean)
  Whether the client opted out of a pension scheme
- **opted_out_at** (string)
  Timestamp of when the client opted out
- **opted_out_notes** (string)
  Notes about the opt out
- **status** (string)
  The status of the event


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