Create an linked policy number Run in API Explorer

Add MCP server to your AI tool

Allow AI tools and LLMs to interact with the API documentation portal through MCP.

MCP server URL

https://apidocs.plannrcrm.com/mcp

Standard setup for AI tools providing an mcp.json file

mcp.json 
{
  "PlannrCRM MCP server": {
    "url": "https://apidocs.plannrcrm.com/mcp"
  }
}
Close
POST /api/v2/plans/{plan_uuid}/linked-policy-numbers
Personal access token & O auth2

Headers

  • X-PLANNR-ACCOUNT-UUID string

Path parameters

  • plan_uuid string Required
application/json

Body

  • linked_policy_number string Required

    The linked policy number for the plan.

Responses

  • 201 application/json
    Hide response attributes Show response attributes object
    • uuid string
    • created_at string
    • updated_at string
    • linked_policy_number string
    • plan object
      Hide plan attributes Show plan attributes object
      • uuid string
      • created_at string
      • updated_at string
      • opened_at string
      • name string
      • type string
      • sub_type string
      • abstract_type string
      • policy_number string
      • proposal_reference string
      • status string
      • inactive_at string
      • inactive_reason string
      • agency_in_your_name boolean
      • agency_in_your_name_from string
      • originally_sold_by_firm boolean
      • under_advice boolean
      • visible_on_client_portal boolean
      • include_in_client_valuation boolean
      • show_on_joint boolean
      • shown_on_circles boolean
      • review_date string
      • on_panel boolean
      • is_group_scheme boolean
      • is_sub_group_scheme boolean
      • is_group_scheme_member boolean
      • advice_area string
      • main_account object
        Hide main_account attributes Show main_account attributes object
        • uuid

          UUID of the sub account

        • created_at

          The timestamp of when the resource was created.

        • updated_at

          The timestamp of when the resource was created.

        • name

          Descriptive name of the sub account

        • policy_number

          Provider reference of the sub account

        • is_main_account

          Denotes if the sub account a main account of the plan

        • statistics

          The statistics on a sub account. Only displayed when you retrieve an individual sub-account.

      • sub_accounts object
        Hide sub_accounts attributes Show sub_accounts attributes object
        • uuid

          UUID of the sub account

        • created_at

          The timestamp of when the resource was created.

        • updated_at

          The timestamp of when the resource was created.

        • name

          Descriptive name of the sub account

        • policy_number

          Provider reference of the sub account

        • is_main_account

          Denotes if the sub account a main account of the plan

        • statistics

          The statistics on a sub account. Only displayed when you retrieve an individual sub-account.

      • provider object
        Hide provider attributes Show provider attributes object
        • uuid

          UUID of the provider

        • created_at

          The timestamp of when the resource was created.

        • updated_at

          The timestamp of when the resource was updated.

        • name

          Provider name

        • slug

          Provider name slug

      • covers object
        Hide covers attributes Show covers attributes object
        • uuid

          The UUID of the resource.

        • created_at

          The timestamp of when the resource was created.

        • updated_at

          The timestamp of when the resource was updated.

        • cover_type

          Cover type

        • benefit_amount

          Benefit amount

        • benefit_frequency

          Benefit frequency

        • benefit_status

          Benefit status

        • excess

          Excess

        • indexation

          Indexation percentage

      • claims object
        Hide claims attributes Show claims attributes object
        • uuid

          The UUID of the resource.

        • created_at

          The timestamp of when the resource was created.

        • updated_at

          The timestamp of when the resource was updated.

        • claim_amount

          Claim amount

        • claim_start_date

          Claim start date

        • claim_end_date

          Claim end date

        • claim_notes

          Claim notes

      • total_benefit_amount object
        Hide total_benefit_amount attributes Show total_benefit_amount attributes object
        • amount object
          Hide amount attributes Show amount attributes object
          • example string
          • description string
        • formatted object
          Hide formatted attributes Show formatted attributes object
          • example string
          • description string
        • currency object
          Hide currency attributes Show currency attributes object
          • example string
          • description string
      • total_benefits object
        Hide total_benefits attributes Show total_benefits attributes object
        • critical_illness object
          Hide critical_illness attributes Show critical_illness attributes object
          • amount object
            Hide amount attributes Show amount attributes object
            • example string
            • description string
          • formatted object
            Hide formatted attributes Show formatted attributes object
            • example string
            • description string
          • currency object
            Hide currency attributes Show currency attributes object
            • example string
            • description string
        • family_income_benefit object
          Hide family_income_benefit attributes Show family_income_benefit attributes object
          • amount object
            Hide amount attributes Show amount attributes object
            • example string
            • description string
          • formatted object
            Hide formatted attributes Show formatted attributes object
            • example string
            • description string
          • currency object
            Hide currency attributes Show currency attributes object
            • example string
            • description string
      • latest_valuations object
        Hide latest_valuations attributes Show latest_valuations attributes object
        • uuid

          The UUID of the resource.

        • created_at

          The timestamp of when the resource was created.

        • updated_at

          The timestamp of when the resource was updated.

        • valued_at

          Valued at

        • value

          Valuation

      • value object
        Hide value attributes Show value attributes object
        • amount object
          Hide amount attributes Show amount attributes object
          • example string
          • description string
        • formatted object
          Hide formatted attributes Show formatted attributes object
          • example string
          • description string
        • currency object
          Hide currency attributes Show currency attributes object
          • example string
          • description string
      • valued_at string
      • original_valued_at string
      • client object
        Hide client attributes Show client attributes object
        • uuid

          The UUID of the resource.

        • created_at

          The timestamp of when the resource was created.

        • updated_at

          The timestamp of when the resource was updated.

        • type

          Account type

        • role

          Account role

        • first_name

          First name

        • last_name

          Last name

        • name

          Name

        • email

          (Deprecated - Please use primary_email instead). The email of the account.

        • photo_url

          URL for initial avatar image

        • first_contact_date

          First contact date

        • next_review_date

          Next review date

        • previous_review_date

          Previous review date

        • anniversary_review_date

          Anniversary review date

        • terms_of_business_at

          Date the Terms of Business were agreed and signed

        • client_agreement_at

          Date the client agreement was agreed and signed

        • with_login

          Denotes whether the account has a login to Plannr

        • has_joint_account

          Denotes whether this account belongs to a joint account too

        • can_be_deleted

          Denotes if the account can be deleted

        • ownership_percentage

          Percentage ownership of the plan (This field is only present if viewing the account record via a plans relationship eg Plan -> Accounts)

        • inactive_at

          Inactive from date

        • last_interaction_at

          Last interaction date

        • referral_code

          Unique referral code for the employee account (employees only)

        • is_out_of_office

          Denotes whether the account is currently within an active Out of Office window (employees only)

        • out_of_office_from

          Start of the Out of Office period (employees only). Null when not out of office

        • out_of_office_until

          End of the Out of Office period (employees only). Null when not out of office

        • out_of_office_message

          Message shown to portal users while the account is Out of Office (employees only). Null when not out of office

        • is_pending_fact_find_account

          Denotes whether the account is a provisional account created by a fact find that has not yet been submitted (clients only)

        • permissions

          Permission map where keys are permission names and values are target arrays

      • accounts object
        Hide accounts attributes Show accounts attributes object
        • uuid

          The UUID of the resource.

        • created_at

          The timestamp of when the resource was created.

        • updated_at

          The timestamp of when the resource was updated.

        • type

          Account type

        • role

          Account role

        • first_name

          First name

        • last_name

          Last name

        • name

          Name

        • email

          (Deprecated - Please use primary_email instead). The email of the account.

        • photo_url

          URL for initial avatar image

        • first_contact_date

          First contact date

        • next_review_date

          Next review date

        • previous_review_date

          Previous review date

        • anniversary_review_date

          Anniversary review date

        • terms_of_business_at

          Date the Terms of Business were agreed and signed

        • client_agreement_at

          Date the client agreement was agreed and signed

        • with_login

          Denotes whether the account has a login to Plannr

        • has_joint_account

          Denotes whether this account belongs to a joint account too

        • can_be_deleted

          Denotes if the account can be deleted

        • ownership_percentage

          Percentage ownership of the plan (This field is only present if viewing the account record via a plans relationship eg Plan -> Accounts)

        • inactive_at

          Inactive from date

        • last_interaction_at

          Last interaction date

        • referral_code

          Unique referral code for the employee account (employees only)

        • is_out_of_office

          Denotes whether the account is currently within an active Out of Office window (employees only)

        • out_of_office_from

          Start of the Out of Office period (employees only). Null when not out of office

        • out_of_office_until

          End of the Out of Office period (employees only). Null when not out of office

        • out_of_office_message

          Message shown to portal users while the account is Out of Office (employees only). Null when not out of office

        • is_pending_fact_find_account

          Denotes whether the account is a provisional account created by a fact find that has not yet been submitted (clients only)

        • permissions

          Permission map where keys are permission names and values are target arrays

      • seller object
        Hide seller attributes Show seller attributes object
        • uuid

          The UUID of the resource.

        • created_at

          The timestamp of when the resource was created.

        • updated_at

          The timestamp of when the resource was updated.

        • type

          Account type

        • role

          Account role

        • first_name

          First name

        • last_name

          Last name

        • name

          Name

        • email

          (Deprecated - Please use primary_email instead). The email of the account.

        • photo_url

          URL for initial avatar image

        • first_contact_date

          First contact date

        • next_review_date

          Next review date

        • previous_review_date

          Previous review date

        • anniversary_review_date

          Anniversary review date

        • terms_of_business_at

          Date the Terms of Business were agreed and signed

        • client_agreement_at

          Date the client agreement was agreed and signed

        • with_login

          Denotes whether the account has a login to Plannr

        • has_joint_account

          Denotes whether this account belongs to a joint account too

        • can_be_deleted

          Denotes if the account can be deleted

        • ownership_percentage

          Percentage ownership of the plan (This field is only present if viewing the account record via a plans relationship eg Plan -> Accounts)

        • inactive_at

          Inactive from date

        • last_interaction_at

          Last interaction date

        • referral_code

          Unique referral code for the employee account (employees only)

        • is_out_of_office

          Denotes whether the account is currently within an active Out of Office window (employees only)

        • out_of_office_from

          Start of the Out of Office period (employees only). Null when not out of office

        • out_of_office_until

          End of the Out of Office period (employees only). Null when not out of office

        • out_of_office_message

          Message shown to portal users while the account is Out of Office (employees only). Null when not out of office

        • is_pending_fact_find_account

          Denotes whether the account is a provisional account created by a fact find that has not yet been submitted (clients only)

        • permissions

          Permission map where keys are permission names and values are target arrays

      • linked_owners object
        Hide linked_owners attributes Show linked_owners attributes object
        • uuid

          The UUID of the resource.

        • created_at

          The timestamp of when the resource was created.

        • updated_at

          The timestamp of when the resource was updated.

        • type

          Account type

        • role

          Account role

        • first_name

          First name

        • last_name

          Last name

        • name

          Name

        • email

          (Deprecated - Please use primary_email instead). The email of the account.

        • photo_url

          URL for initial avatar image

        • first_contact_date

          First contact date

        • next_review_date

          Next review date

        • previous_review_date

          Previous review date

        • anniversary_review_date

          Anniversary review date

        • terms_of_business_at

          Date the Terms of Business were agreed and signed

        • client_agreement_at

          Date the client agreement was agreed and signed

        • with_login

          Denotes whether the account has a login to Plannr

        • has_joint_account

          Denotes whether this account belongs to a joint account too

        • can_be_deleted

          Denotes if the account can be deleted

        • ownership_percentage

          Percentage ownership of the plan (This field is only present if viewing the account record via a plans relationship eg Plan -> Accounts)

        • inactive_at

          Inactive from date

        • last_interaction_at

          Last interaction date

        • referral_code

          Unique referral code for the employee account (employees only)

        • is_out_of_office

          Denotes whether the account is currently within an active Out of Office window (employees only)

        • out_of_office_from

          Start of the Out of Office period (employees only). Null when not out of office

        • out_of_office_until

          End of the Out of Office period (employees only). Null when not out of office

        • out_of_office_message

          Message shown to portal users while the account is Out of Office (employees only). Null when not out of office

        • is_pending_fact_find_account

          Denotes whether the account is a provisional account created by a fact find that has not yet been submitted (clients only)

        • permissions

          Permission map where keys are permission names and values are target arrays

      • linked_plans object
        Hide linked_plans attributes Show linked_plans attributes object
        • uuid

          The UUID of the resource.

        • created_at

          The timestamp of when the resource was created.

        • updated_at

          The timestamp of when the resource was updated.

        • opened_at

          Timestamp of when the plan was originally opened

        • name

          Name of the plan

        • type

          Type of plan, this will indicate what to expect from the fields attribute

        • sub_type

          Plan sub type

        • abstract_type

          describes if the plan is an asset, protection or liability

        • policy_number

          The policy number on the main sub account of the plan

        • proposal_reference

          The proposal reference on the main sub account of the plan

        • status

          Plan status

        • inactive_at

          Timestamp of when the plan became inactive

        • inactive_reason

          Reason for inactivity

        • agency_in_your_name

          Denotes if plan has agency in your name

        • agency_in_your_name_from

          Date the agency was in your name from

        • originally_sold_by_firm

          Denotes if the plan was originally sold by your firm

        • under_advice

          Denotes if plan is under advice

        • visible_on_client_portal

          Denotes if this plan is visible to clients on the client portal

        • include_in_client_valuation

          Denotes if this plan should be included in the client valuation

        • show_on_joint

          Denotes if this individual account can be seen when viewing joint plans on any joint accounts the individual client is a part of

        • shown_on_circles

          Determines if plan should be shown on a circle

        • review_date

          Review date

        • on_panel

          On panel

        • is_group_scheme

          Denotes if the plan is a group scheme plan. When a plan is a group scheme plan you will be able to manage group scheme members and sub schemes.

        • is_sub_group_scheme

          Denotes if the plan is a sub-scheme of a group scheme.

        • is_group_scheme_member

          Denotes if the plan is group scheme member plan. Each group scheme member is their own plan for maximum customisation.

        • advice_area

          The advice area of the plan based on the plan's sub type.

        • total_benefit_amount

          Total amount benefit of all covers

        • total_benefits

          Total benefits broken down in to cover types

        • value

          Total value of the plan

        • valued_at

          When the plan was last valued - Please note this is likely going to be the current date. If you would like to see the last real date it was valued by a provider or created manually, use original_valued_at

        • original_valued_at

          When the plan was originally valued - Please note our plans is valued daily but this is the date the valuation was originally added to the system.

        • statistics

          The statistics on a plan. Only displayed when you retrieve an individual plan

        • is_wrap_product

          Determines if the plan is a wrap plan

        • is_wrap_child

          Determines if the plan is a wrap child

        • can_be_deleted

          Denotes if the plan can be deleted

      • visible_to_circles object
        Hide visible_to_circles attributes Show visible_to_circles attributes object
        • uuid

          The UUID of the resource.

        • created_at

          The timestamp of when the resource was created.

        • updated_at

          The timestamp of when the resource was updated.

        • name

          The Circle name

        • photo_url

          URL for initial avatar image

        • bg_colour

          Hex colour background for avatar

        • has_portal_access

          Whether any member of the circle has portal access

        • portal_access_status

          Aggregated portal access status: active, never_logged_in, or no_portal_access

        • engagement_rating

          Aggregated engagement rating: green, amber, red, or none

        • last_login

          Most recent portal login across all circle members, including who logged in

        • portal_login_count_30d

          Total portal login count across all members in last 30 days

        • portal_login_count_90d

          Total portal login count across all members in last 90 days

        • portal_login_count_365d

          Total portal login count across all members in last 365 days

        • joint_account_uuid

          uuid of joint account where circle created from joint account

        • login_access_level

          The access level in context of an account. Note this field is only returned when using the accounts API. Available values: read and write

        • current_life_stage_uuid

          UUID of the circle's current life stage for expenditure

      • statistics object
        Hide statistics attribute Show statistics attribute object
        • recent_growth integer
      • cases object
        Hide cases attributes Show cases attributes object
        • uuid

          The UUID of the resource.

        • created_at

          The timestamp of when the resource was created.

        • updated_at

          The timestamp of when the resource was updated.

        • name

          Name of the case

        • slug

          Slug of the case

        • review_at

          Timestamp of when the case should be reviewed

        • assigned_to_uuids

          UUIDs of accounts that will be assigned to the case when it is created.

        • group_uuids

          UUIDs of groups that will be assigned when the case is created.

        • completed_at

          Timestamp of when the case was completed

        • value

          Expected value of this case

        • status_position

          The case status's position on the status list. Starting from 1. Only used if you are formatting cases in a kanban layout.

        • participants_count

          The number of participants on the case

        • task_board_uuid

          UUID of the task board

      • tags object
        Hide tags attributes Show tags attributes object
        • uuid

          UUID of the tag

        • created_at

          The timestamp of when the resource was created.

        • updated_at

          The timestamp of when the resource was updated.

        • name

          The name of the tag

        • slug

          The slug of the tag

        • colour

          The colour of the tag

      • is_wrap_product boolean
      • is_wrap_child boolean
      • wrap object
        Hide wrap attributes Show wrap attributes object
        • uuid

          The UUID of the resource.

        • created_at

          The timestamp of when the resource was created.

        • updated_at

          The timestamp of when the resource was updated.

        • opened_at

          Timestamp of when the plan was originally opened

        • name

          Name of the plan

        • type

          Type of plan, this will indicate what to expect from the fields attribute

        • sub_type

          Plan sub type

        • abstract_type

          describes if the plan is an asset, protection or liability

        • policy_number

          The policy number on the main sub account of the plan

        • proposal_reference

          The proposal reference on the main sub account of the plan

        • status

          Plan status

        • inactive_at

          Timestamp of when the plan became inactive

        • inactive_reason

          Reason for inactivity

        • agency_in_your_name

          Denotes if plan has agency in your name

        • agency_in_your_name_from

          Date the agency was in your name from

        • originally_sold_by_firm

          Denotes if the plan was originally sold by your firm

        • under_advice

          Denotes if plan is under advice

        • visible_on_client_portal

          Denotes if this plan is visible to clients on the client portal

        • include_in_client_valuation

          Denotes if this plan should be included in the client valuation

        • show_on_joint

          Denotes if this individual account can be seen when viewing joint plans on any joint accounts the individual client is a part of

        • shown_on_circles

          Determines if plan should be shown on a circle

        • review_date

          Review date

        • on_panel

          On panel

        • is_group_scheme

          Denotes if the plan is a group scheme plan. When a plan is a group scheme plan you will be able to manage group scheme members and sub schemes.

        • is_sub_group_scheme

          Denotes if the plan is a sub-scheme of a group scheme.

        • is_group_scheme_member

          Denotes if the plan is group scheme member plan. Each group scheme member is their own plan for maximum customisation.

        • advice_area

          The advice area of the plan based on the plan's sub type.

        • total_benefit_amount

          Total amount benefit of all covers

        • total_benefits

          Total benefits broken down in to cover types

        • value

          Total value of the plan

        • valued_at

          When the plan was last valued - Please note this is likely going to be the current date. If you would like to see the last real date it was valued by a provider or created manually, use original_valued_at

        • original_valued_at

          When the plan was originally valued - Please note our plans is valued daily but this is the date the valuation was originally added to the system.

        • statistics

          The statistics on a plan. Only displayed when you retrieve an individual plan

        • is_wrap_product

          Determines if the plan is a wrap plan

        • is_wrap_child

          Determines if the plan is a wrap child

        • can_be_deleted

          Denotes if the plan can be deleted

      • wrap_children object
        Hide wrap_children attributes Show wrap_children attributes object
        • uuid

          The UUID of the resource.

        • created_at

          The timestamp of when the resource was created.

        • updated_at

          The timestamp of when the resource was updated.

        • opened_at

          Timestamp of when the plan was originally opened

        • name

          Name of the plan

        • type

          Type of plan, this will indicate what to expect from the fields attribute

        • sub_type

          Plan sub type

        • abstract_type

          describes if the plan is an asset, protection or liability

        • policy_number

          The policy number on the main sub account of the plan

        • proposal_reference

          The proposal reference on the main sub account of the plan

        • status

          Plan status

        • inactive_at

          Timestamp of when the plan became inactive

        • inactive_reason

          Reason for inactivity

        • agency_in_your_name

          Denotes if plan has agency in your name

        • agency_in_your_name_from

          Date the agency was in your name from

        • originally_sold_by_firm

          Denotes if the plan was originally sold by your firm

        • under_advice

          Denotes if plan is under advice

        • visible_on_client_portal

          Denotes if this plan is visible to clients on the client portal

        • include_in_client_valuation

          Denotes if this plan should be included in the client valuation

        • show_on_joint

          Denotes if this individual account can be seen when viewing joint plans on any joint accounts the individual client is a part of

        • shown_on_circles

          Determines if plan should be shown on a circle

        • review_date

          Review date

        • on_panel

          On panel

        • is_group_scheme

          Denotes if the plan is a group scheme plan. When a plan is a group scheme plan you will be able to manage group scheme members and sub schemes.

        • is_sub_group_scheme

          Denotes if the plan is a sub-scheme of a group scheme.

        • is_group_scheme_member

          Denotes if the plan is group scheme member plan. Each group scheme member is their own plan for maximum customisation.

        • advice_area

          The advice area of the plan based on the plan's sub type.

        • total_benefit_amount

          Total amount benefit of all covers

        • total_benefits

          Total benefits broken down in to cover types

        • value

          Total value of the plan

        • valued_at

          When the plan was last valued - Please note this is likely going to be the current date. If you would like to see the last real date it was valued by a provider or created manually, use original_valued_at

        • original_valued_at

          When the plan was originally valued - Please note our plans is valued daily but this is the date the valuation was originally added to the system.

        • statistics

          The statistics on a plan. Only displayed when you retrieve an individual plan

        • is_wrap_product

          Determines if the plan is a wrap plan

        • is_wrap_child

          Determines if the plan is a wrap child

        • can_be_deleted

          Denotes if the plan can be deleted

      • linked_policy_numbers object
        Hide linked_policy_numbers attributes Show linked_policy_numbers attributes object
        • uuid

          The UUID of the resource.

        • created_at

          The timestamp of when the resource was created.

        • updated_at

          The timestamp of when the resource was updated.

        • linked_policy_number

          The linked policy number.

      • can_be_deleted string
      • contract_enquiry_account object
        Hide contract_enquiry_account attributes Show contract_enquiry_account attributes object
        • uuid

          The UUID of the resource.

        • created_at

          The timestamp of when the resource was created.

        • updated_at

          The timestamp of when the resource was updated.

        • type

          Account type

        • role

          Account role

        • first_name

          First name

        • last_name

          Last name

        • name

          Name

        • email

          (Deprecated - Please use primary_email instead). The email of the account.

        • photo_url

          URL for initial avatar image

        • first_contact_date

          First contact date

        • next_review_date

          Next review date

        • previous_review_date

          Previous review date

        • anniversary_review_date

          Anniversary review date

        • terms_of_business_at

          Date the Terms of Business were agreed and signed

        • client_agreement_at

          Date the client agreement was agreed and signed

        • with_login

          Denotes whether the account has a login to Plannr

        • has_joint_account

          Denotes whether this account belongs to a joint account too

        • can_be_deleted

          Denotes if the account can be deleted

        • ownership_percentage

          Percentage ownership of the plan (This field is only present if viewing the account record via a plans relationship eg Plan -> Accounts)

        • inactive_at

          Inactive from date

        • last_interaction_at

          Last interaction date

        • referral_code

          Unique referral code for the employee account (employees only)

        • is_out_of_office

          Denotes whether the account is currently within an active Out of Office window (employees only)

        • out_of_office_from

          Start of the Out of Office period (employees only). Null when not out of office

        • out_of_office_until

          End of the Out of Office period (employees only). Null when not out of office

        • out_of_office_message

          Message shown to portal users while the account is Out of Office (employees only). Null when not out of office

        • is_pending_fact_find_account

          Denotes whether the account is a provisional account created by a fact find that has not yet been submitted (clients only)

        • permissions

          Permission map where keys are permission names and values are target arrays

      • mortgage_product object
        Hide mortgage_product attributes Show mortgage_product attributes object
        • uuid

          The UUID of the resource.

        • created_at

          The timestamp of when the resource was created.

        • updated_at

          The timestamp of when the resource was updated.

        • provider_reference

          The provider reference for the mortgage product (if available)

        • provider_scenario_name

          The name of the scenario from the provider (if available)

        • provider_scenario_data

          Optional metadata from the mortgage provider

        • lender_name

          The name of the lender for the mortgage product

        • product_title

          The name of the mortgage product

      • custom_fields object
        Hide custom_fields attributes Show custom_fields attributes object
        • uuid

          The UUID of the custom field

        • created_at

          The timestamp of when the resource was created.

        • updated_at

          The timestamp of when the resource was updated.

        • type

          The type of custom field

        • name

          The name of the custom field

        • reference

          The reference of the custom field, used when updating the custom field on the model.

        • is_required

          Denotes if the custom field is required

        • value

          The value of the custom field

        • selection_options

          This is the array of available options for the selection box. If the type is "selection" this array will be provided.

        • help_text

          Optional help text to aide the custom field. Will be displayed on Plannr.

      • external_references object
        Hide external_references attributes Show external_references attributes object
        • uuid

          The UUID of the resource.

        • created_at

          The timestamp of when the resource was created.

        • updated_at

          The timestamp of when the resource was updated.

        • third_party

          The third party provider with the reference.

        • reference

          The third party reference.
  • 422 application/json

    Validation error

    Hide response attributes Show response attributes object
    • message string Required

      A human-readable description of the error.

    • errors object

      Validation messages keyed by the field that failed.

      Hide errors attribute Show errors attribute object
      • * array[string] Additional properties
POST /api/v2/plans/{plan_uuid}/linked-policy-numbers 
curl \
 --request POST 'https://api.plannrcrm.com/api/v2/plans/6ff8f7f6-1eb3-3525-be4a-3932c805afed/linked-policy-numbers' \
 --header "Authorization: Bearer $ACCESS_TOKEN" \
 --header "Content-Type: application/json" \
 --header "X-PLANNR-ACCOUNT-UUID: {YOUR_PLANNR_ACCOUNT_UUID}" \
 --data '{
  "linked_policy_number": "ABC123-X"
}'
Request examples 
# Headers
X-PLANNR-ACCOUNT-UUID: {YOUR_PLANNR_ACCOUNT_UUID}

# Payload
{
  "linked_policy_number": "ABC123-X"
}
Response examples (201) 
{
  "uuid": "bfb27c8c-4466-43fb-8765-a6e1af861053",
  "created_at": "2026-10-10T13:35:31+01:00",
  "updated_at": "2026-10-10T13:35:31+01:00",
  "linked_policy_number": "ABC123-X",
  "plan": {
    "uuid": "6aaa26c4-9a82-47be-a8f0-b6c4a0b5d56d",
    "created_at": "2026-10-10T13:35:31+01:00",
    "updated_at": "2026-10-10T13:35:31+01:00",
    "opened_at": "2026-10-10T13:35:31+01:00",
    "name": "Johns ISA",
    "type": "cash_account",
    "sub_type": "lifetime isa",
    "abstract_type": "asset",
    "policy_number": "AVIVA-123",
    "proposal_reference": "AB123456",
    "status": "inactive",
    "inactive_at": "2026-10-10T13:35:31+01:00",
    "inactive_reason": "claimed",
    "agency_in_your_name": true,
    "agency_in_your_name_from": "2025-10-10",
    "originally_sold_by_firm": true,
    "under_advice": true,
    "visible_on_client_portal": true,
    "include_in_client_valuation": true,
    "show_on_joint": true,
    "shown_on_circles": true,
    "review_date": "2025-10-10",
    "on_panel": true,
    "is_group_scheme": false,
    "is_sub_group_scheme": false,
    "is_group_scheme_member": false,
    "advice_area": "non_investment_insurance",
    "main_account": {
      "uuid": "49edeadb-40d0-418d-be4e-93610d1a94ae",
      "created_at": "2026-10-10T13:35:36+01:00",
      "updated_at": "2026-10-10T13:35:36+01:00",
      "name": "John's ISA",
      "policy_number": "AVI-4837",
      "is_main_account": false,
      "statistics": {
        "recent_growth": 100
      }
    },
    "sub_accounts": {
      "uuid": "49edeadb-40d0-418d-be4e-93610d1a94ae",
      "created_at": "2026-10-10T13:35:36+01:00",
      "updated_at": "2026-10-10T13:35:36+01:00",
      "name": "John's ISA",
      "policy_number": "AVI-4837",
      "is_main_account": false,
      "statistics": {
        "recent_growth": 100
      }
    },
    "provider": {
      "uuid": "7994c59b-82ea-44b6-9feb-b5f2084967de",
      "created_at": "2026-10-10T13:35:36+01:00",
      "updated_at": "2026-10-10T13:35:36+01:00",
      "name": "AJ Bell",
      "slug": "aj-bell"
    },
    "covers": {
      "uuid": "0765b92b-7e86-4c9d-96fd-8d2c9d1058ad",
      "created_at": "2026-10-10T13:35:36+01:00",
      "updated_at": "2026-10-10T13:35:36+01:00",
      "cover_type": "critical_illness",
      "benefit_amount": {
        "amount": {
          "example": "25000000",
          "description": "Money amount at their lowest denominator (for example: pennies)"
        },
        "formatted": {
          "example": "£250,000.00",
          "description": "Money amount formatted with currency"
        },
        "currency": {
          "example": null,
          "description": "Currency of the money"
        }
      },
      "benefit_frequency": "monthly",
      "benefit_status": "active",
      "excess": {
        "amount": {
          "example": "10000",
          "description": "Money amount at their lowest denominator (for example: pennies)"
        },
        "formatted": {
          "example": "£100.00",
          "description": "Money amount formatted with currency"
        },
        "currency": {
          "example": null,
          "description": "Currency of the money"
        }
      },
      "indexation": 1.4
    },
    "claims": {
      "uuid": "3be20f8f-6af5-4209-a37d-d202a487e954",
      "created_at": "2026-10-10T13:35:36+01:00",
      "updated_at": "2026-10-10T13:35:36+01:00",
      "claim_amount": {
        "amount": {
          "example": "25000000",
          "description": "Money amount at their lowest denominator (for example: pennies)"
        },
        "formatted": {
          "example": "£250,000.00",
          "description": "Money amount formatted with currency"
        },
        "currency": {
          "example": null,
          "description": "Currency of the money"
        }
      },
      "claim_start_date": "2025-10-10",
      "claim_end_date": "2031-10-10",
      "claim_notes": "Claim notes"
    },
    "total_benefit_amount": {
      "amount": {
        "example": "25000000",
        "description": "Money amount at their lowest denominator (for example: pennies)"
      },
      "formatted": {
        "example": "£250,000.00",
        "description": "Money amount formatted with currency"
      },
      "currency": {
        "example": "GBP",
        "description": "Currency of the money"
      }
    },
    "total_benefits": {
      "critical_illness": {
        "amount": {
          "example": "15000000",
          "description": "Money amount at their lowest denominator (for example: pennies)"
        },
        "formatted": {
          "example": "£150,000.00",
          "description": "Money amount formatted with currency"
        },
        "currency": {
          "example": "GBP",
          "description": "Currency of the money"
        }
      },
      "family_income_benefit": {
        "amount": {
          "example": "10000000",
          "description": "Money amount at their lowest denominator (for example: pennies)"
        },
        "formatted": {
          "example": "£100,000.00",
          "description": "Money amount formatted with currency"
        },
        "currency": {
          "example": "GBP",
          "description": "Currency of the money"
        }
      }
    },
    "latest_valuations": {
      "uuid": "62937344-2ab5-4d47-a650-682d1f74bc10",
      "created_at": "2026-10-10T13:35:36+01:00",
      "updated_at": "2026-10-10T13:35:36+01:00",
      "valued_at": "2026-10-10T13:35:36+01:00",
      "value": {
        "amount": {
          "example": "4000",
          "description": "Money amount at their lowest denominator (for example: pennies)"
        },
        "formatted": {
          "example": "£40.00",
          "description": "Money amount formatted with currency"
        },
        "currency": {
          "example": null,
          "description": "Currency of the money"
        }
      }
    },
    "value": {
      "amount": {
        "example": "4000",
        "description": "Money amount at their lowest denominator (for example: pennies)"
      },
      "formatted": {
        "example": "£40.00",
        "description": "Money amount formatted with currency"
      },
      "currency": {
        "example": "GBP",
        "description": "Currency of the money"
      }
    },
    "valued_at": "2026-10-10T13:35:31+01:00",
    "original_valued_at": "2026-10-09T13:35:31+01:00",
    "client": {
      "uuid": "2f073cb7-72a0-4d2c-b2c2-63b359ed6aad",
      "created_at": "2026-10-10T13:35:36+01:00",
      "updated_at": "2026-10-10T13:35:36+01:00",
      "type": "client",
      "role": "client",
      "first_name": "Gareth",
      "last_name": "Thompson",
      "name": "Gareth Thompson",
      "email": "gareth@codepotato.co.uk",
      "photo_url": "https://eu.ui-avatars.com/api/?name=gareth+thompson",
      "first_contact_date": "2026-10-10T13:35:36+01:00",
      "next_review_date": "2026-10-10T13:35:36+01:00",
      "previous_review_date": "2026-10-10T13:35:36+01:00",
      "anniversary_review_date": "2026-10-10T13:35:36+01:00",
      "terms_of_business_at": "2026-10-10T13:35:36+01:00",
      "client_agreement_at": "2026-10-10T13:35:36+01:00",
      "with_login": true,
      "has_joint_account": true,
      "can_be_deleted": "false",
      "ownership_percentage": 100.0,
      "inactive_at": "2026-10-10",
      "last_interaction_at": "2026-10-10 13:35:36",
      "referral_code": "ABC12345",
      "is_out_of_office": true,
      "out_of_office_from": "2026-10-10T13:35:36+01:00",
      "out_of_office_until": "2026-10-10T13:35:36+01:00",
      "out_of_office_message": "I am away this week. For urgent matters please contact the office.",
      "is_pending_fact_find_account": false,
      "permissions": {
        "firm:read": [
          "firm"
        ],
        "network:read": [
          "network:uuid"
        ]
      }
    },
    "accounts": {
      "uuid": "2f073cb7-72a0-4d2c-b2c2-63b359ed6aad",
      "created_at": "2026-10-10T13:35:36+01:00",
      "updated_at": "2026-10-10T13:35:36+01:00",
      "type": "client",
      "role": "client",
      "first_name": "Gareth",
      "last_name": "Thompson",
      "name": "Gareth Thompson",
      "email": "gareth@codepotato.co.uk",
      "photo_url": "https://eu.ui-avatars.com/api/?name=gareth+thompson",
      "first_contact_date": "2026-10-10T13:35:36+01:00",
      "next_review_date": "2026-10-10T13:35:36+01:00",
      "previous_review_date": "2026-10-10T13:35:36+01:00",
      "anniversary_review_date": "2026-10-10T13:35:36+01:00",
      "terms_of_business_at": "2026-10-10T13:35:36+01:00",
      "client_agreement_at": "2026-10-10T13:35:36+01:00",
      "with_login": true,
      "has_joint_account": true,
      "can_be_deleted": "false",
      "ownership_percentage": 100.0,
      "inactive_at": "2026-10-10",
      "last_interaction_at": "2026-10-10 13:35:36",
      "referral_code": "ABC12345",
      "is_out_of_office": true,
      "out_of_office_from": "2026-10-10T13:35:36+01:00",
      "out_of_office_until": "2026-10-10T13:35:36+01:00",
      "out_of_office_message": "I am away this week. For urgent matters please contact the office.",
      "is_pending_fact_find_account": false,
      "permissions": {
        "firm:read": [
          "firm"
        ],
        "network:read": [
          "network:uuid"
        ]
      }
    },
    "seller": {
      "uuid": "2f073cb7-72a0-4d2c-b2c2-63b359ed6aad",
      "created_at": "2026-10-10T13:35:36+01:00",
      "updated_at": "2026-10-10T13:35:36+01:00",
      "type": "client",
      "role": "client",
      "first_name": "Gareth",
      "last_name": "Thompson",
      "name": "Gareth Thompson",
      "email": "gareth@codepotato.co.uk",
      "photo_url": "https://eu.ui-avatars.com/api/?name=gareth+thompson",
      "first_contact_date": "2026-10-10T13:35:36+01:00",
      "next_review_date": "2026-10-10T13:35:36+01:00",
      "previous_review_date": "2026-10-10T13:35:36+01:00",
      "anniversary_review_date": "2026-10-10T13:35:36+01:00",
      "terms_of_business_at": "2026-10-10T13:35:36+01:00",
      "client_agreement_at": "2026-10-10T13:35:36+01:00",
      "with_login": true,
      "has_joint_account": true,
      "can_be_deleted": "false",
      "ownership_percentage": 100.0,
      "inactive_at": "2026-10-10",
      "last_interaction_at": "2026-10-10 13:35:36",
      "referral_code": "ABC12345",
      "is_out_of_office": true,
      "out_of_office_from": "2026-10-10T13:35:36+01:00",
      "out_of_office_until": "2026-10-10T13:35:36+01:00",
      "out_of_office_message": "I am away this week. For urgent matters please contact the office.",
      "is_pending_fact_find_account": false,
      "permissions": {
        "firm:read": [
          "firm"
        ],
        "network:read": [
          "network:uuid"
        ]
      }
    },
    "linked_owners": {
      "uuid": "2f073cb7-72a0-4d2c-b2c2-63b359ed6aad",
      "created_at": "2026-10-10T13:35:36+01:00",
      "updated_at": "2026-10-10T13:35:36+01:00",
      "type": "client",
      "role": "client",
      "first_name": "Gareth",
      "last_name": "Thompson",
      "name": "Gareth Thompson",
      "email": "gareth@codepotato.co.uk",
      "photo_url": "https://eu.ui-avatars.com/api/?name=gareth+thompson",
      "first_contact_date": "2026-10-10T13:35:36+01:00",
      "next_review_date": "2026-10-10T13:35:36+01:00",
      "previous_review_date": "2026-10-10T13:35:36+01:00",
      "anniversary_review_date": "2026-10-10T13:35:36+01:00",
      "terms_of_business_at": "2026-10-10T13:35:36+01:00",
      "client_agreement_at": "2026-10-10T13:35:36+01:00",
      "with_login": true,
      "has_joint_account": true,
      "can_be_deleted": "false",
      "ownership_percentage": 100.0,
      "inactive_at": "2026-10-10",
      "last_interaction_at": "2026-10-10 13:35:36",
      "referral_code": "ABC12345",
      "is_out_of_office": true,
      "out_of_office_from": "2026-10-10T13:35:36+01:00",
      "out_of_office_until": "2026-10-10T13:35:36+01:00",
      "out_of_office_message": "I am away this week. For urgent matters please contact the office.",
      "is_pending_fact_find_account": false,
      "permissions": {
        "firm:read": [
          "firm"
        ],
        "network:read": [
          "network:uuid"
        ]
      }
    },
    "linked_plans": {
      "uuid": "127b225b-eed9-4ca0-bdbf-ea3b444eeb84",
      "created_at": "2026-10-10T13:35:36+01:00",
      "updated_at": "2026-10-10T13:35:36+01:00",
      "opened_at": "2026-10-10T13:35:36+01:00",
      "name": "Johns ISA",
      "type": "cash_account",
      "sub_type": "lifetime isa",
      "abstract_type": "asset",
      "policy_number": "AVIVA-123",
      "proposal_reference": "AB123456",
      "status": "inactive",
      "inactive_at": "2026-10-10T13:35:36+01:00",
      "inactive_reason": "claimed",
      "agency_in_your_name": true,
      "agency_in_your_name_from": "2025-10-10",
      "originally_sold_by_firm": true,
      "under_advice": true,
      "visible_on_client_portal": true,
      "include_in_client_valuation": true,
      "show_on_joint": true,
      "shown_on_circles": true,
      "review_date": "2025-10-10",
      "on_panel": true,
      "is_group_scheme": false,
      "is_sub_group_scheme": false,
      "is_group_scheme_member": false,
      "advice_area": "non_investment_insurance",
      "total_benefit_amount": {
        "amount": {
          "example": "25000000",
          "description": "Money amount at their lowest denominator (for example: pennies)"
        },
        "formatted": {
          "example": "£250,000.00",
          "description": "Money amount formatted with currency"
        },
        "currency": {
          "example": null,
          "description": "Currency of the money"
        }
      },
      "total_benefits": {
        "critical_illness": {
          "amount": {
            "example": "15000000",
            "description": "Money amount at their lowest denominator (for example: pennies)"
          },
          "formatted": {
            "example": "£150,000.00",
            "description": "Money amount formatted with currency"
          },
          "currency": {
            "example": null,
            "description": "Currency of the money"
          }
        },
        "family_income_benefit": {
          "amount": {
            "example": "10000000",
            "description": "Money amount at their lowest denominator (for example: pennies)"
          },
          "formatted": {
            "example": "£100,000.00",
            "description": "Money amount formatted with currency"
          },
          "currency": {
            "example": null,
            "description": "Currency of the money"
          }
        }
      },
      "value": {
        "amount": {
          "example": "4000",
          "description": "Money amount at their lowest denominator (for example: pennies)"
        },
        "formatted": {
          "example": "£40.00",
          "description": "Money amount formatted with currency"
        },
        "currency": {
          "example": null,
          "description": "Currency of the money"
        }
      },
      "valued_at": "2026-10-10T13:35:36+01:00",
      "original_valued_at": "2026-10-09T13:35:36+01:00",
      "statistics": {
        "recent_growth": 100
      },
      "is_wrap_product": false,
      "is_wrap_child": false,
      "can_be_deleted": "false"
    },
    "visible_to_circles": {
      "uuid": "10b75e34-0b87-46a0-a4cb-70478c1df81a",
      "created_at": "2026-10-10T13:35:36+01:00",
      "updated_at": "2026-10-10T13:35:36+01:00",
      "name": "Jones Family",
      "photo_url": "https://eu.ui-avatars.com/api/?name=jones+family",
      "bg_colour": "#35f4e1",
      "has_portal_access": true,
      "portal_access_status": "active",
      "engagement_rating": "green",
      "last_login": {
        "logged_in_at": "2026-10-10T13:35:36+01:00",
        "account_uuid": "uuid",
        "account_name": "John Smith",
        "device_type": "desktop",
        "device_platform": "macos"
      },
      "portal_login_count_30d": 5,
      "portal_login_count_90d": 12,
      "portal_login_count_365d": 48,
      "joint_account_uuid": "7d6c5ae5-54ee-48b2-b32f-6869ceac3713",
      "login_access_level": "write",
      "current_life_stage_uuid": "24d07bb8-b6e3-43ea-963f-dceb43560eec"
    },
    "statistics": {
      "recent_growth": 100
    },
    "cases": {
      "uuid": "4ee2ee74-8868-45cc-9b32-63dbb3478d7a",
      "created_at": "2026-10-10T13:35:36+01:00",
      "updated_at": "2026-10-10T13:35:36+01:00",
      "name": "finance",
      "slug": "finance",
      "review_at": "2026-10-10T13:35:36+01:00",
      "assigned_to_uuids": [
        null
      ],
      "group_uuids": [
        null
      ],
      "completed_at": "2026-10-10T13:35:36+01:00",
      "value": {
        "amount": {
          "example": "4000",
          "description": "Money amount at their lowest denominator (for example: pennies)"
        },
        "formatted": {
          "example": "£40.00",
          "description": "Money amount formatted with currency"
        },
        "currency": {
          "example": null,
          "description": "Currency of the money"
        }
      },
      "status_position": 4,
      "participants_count": 4,
      "task_board_uuid": null
    },
    "tags": {
      "uuid": "d373c476-c9c1-4b03-8b67-56d65c659376",
      "created_at": "2026-10-10T13:35:36+01:00",
      "updated_at": "2026-10-10T13:35:36+01:00",
      "name": "Mortgage",
      "slug": "mortgage",
      "colour": "#ef4582"
    },
    "is_wrap_product": false,
    "is_wrap_child": false,
    "wrap": {
      "uuid": "127b225b-eed9-4ca0-bdbf-ea3b444eeb84",
      "created_at": "2026-10-10T13:35:36+01:00",
      "updated_at": "2026-10-10T13:35:36+01:00",
      "opened_at": "2026-10-10T13:35:36+01:00",
      "name": "Johns ISA",
      "type": "cash_account",
      "sub_type": "lifetime isa",
      "abstract_type": "asset",
      "policy_number": "AVIVA-123",
      "proposal_reference": "AB123456",
      "status": "inactive",
      "inactive_at": "2026-10-10T13:35:36+01:00",
      "inactive_reason": "claimed",
      "agency_in_your_name": true,
      "agency_in_your_name_from": "2025-10-10",
      "originally_sold_by_firm": true,
      "under_advice": true,
      "visible_on_client_portal": true,
      "include_in_client_valuation": true,
      "show_on_joint": true,
      "shown_on_circles": true,
      "review_date": "2025-10-10",
      "on_panel": true,
      "is_group_scheme": false,
      "is_sub_group_scheme": false,
      "is_group_scheme_member": false,
      "advice_area": "non_investment_insurance",
      "total_benefit_amount": {
        "amount": {
          "example": "25000000",
          "description": "Money amount at their lowest denominator (for example: pennies)"
        },
        "formatted": {
          "example": "£250,000.00",
          "description": "Money amount formatted with currency"
        },
        "currency": {
          "example": null,
          "description": "Currency of the money"
        }
      },
      "total_benefits": {
        "critical_illness": {
          "amount": {
            "example": "15000000",
            "description": "Money amount at their lowest denominator (for example: pennies)"
          },
          "formatted": {
            "example": "£150,000.00",
            "description": "Money amount formatted with currency"
          },
          "currency": {
            "example": null,
            "description": "Currency of the money"
          }
        },
        "family_income_benefit": {
          "amount": {
            "example": "10000000",
            "description": "Money amount at their lowest denominator (for example: pennies)"
          },
          "formatted": {
            "example": "£100,000.00",
            "description": "Money amount formatted with currency"
          },
          "currency": {
            "example": null,
            "description": "Currency of the money"
          }
        }
      },
      "value": {
        "amount": {
          "example": "4000",
          "description": "Money amount at their lowest denominator (for example: pennies)"
        },
        "formatted": {
          "example": "£40.00",
          "description": "Money amount formatted with currency"
        },
        "currency": {
          "example": null,
          "description": "Currency of the money"
        }
      },
      "valued_at": "2026-10-10T13:35:36+01:00",
      "original_valued_at": "2026-10-09T13:35:36+01:00",
      "statistics": {
        "recent_growth": 100
      },
      "is_wrap_product": false,
      "is_wrap_child": false,
      "can_be_deleted": "false"
    },
    "wrap_children": {
      "uuid": "127b225b-eed9-4ca0-bdbf-ea3b444eeb84",
      "created_at": "2026-10-10T13:35:36+01:00",
      "updated_at": "2026-10-10T13:35:36+01:00",
      "opened_at": "2026-10-10T13:35:36+01:00",
      "name": "Johns ISA",
      "type": "cash_account",
      "sub_type": "lifetime isa",
      "abstract_type": "asset",
      "policy_number": "AVIVA-123",
      "proposal_reference": "AB123456",
      "status": "inactive",
      "inactive_at": "2026-10-10T13:35:36+01:00",
      "inactive_reason": "claimed",
      "agency_in_your_name": true,
      "agency_in_your_name_from": "2025-10-10",
      "originally_sold_by_firm": true,
      "under_advice": true,
      "visible_on_client_portal": true,
      "include_in_client_valuation": true,
      "show_on_joint": true,
      "shown_on_circles": true,
      "review_date": "2025-10-10",
      "on_panel": true,
      "is_group_scheme": false,
      "is_sub_group_scheme": false,
      "is_group_scheme_member": false,
      "advice_area": "non_investment_insurance",
      "total_benefit_amount": {
        "amount": {
          "example": "25000000",
          "description": "Money amount at their lowest denominator (for example: pennies)"
        },
        "formatted": {
          "example": "£250,000.00",
          "description": "Money amount formatted with currency"
        },
        "currency": {
          "example": null,
          "description": "Currency of the money"
        }
      },
      "total_benefits": {
        "critical_illness": {
          "amount": {
            "example": "15000000",
            "description": "Money amount at their lowest denominator (for example: pennies)"
          },
          "formatted": {
            "example": "£150,000.00",
            "description": "Money amount formatted with currency"
          },
          "currency": {
            "example": null,
            "description": "Currency of the money"
          }
        },
        "family_income_benefit": {
          "amount": {
            "example": "10000000",
            "description": "Money amount at their lowest denominator (for example: pennies)"
          },
          "formatted": {
            "example": "£100,000.00",
            "description": "Money amount formatted with currency"
          },
          "currency": {
            "example": null,
            "description": "Currency of the money"
          }
        }
      },
      "value": {
        "amount": {
          "example": "4000",
          "description": "Money amount at their lowest denominator (for example: pennies)"
        },
        "formatted": {
          "example": "£40.00",
          "description": "Money amount formatted with currency"
        },
        "currency": {
          "example": null,
          "description": "Currency of the money"
        }
      },
      "valued_at": "2026-10-10T13:35:36+01:00",
      "original_valued_at": "2026-10-09T13:35:36+01:00",
      "statistics": {
        "recent_growth": 100
      },
      "is_wrap_product": false,
      "is_wrap_child": false,
      "can_be_deleted": "false"
    },
    "linked_policy_numbers": {
      "uuid": "0d7fe623-7924-42b0-83d0-434a5727af77",
      "created_at": "2026-10-10T13:35:36+01:00",
      "updated_at": "2026-10-10T13:35:36+01:00",
      "linked_policy_number": "ABC123-X"
    },
    "can_be_deleted": "false",
    "contract_enquiry_account": {
      "uuid": "2f073cb7-72a0-4d2c-b2c2-63b359ed6aad",
      "created_at": "2026-10-10T13:35:36+01:00",
      "updated_at": "2026-10-10T13:35:36+01:00",
      "type": "client",
      "role": "client",
      "first_name": "Gareth",
      "last_name": "Thompson",
      "name": "Gareth Thompson",
      "email": "gareth@codepotato.co.uk",
      "photo_url": "https://eu.ui-avatars.com/api/?name=gareth+thompson",
      "first_contact_date": "2026-10-10T13:35:36+01:00",
      "next_review_date": "2026-10-10T13:35:36+01:00",
      "previous_review_date": "2026-10-10T13:35:36+01:00",
      "anniversary_review_date": "2026-10-10T13:35:36+01:00",
      "terms_of_business_at": "2026-10-10T13:35:36+01:00",
      "client_agreement_at": "2026-10-10T13:35:36+01:00",
      "with_login": true,
      "has_joint_account": true,
      "can_be_deleted": "false",
      "ownership_percentage": 100.0,
      "inactive_at": "2026-10-10",
      "last_interaction_at": "2026-10-10 13:35:36",
      "referral_code": "ABC12345",
      "is_out_of_office": true,
      "out_of_office_from": "2026-10-10T13:35:36+01:00",
      "out_of_office_until": "2026-10-10T13:35:36+01:00",
      "out_of_office_message": "I am away this week. For urgent matters please contact the office.",
      "is_pending_fact_find_account": false,
      "permissions": {
        "firm:read": [
          "firm"
        ],
        "network:read": [
          "network:uuid"
        ]
      }
    },
    "mortgage_product": {
      "uuid": "044cc088-2b1f-4ec3-af9e-dcf937aab38c",
      "created_at": "2026-10-10T13:35:36+01:00",
      "updated_at": "2026-10-10T13:35:36+01:00",
      "provider_reference": "example-reference",
      "provider_scenario_name": "Single Applicant, Small Deposit",
      "provider_scenario_data": [],
      "lender_name": "HSBC",
      "product_title": "5% Fixed Rate - 5 year"
    },
    "custom_fields": {
      "uuid": null,
      "created_at": "2026-10-10T13:35:36+01:00",
      "updated_at": "2026-10-10T13:35:36+01:00",
      "type": "string",
      "name": "Favourite Drink",
      "reference": "favourite_drink",
      "is_required": false,
      "value": "Coffee",
      "selection_options": [
        "Coffee",
        "Tea",
        "Water"
      ],
      "help_text": "This is the client's favourite drink."
    },
    "external_references": {
      "uuid": "512f5d20-d183-4ca0-aa26-cb810dfb62d1",
      "created_at": "2026-10-10T13:35:36+01:00",
      "updated_at": "2026-10-10T13:35:36+01:00",
      "third_party": "nucleus",
      "reference": "AB123456"
    }
  }
}
Response examples (422) 
{
  "message": "The given data was invalid.",
  "errors": {
    "field": [
      "The field is invalid."
    ]
  }
}