Create a conversation with inline files 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/v1/conversation/inline
Personal access token & O auth2

Used to create a conversation and upload files as part of the first message at the same time.

Headers

  • X-PLANNR-ACCOUNT-UUID string
application/json

Body

  • name string Required

    Conversation title

  • case string(uuid)

    Case UUID to assign this conversation to

  • participants array[string(uuid)]

    Account UUIDs belonging to the firm

  • message string

    Contents of first message to be created alongside the conversation.

  • files array[string(uuid)]

    File UUIDs to attach to the first message of the conversation.

Responses

  • 200 application/json
    Hide response attributes Show response attributes object
    • uuid string
    • created_at string
    • updated_at string
    • name string
    • slug string
    • belongs_to_case boolean
    • case object
      Hide case attributes Show case attributes object
      • uuid string
      • created_at string
      • updated_at string
      • name string
      • slug string
      • status object
        Hide status attributes Show status 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 name of the status.

        • colour

          The colour of the status.

        • position

          The position of the status.

        • is_type_completed

          Indicates if the status is for a completed case type.

      • type object
        Hide type attributes Show type attributes object
        • uuid

          The UUID of the type

        • name

          Name of the type

        • created_at

          The timestamp of when the resource was created.

        • updated_at

          The timestamp of when the resource was updated.

      • review_at string
      • assigned_to_uuids array[string]
      • group_uuids array[string]
      • completed_at string
      • 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
      • status_position integer
      • participants_count integer
      • participants object
        Hide participants attributes Show participants 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

        • managed_by_head_office

          Whether head office set this employee's firm role from their enterprise role. The firm can add restrictions on top but cannot change or remove the role itself.

      • task_board_uuid string
      • plans object
        Hide plans attributes Show 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

      • 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.

    • participants_count integer
    • participants array[object]
      Hide participants attributes Show participants attributes object
      • uuid string
      • created_at string
      • updated_at string
      • type string
      • role string
      • first_name string
      • last_name string
      • name string
      • email string
      • photo_url string
      • firm object
        Hide firm attributes Show firm 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 firm

        • slug

          Slug of the firm

        • address_1

          First line of the address

        • address_2

          Second line of the address

        • town_city

          Town/City

        • county

          County

        • postcode

          Postcode

        • country

          Country

        • regulatory_text

          Regulatory text of the firm.

        • logo_icon

          URL of your firm logo icon.

        • brand_colours

          Firm branding colours.

        • factfind_pdf_header_background

          Header background colour (hex) for the fact-find snapshot PDF.

        • factfind_pdf_header_text

          Header text colour (hex) for the fact-find snapshot PDF.

        • is_subscribed

          Subscription status.

        • keep_deleted_files_for

          Number of days to keep deleted files for

        • tax

          Tax percent

        • month_end

          Date of the month for the monthly income reconciliation statements to end

        • statement_frequency

          The frequency of the income reconciliation statements

        • billing

          Firm invoice details for billing

        • ip_whitelist

          IP addresses allowed to access the firm. Authorised Plannr-issued integrations are exempt.

        • welcome_paragraph_html

          Custom welcome paragraph html for the branded auth welcome page

        • email_welcome_paragraph_html

          Custom welcome paragraph for the welcome/new user email

        • show_fact_find_illustrations

          Determines if the illustrations/graphics are displayed on the fact find.

        • cc_email_addresses

          Array of email cc addresses.

        • bcc_email_addresses

          Array of email bcc addresses.

        • reply_to_email_address

          Firm reply to email address.

        • mobile_app_support_number

          Firm mobile app support number.

        • mobile_app_support_email

          Firm mobile app support email address.

      • primary_phone_number object
        Hide primary_phone_number attributes Show primary_phone_number 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

          Contact detail type

        • name

          Contact detail description

        • value

          Contact detail value

        • phone_number_meta

          If the type is a phone number, this additional field will be displayed giving you information about the phone number.

      • primary_email object
        Hide primary_email attributes Show primary_email 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

          Contact detail type

        • name

          Contact detail description

        • value

          Contact detail value

        • phone_number_meta

          If the type is a phone number, this additional field will be displayed giving you information about the phone number.

      • current_time_entry object
        Hide current_time_entry attributes Show current_time_entry 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 name of the time entry.

        • description

          The description of the time entry.

        • trackable_type

          The model type that is being tracked. The example given is a client, but it can be a case, firm, circle or task.

        • start_date

          The start time of the time entry.

        • end_date

          The end time of the time entry.

        • is_active

          Determines if the time entry is currently ongoing.

        • total_time_in_minutes

          Total time in minutes.

        • computed_time_elapsed_in_seconds

          Computed time elapsed in seconds.

      • assigned_adviser object
        Hide assigned_adviser attributes Show assigned_adviser 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

        • managed_by_head_office

          Whether head office set this employee's firm role from their enterprise role. The firm can add restrictions on top but cannot change or remove the role itself.

      • assigned_administrator object
        Hide assigned_administrator attributes Show assigned_administrator 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

        • managed_by_head_office

          Whether head office set this employee's firm role from their enterprise role. The firm can add restrictions on top but cannot change or remove the role itself.

      • assigned_paraplanner object
        Hide assigned_paraplanner attributes Show assigned_paraplanner 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

        • managed_by_head_office

          Whether head office set this employee's firm role from their enterprise role. The firm can add restrictions on top but cannot change or remove the role itself.

      • introduced_by object
        Hide introduced_by attributes Show introduced_by 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

        • managed_by_head_office

          Whether head office set this employee's firm role from their enterprise role. The firm can add restrictions on top but cannot change or remove the role itself.

      • business_unit object
        Hide business_unit attributes Show business_unit attributes object
        • uuid

          The UUID of the resource.

        • name

          Name of the business unit.

        • has_alternative_branding

          Whether alternative branding is enabled for this business unit.

        • brand_colours

          Brand colours for this business unit, merged with firm defaults.

        • members_count

          Number of accounts assigned to this business unit

        • groups_count

          Number of groups assigned to this business unit

        • created_at

          The timestamp of when the resource was created.

        • updated_at

          The timestamp of when the resource was updated.

      • groups object
        Hide groups attributes Show groups attributes object
        • uuid

          UUID of the group

        • name

          Name of the group

        • slug

          Slug of the group

        • participants_count

          Number of participants in the group

        • participants

          Participants in this group

        • created_at

          Timestamp of when the group was created

        • updated_at

          Timestamp of when the group was updated

      • 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

      • marketing_consent object
        Hide marketing_consent attributes Show marketing_consent attributes object
        • email

          Marketing consent status for email. One of not_captured, opted_in and opted_out

        • phone

          Marketing consent status for phone. One of not_captured, opted_in and opted_out

        • letter

          Marketing consent status for letter. One of not_captured, opted_in and opted_out

        • sms

          Marketing consent status for SMS. One of not_captured, opted_in and opted_out

      • owners object
        Hide owners attributes Show 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

        • managed_by_head_office

          Whether head office set this employee's firm role from their enterprise role. The firm can add restrictions on top but cannot change or remove the role itself.

      • first_contact_date string
      • next_review_date string
      • previous_review_date string
      • anniversary_review_date string
      • terms_of_business_at string
      • client_agreement_at string
      • with_login boolean
      • has_joint_account boolean
      • can_be_deleted string
      • joint_account_circle object
        Hide joint_account_circle attributes Show joint_account_circle 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

      • circles object
        Hide circles attributes Show 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

      • ownership_percentage integer
      • inactive_at string
      • last_interaction_at string
      • referral_code string
      • is_out_of_office boolean
      • out_of_office_from string
      • out_of_office_until string
      • out_of_office_message string
      • service_level object
        Hide service_level attributes Show service_level attributes object
        • uuid

          The UUID of the resource.

        • name

          The name of the service level.

        • created_at

          The timestamp of when the resource was created.

        • updated_at

          The timestamp of when the resource was updated.

      • is_pending_fact_find_account boolean
      • permissions object
        Hide permissions attributes Show permissions attributes object
        • firm:read array[string]
        • network:read array[string]
      • managed_by_head_office boolean
      • 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.

    • latest_message object
      Hide latest_message attributes Show latest_message attributes object
      • uuid string
      • created_at string
      • updated_at string
      • deleted_at string
      • contents string
      • edited boolean
      • is_auto_reply boolean
      • files object
        Hide files attributes Show files attributes object
        • uuid

          UUID of the file

        • created_at

          The timestamp of when the resource was created.

        • original_created_at

          Timestamp of when the file was originally created

        • updated_at

          The timestamp of when the resource was updated.

        • uploaded_at

          Timestamp of when the file was uploaded

        • status

          Current status of the uploading progress

        • filename

          The filename including extension

        • name

          The name of the file without extension

        • extension

          The extension of the file

        • type

          The MIME type of the file

        • size

          The size of the file in bytes

        • path

          The path of the file

        • last_modified

          Timestamp of when the file was last modified before uploading

        • progress

          The progress of the uploaded file as a percentage between 0 and 100

        • download_url

          The download URL of the file

        • preview_url

          The URL to preview the file inline in the browser. Only present for images and PDFs within the preview size limit

        • folder_name

          The name of the folder the file is located in

        • documentable_type

          The documentable type such as account/plan/case/etc the file was uploaded to

        • documentable

          The documentable the file was uploaded to

        • navigator

          The documentable type and its UUID in order to navigator to the correct resource

      • author object
        Hide author attributes Show author 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

        • managed_by_head_office

          Whether head office set this employee's firm role from their enterprise role. The firm can add restrictions on top but cannot change or remove the role itself.

      • user object
        Hide user attributes Show user 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

          The user type

        • first_name

          First name of the user

        • last_name

          Last name of the user

        • name

          Name of the user

        • email

          Email of the user

        • photo_url

          The photo URL of the user.

        • two_factor_enabled

          Denotes if the two factor authentication has been enabled.

        • two_factor_setup_required

          Denotes if the user must set up two factor authentication before they can access their current account, because the firm or its network enforces it.

        • two_factor_type

          The type of two factor enabled.

        • otp_confirmed_at

          The date when OTP two factor was confirmed

        • otp_pending

          Denotes if the OTP two factor is pending

        • sms_two_factor_enabled

          Denotes if the SMS two factor is enabled

        • two_factor_mobile

          The E.164 mobile phone used for two factor authentication.

        • two_factor_mobile_meta

          If the two_factor_mobile is present, this additional field will be displayed giving you information about the phone number.

        • session_expires_at

          The session expiry time if signed in via the front-end.

        • remember_token_expires_at

          Denotes when the users "remember me" token expires.

        • should_auto_save_notes

          Denotes if the user wants to use the auto-save notes feature. Can reduce browser performance on low-powered machines.

      • reactions object
        Hide reactions attributes Show reactions 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.

        • account_uuid

          The UUID of the account that reacted

        • account_name

          The name of the account that reacted

        • reaction

          The reaction type

    • messages_count integer
    • files_count integer
    • tags array[object]
      Hide tags attributes Show tags attributes object
      • uuid string
      • created_at string
      • updated_at string
      • name string
      • slug string
      • colour string
    • pinned boolean
    • is_admin boolean
  • 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/v1/conversation/inline 
curl \
 --request POST 'https://api.plannrcrm.com/api/v1/conversation/inline' \
 --header "Authorization: Bearer $ACCESS_TOKEN" \
 --header "Content-Type: application/json" \
 --header "X-PLANNR-ACCOUNT-UUID: {YOUR_PLANNR_ACCOUNT_UUID}" \
 --data '{
  "name": "Annual Review",
  "case": "0eface13-7108-424b-8d93-cf81a0aee03a",
  "participants": [
    "3137d725-8074-4696-8253-62aee23df4da",
    "626501e1-633e-484a-84a6-9324fea65f84",
    "b7a017d6-5cdc-4c80-a1c3-35bb685758f9"
  ],
  "message": "Hello world!",
  "files": [
    "2973635e-7a19-49c2-8074-965e9281eabf",
    "a4b66880-9588-450f-b269-b1140a0170d4",
    "e4b52b2a-2184-4685-9d18-fcdad5af23f2"
  ]
}'
Request examples 
# Headers
X-PLANNR-ACCOUNT-UUID: {YOUR_PLANNR_ACCOUNT_UUID}

# Payload
{
  "name": "Annual Review",
  "case": "0eface13-7108-424b-8d93-cf81a0aee03a",
  "participants": [
    "3137d725-8074-4696-8253-62aee23df4da",
    "626501e1-633e-484a-84a6-9324fea65f84",
    "b7a017d6-5cdc-4c80-a1c3-35bb685758f9"
  ],
  "message": "Hello world!",
  "files": [
    "2973635e-7a19-49c2-8074-965e9281eabf",
    "a4b66880-9588-450f-b269-b1140a0170d4",
    "e4b52b2a-2184-4685-9d18-fcdad5af23f2"
  ]
}
Response examples (200) 
{
  "uuid": "ea7a7b8b-a05f-4c5f-832f-5cd8108d7c51",
  "created_at": "2026-11-04T13:17:27+00:00",
  "updated_at": "2026-11-04T13:17:27+00:00",
  "name": "Welcome to Plannr",
  "slug": "welcome-to-plannr",
  "belongs_to_case": true,
  "case": {
    "uuid": "befcb1af-bc6b-43b7-a859-6875523e084d",
    "created_at": "2026-11-04T13:17:27+00:00",
    "updated_at": "2026-11-04T13:17:27+00:00",
    "name": "finance",
    "slug": "finance",
    "status": {
      "uuid": "42c37c63-94ec-4754-b2a2-18af2956bd46",
      "created_at": "2026-11-04T13:17:36+00:00",
      "updated_at": "2026-11-04T13:17:36+00:00",
      "name": "To Be Reviewed",
      "colour": "#23852B",
      "position": 5,
      "is_type_completed": false
    },
    "type": {
      "uuid": null,
      "name": "Mortgage Plan",
      "created_at": "2026-11-04T13:17:36+00:00",
      "updated_at": "2026-11-04T13:17:36+00:00"
    },
    "review_at": "2026-11-04T13:17:27+00:00",
    "assigned_to_uuids": [
      "3c96f6c9-4042-4bbd-ba54-a01b9cc8d23d"
    ],
    "group_uuids": [
      "a3584cfa-b125-4934-a12f-89c08d45e169"
    ],
    "completed_at": "2026-11-04T13:17:27+00: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": "GBP",
        "description": "Currency of the money"
      }
    },
    "status_position": 4,
    "participants_count": 4,
    "participants": {
      "uuid": "ba2ba4a7-18a4-4231-8df6-f0ae90977faf",
      "created_at": "2026-11-04T13:17:36+00:00",
      "updated_at": "2026-11-04T13:17:36+00: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-11-04T13:17:36+00:00",
      "next_review_date": "2026-11-04T13:17:36+00:00",
      "previous_review_date": "2026-11-04T13:17:36+00:00",
      "anniversary_review_date": "2026-11-04T13:17:36+00:00",
      "terms_of_business_at": "2026-11-04T13:17:36+00:00",
      "client_agreement_at": "2026-11-04T13:17:36+00:00",
      "with_login": true,
      "has_joint_account": true,
      "can_be_deleted": "false",
      "ownership_percentage": 100.0,
      "inactive_at": "2026-11-04",
      "last_interaction_at": "2026-11-04 13:17:36",
      "referral_code": "ABC12345",
      "is_out_of_office": true,
      "out_of_office_from": "2026-11-04T13:17:36+00:00",
      "out_of_office_until": "2026-11-04T13:17:36+00: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"
        ]
      },
      "managed_by_head_office": false
    },
    "task_board_uuid": "e32efaa3-51f2-42fa-956d-84fc094fe5bf",
    "plans": {
      "uuid": "b741ad96-9737-406c-be53-bca5679f526d",
      "created_at": "2026-11-04T13:17:36+00:00",
      "updated_at": "2026-11-04T13:17:36+00:00",
      "opened_at": "2026-11-04T13:17:36+00: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-11-04T13:17:36+00:00",
      "inactive_reason": "claimed",
      "agency_in_your_name": true,
      "agency_in_your_name_from": "2025-11-04",
      "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-11-04",
      "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-11-04T13:17:36+00:00",
      "original_valued_at": "2026-11-03T13:17:36+00:00",
      "statistics": {
        "recent_growth": 100
      },
      "is_wrap_product": false,
      "is_wrap_child": false,
      "can_be_deleted": "false"
    },
    "custom_fields": {
      "uuid": null,
      "created_at": "2026-11-04T13:17:36+00:00",
      "updated_at": "2026-11-04T13:17:36+00: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."
    }
  },
  "participants_count": 3,
  "participants": [
    {
      "uuid": "ec02a7bf-e22d-4300-bc2e-42c257d21e3b",
      "created_at": "2026-11-04T13:17:27+00:00",
      "updated_at": "2026-11-04T13:17:27+00: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",
      "firm": {
        "uuid": "4761ecdc-c92f-41fc-90b8-7524ef6a9b68",
        "created_at": "2026-11-04T13:17:36+00:00",
        "updated_at": "2026-11-04T13:17:36+00:00",
        "name": "Codepotato",
        "slug": "codepotato",
        "address_1": "Suite E, 5 The Briars",
        "address_2": "Waterberry Drive",
        "town_city": "Waterlooville",
        "county": "Hampshire",
        "postcode": "PO7 7YH",
        "country": "United Kingdom",
        "regulatory_text": "Regulatory text",
        "logo": "https://api.plannrcrm.com/images/plannr.jpg",
        "logo_icon": "https://api.plannrcrm.com/images/plannr-icon.jpg",
        "brand_colours": {
          "sidebar_background": "#0E0E56",
          "sidebar_accent": "#36367E",
          "sidebar_text": "#FFFFFF",
          "sidebar_hover": "#0A0A42",
          "sidebar_active": "#53DBB8",
          "sidebar_title_background": "#36367E",
          "sidebar_title_primary": "#FFC634",
          "sidebar_title_secondary": "#FFFFFF",
          "sidebar_title_secondary_hover": "#FFFFFF",
          "email_background": "#0E0E56",
          "email_logo_background_panel": "#36367E",
          "email_sub_text": "#FFFFFF",
          "email_button_background": "#36367E",
          "email_button_text": "#FFFFFF",
          "portal_sidebar_button_background": "#F6F6F6",
          "portal_sidebar_button_hover": "#FFFFFF",
          "portal_sidebar_button_active": "#FFFFFF",
          "portal_brand_title": "#323B4B",
          "portal_brand_sub_title": "#828994",
          "portal_sidebar_title": "#11151D",
          "portal_sidebar_text": "#323B4B",
          "portal_sidebar_text_hover": "#323B4B",
          "portal_sidebar_text_active": "#323B4B",
          "portal_sidebar_icon": "#828994",
          "portal_sidebar_icon_hover": "#828994",
          "portal_sidebar_icon_active": "#828994",
          "portal_background": "#F6F6F6",
          "portal_sidebar_account_title": "#11151D",
          "portal_sidebar_account_email": "#828994",
          "portal_sidebar_divider": "#E3E5E9",
          "portal_dashboard_bg_one": "#EF4583",
          "portal_dashboard_bg_two": "#FFC634",
          "portal_sidebar_collapse_button": "#828994",
          "portal_sidebar_collapse_button_hover": "#B3B9C4",
          "portal_sidebar_user_select_background": "#F6F6F6",
          "portal_sidebar_user_select_hover": "#F6F6F6",
          "portal_sidebar_user_select_text": "#323B4B",
          "portal_sidebar_user_select_text_hover": "#323B4B",
          "portal_sidebar_user_select_border": "#EEEEEE",
          "portal_sidebar_user_select_border_hover": "#828994"
        },
        "factfind_pdf_header_background": "#0E0E56",
        "factfind_pdf_header_text": "#ffffff",
        "factfind_pdf_logo": "https://api.plannrcrm.com/images/plannr.jpg",
        "is_subscribed": true,
        "keep_deleted_files_for": 30,
        "tax": 17.5,
        "month_end": 25,
        "statement_frequency": "monthly",
        "billing": {
          "invoice_address_1": "Suite E, 5 The Briars",
          "invoice_address_2": "Waterberry Drive",
          "invoice_town_city": "Waterlooville",
          "invoice_county": "Hampshire",
          "invoice_postcode": "PO7 7YH",
          "invoice_country": "United Kingdom",
          "invoice_email": "gareth@codepotato.co.uk"
        },
        "ip_whitelist": [
          "192.168.0.1",
          "127.0.0.1"
        ],
        "welcome_paragraph_html": "<h1>Welcome.</h1>",
        "email_welcome_paragraph_html": "Welcome to Plannr!",
        "show_fact_find_illustrations": true,
        "cc_email_addresses": [
          "jack@example.com",
          "jill@example.com"
        ],
        "bcc_email_addresses": [
          "jack@example.com",
          "jill@example.com"
        ],
        "reply_to_email_address": "jack@example.com",
        "mobile_app_support_number": "01234 567890",
        "mobile_app_support_email": "support@example.com"
      },
      "primary_phone_number": {
        "uuid": "3a87991b-b48b-47f5-af5d-899dd3d74cc9",
        "created_at": "2026-11-04T13:17:36+00:00",
        "updated_at": "2026-11-04T13:17:36+00:00",
        "type": "phone_number",
        "name": "Work number",
        "value": "+443330903630",
        "phone_number_meta": {
          "country": "GB",
          "formatted": "0333 090 3630"
        }
      },
      "primary_email": {
        "uuid": "3a87991b-b48b-47f5-af5d-899dd3d74cc9",
        "created_at": "2026-11-04T13:17:36+00:00",
        "updated_at": "2026-11-04T13:17:36+00:00",
        "type": "phone_number",
        "name": "Work number",
        "value": "+443330903630",
        "phone_number_meta": {
          "country": "GB",
          "formatted": "0333 090 3630"
        }
      },
      "current_time_entry": {
        "uuid": "2e61ac50-0dfb-43b0-8083-4c95d3f6f567",
        "created_at": "2026-11-04T13:17:36+00:00",
        "updated_at": "2026-11-04T13:17:36+00:00",
        "name": "Research",
        "description": "This is a description.",
        "trackable_type": "Client",
        "start_date": "2026-11-04T12:27:36+00:00",
        "end_date": "2026-11-04T12:55:36+00:00",
        "is_active": true,
        "total_time_in_minutes": 28,
        "computed_time_elapsed_in_seconds": 1680
      },
      "assigned_adviser": {
        "uuid": "ba2ba4a7-18a4-4231-8df6-f0ae90977faf",
        "created_at": "2026-11-04T13:17:36+00:00",
        "updated_at": "2026-11-04T13:17:36+00: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-11-04T13:17:36+00:00",
        "next_review_date": "2026-11-04T13:17:36+00:00",
        "previous_review_date": "2026-11-04T13:17:36+00:00",
        "anniversary_review_date": "2026-11-04T13:17:36+00:00",
        "terms_of_business_at": "2026-11-04T13:17:36+00:00",
        "client_agreement_at": "2026-11-04T13:17:36+00:00",
        "with_login": true,
        "has_joint_account": true,
        "can_be_deleted": "false",
        "ownership_percentage": 100.0,
        "inactive_at": "2026-11-04",
        "last_interaction_at": "2026-11-04 13:17:36",
        "referral_code": "ABC12345",
        "is_out_of_office": true,
        "out_of_office_from": "2026-11-04T13:17:36+00:00",
        "out_of_office_until": "2026-11-04T13:17:36+00: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"
          ]
        },
        "managed_by_head_office": false
      },
      "assigned_administrator": {
        "uuid": "ba2ba4a7-18a4-4231-8df6-f0ae90977faf",
        "created_at": "2026-11-04T13:17:36+00:00",
        "updated_at": "2026-11-04T13:17:36+00: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-11-04T13:17:36+00:00",
        "next_review_date": "2026-11-04T13:17:36+00:00",
        "previous_review_date": "2026-11-04T13:17:36+00:00",
        "anniversary_review_date": "2026-11-04T13:17:36+00:00",
        "terms_of_business_at": "2026-11-04T13:17:36+00:00",
        "client_agreement_at": "2026-11-04T13:17:36+00:00",
        "with_login": true,
        "has_joint_account": true,
        "can_be_deleted": "false",
        "ownership_percentage": 100.0,
        "inactive_at": "2026-11-04",
        "last_interaction_at": "2026-11-04 13:17:36",
        "referral_code": "ABC12345",
        "is_out_of_office": true,
        "out_of_office_from": "2026-11-04T13:17:36+00:00",
        "out_of_office_until": "2026-11-04T13:17:36+00: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"
          ]
        },
        "managed_by_head_office": false
      },
      "assigned_paraplanner": {
        "uuid": "ba2ba4a7-18a4-4231-8df6-f0ae90977faf",
        "created_at": "2026-11-04T13:17:36+00:00",
        "updated_at": "2026-11-04T13:17:36+00: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-11-04T13:17:36+00:00",
        "next_review_date": "2026-11-04T13:17:36+00:00",
        "previous_review_date": "2026-11-04T13:17:36+00:00",
        "anniversary_review_date": "2026-11-04T13:17:36+00:00",
        "terms_of_business_at": "2026-11-04T13:17:36+00:00",
        "client_agreement_at": "2026-11-04T13:17:36+00:00",
        "with_login": true,
        "has_joint_account": true,
        "can_be_deleted": "false",
        "ownership_percentage": 100.0,
        "inactive_at": "2026-11-04",
        "last_interaction_at": "2026-11-04 13:17:36",
        "referral_code": "ABC12345",
        "is_out_of_office": true,
        "out_of_office_from": "2026-11-04T13:17:36+00:00",
        "out_of_office_until": "2026-11-04T13:17:36+00: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"
          ]
        },
        "managed_by_head_office": false
      },
      "introduced_by": {
        "uuid": "ba2ba4a7-18a4-4231-8df6-f0ae90977faf",
        "created_at": "2026-11-04T13:17:36+00:00",
        "updated_at": "2026-11-04T13:17:36+00: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-11-04T13:17:36+00:00",
        "next_review_date": "2026-11-04T13:17:36+00:00",
        "previous_review_date": "2026-11-04T13:17:36+00:00",
        "anniversary_review_date": "2026-11-04T13:17:36+00:00",
        "terms_of_business_at": "2026-11-04T13:17:36+00:00",
        "client_agreement_at": "2026-11-04T13:17:36+00:00",
        "with_login": true,
        "has_joint_account": true,
        "can_be_deleted": "false",
        "ownership_percentage": 100.0,
        "inactive_at": "2026-11-04",
        "last_interaction_at": "2026-11-04 13:17:36",
        "referral_code": "ABC12345",
        "is_out_of_office": true,
        "out_of_office_from": "2026-11-04T13:17:36+00:00",
        "out_of_office_until": "2026-11-04T13:17:36+00: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"
          ]
        },
        "managed_by_head_office": false
      },
      "business_unit": {
        "uuid": "290e0ec1-78a7-48dc-9bae-1cc11de6b6a8",
        "name": "Wealth Management",
        "has_alternative_branding": false,
        "brand_colours": [],
        "members_count": 3,
        "groups_count": 2,
        "created_at": "2026-11-04T13:17:36+00:00",
        "updated_at": "2026-11-04T13:17:36+00:00"
      },
      "groups": {
        "uuid": null,
        "name": "finance",
        "slug": "finance",
        "participants_count": "3",
        "participants": {
          "uuid": {
            "example": null,
            "description": "UUID of the account"
          },
          "role": {
            "example": "client",
            "description": "Role of the account"
          },
          "first_name": {
            "example": "Gareth",
            "description": "First name of the account"
          },
          "last_name": {
            "example": "Thompson",
            "description": "Last name of the account"
          },
          "name": {
            "example": "Gareth Thompson",
            "description": "Name of the account"
          },
          "email": {
            "example": "gareth@codepotato.co.uk",
            "description": "Email of the account"
          }
        },
        "created_at": "2026-11-04T13:17:36+00:00",
        "updated_at": "2026-11-04T13:17:36+00:00"
      },
      "tags": {
        "uuid": "c4babca4-6114-4fe9-88fc-4653c7a97bd8",
        "created_at": "2026-11-04T13:17:36+00:00",
        "updated_at": "2026-11-04T13:17:36+00:00",
        "name": "Mortgage",
        "slug": "mortgage",
        "colour": "#ef4582"
      },
      "marketing_consent": {
        "email": "opted_in",
        "phone": "opted_out",
        "letter": "not_captured",
        "sms": "not_captured"
      },
      "owners": {
        "uuid": "ba2ba4a7-18a4-4231-8df6-f0ae90977faf",
        "created_at": "2026-11-04T13:17:36+00:00",
        "updated_at": "2026-11-04T13:17:36+00: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-11-04T13:17:36+00:00",
        "next_review_date": "2026-11-04T13:17:36+00:00",
        "previous_review_date": "2026-11-04T13:17:36+00:00",
        "anniversary_review_date": "2026-11-04T13:17:36+00:00",
        "terms_of_business_at": "2026-11-04T13:17:36+00:00",
        "client_agreement_at": "2026-11-04T13:17:36+00:00",
        "with_login": true,
        "has_joint_account": true,
        "can_be_deleted": "false",
        "ownership_percentage": 100.0,
        "inactive_at": "2026-11-04",
        "last_interaction_at": "2026-11-04 13:17:36",
        "referral_code": "ABC12345",
        "is_out_of_office": true,
        "out_of_office_from": "2026-11-04T13:17:36+00:00",
        "out_of_office_until": "2026-11-04T13:17:36+00: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"
          ]
        },
        "managed_by_head_office": false
      },
      "first_contact_date": "2026-11-04T13:17:27+00:00",
      "next_review_date": "2026-11-04T13:17:27+00:00",
      "previous_review_date": "2026-11-04T13:17:27+00:00",
      "anniversary_review_date": "2026-11-04T13:17:27+00:00",
      "terms_of_business_at": "2026-11-04T13:17:27+00:00",
      "client_agreement_at": "2026-11-04T13:17:27+00:00",
      "with_login": true,
      "has_joint_account": true,
      "can_be_deleted": "false",
      "joint_account_circle": {
        "uuid": "74df6fca-19e5-4473-94cf-63d82eac9302",
        "created_at": "2026-11-04T13:17:36+00:00",
        "updated_at": "2026-11-04T13:17:36+00: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-11-04T13:17:36+00: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": "288ec75d-ec47-4a55-b9c8-20bfbe63b7bd",
        "login_access_level": "write",
        "current_life_stage_uuid": "7f8fd95b-6aa4-4c50-8e68-922ce3c9568a"
      },
      "circles": {
        "uuid": "74df6fca-19e5-4473-94cf-63d82eac9302",
        "created_at": "2026-11-04T13:17:36+00:00",
        "updated_at": "2026-11-04T13:17:36+00: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-11-04T13:17:36+00: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": "288ec75d-ec47-4a55-b9c8-20bfbe63b7bd",
        "login_access_level": "write",
        "current_life_stage_uuid": "7f8fd95b-6aa4-4c50-8e68-922ce3c9568a"
      },
      "ownership_percentage": 100,
      "inactive_at": "2026-11-04",
      "last_interaction_at": "2026-11-04 13:17:27",
      "referral_code": "ABC12345",
      "is_out_of_office": true,
      "out_of_office_from": "2026-11-04T13:17:27+00:00",
      "out_of_office_until": "2026-11-04T13:17:27+00:00",
      "out_of_office_message": "I am away this week. For urgent matters please contact the office.",
      "service_level": {
        "uuid": "7ba61941-ed57-4a09-8901-e43c599a0d61",
        "name": "Gold",
        "created_at": "2026-11-04T13:17:36+00:00",
        "updated_at": "2026-11-04T13:17:36+00:00"
      },
      "is_pending_fact_find_account": false,
      "permissions": {
        "firm:read": [
          "firm"
        ],
        "network:read": [
          "network:uuid"
        ]
      },
      "managed_by_head_office": false,
      "custom_fields": {
        "uuid": null,
        "created_at": "2026-11-04T13:17:36+00:00",
        "updated_at": "2026-11-04T13:17:36+00: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": "3a304cfe-74d6-4c2e-a209-6f1e3830985f",
        "created_at": "2026-11-04T13:17:36+00:00",
        "updated_at": "2026-11-04T13:17:36+00:00",
        "third_party": "nucleus",
        "reference": "AB123456"
      }
    }
  ],
  "latest_message": {
    "uuid": "fd95eead-98b1-4eed-87f3-b0d618dbf859",
    "created_at": "2026-11-04T13:17:27+00:00",
    "updated_at": "2026-11-04T13:17:27+00:00",
    "deleted_at": "2026-11-04T13:17:27+00:00",
    "contents": "Welcome to Plannr!",
    "edited": true,
    "is_auto_reply": false,
    "files": {
      "uuid": "b7c09c65-cac3-411c-9ee9-8afdfc833169",
      "created_at": "2026-11-04T13:17:36+00:00",
      "original_created_at": "2026-11-04T13:17:36+00:00",
      "updated_at": "2026-11-04T13:17:36+00:00",
      "uploaded_at": "2026-11-04T13:17:36+00:00",
      "status": "uploaded",
      "filename": "Welcome to Plannr.pdf",
      "name": "Welcome to Plannr",
      "extension": "pdf",
      "type": "type",
      "size": "21691783",
      "path": "Gareth Thompson/Subfolder/Welcome to Plannr.pdf",
      "last_modified": "2026-11-04T13:17:36+00:00",
      "progress": "100",
      "download_url": "https://api.plannrcrm.com/file/57b70a7e-4ac5-434c-89b2-e44c758e7a5f/download",
      "preview_url": "https://api.plannrcrm.com/file/27e4c6b2-e2b3-4fcd-a980-4fe787a6acfb/preview",
      "folder_name": "folder 2",
      "documentable_type": "account",
      "documentable": "Object",
      "navigator": {
        "model_type": "account",
        "model_uuid": null
      }
    },
    "author": {
      "uuid": "ba2ba4a7-18a4-4231-8df6-f0ae90977faf",
      "created_at": "2026-11-04T13:17:36+00:00",
      "updated_at": "2026-11-04T13:17:36+00: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-11-04T13:17:36+00:00",
      "next_review_date": "2026-11-04T13:17:36+00:00",
      "previous_review_date": "2026-11-04T13:17:36+00:00",
      "anniversary_review_date": "2026-11-04T13:17:36+00:00",
      "terms_of_business_at": "2026-11-04T13:17:36+00:00",
      "client_agreement_at": "2026-11-04T13:17:36+00:00",
      "with_login": true,
      "has_joint_account": true,
      "can_be_deleted": "false",
      "ownership_percentage": 100.0,
      "inactive_at": "2026-11-04",
      "last_interaction_at": "2026-11-04 13:17:36",
      "referral_code": "ABC12345",
      "is_out_of_office": true,
      "out_of_office_from": "2026-11-04T13:17:36+00:00",
      "out_of_office_until": "2026-11-04T13:17:36+00: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"
        ]
      },
      "managed_by_head_office": false
    },
    "user": {
      "uuid": "1e31a81c-f86f-49c4-a2be-b7ece5f89282",
      "created_at": "2026-11-04T13:17:36+00:00",
      "updated_at": "2026-11-04T13:17:36+00:00",
      "type": "standard",
      "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",
      "two_factor_enabled": true,
      "two_factor_setup_required": true,
      "two_factor_type": "sms",
      "otp_confirmed_at": "2026-11-04T13:17:36+00:00",
      "otp_pending": false,
      "sms_two_factor_enabled": true,
      "two_factor_mobile": true,
      "two_factor_mobile_meta": {
        "country": "GB",
        "formatted": "0333 090 3630"
      },
      "session_expires_at": "2026-11-04T13:17:36+00:00",
      "remember_token_expires_at": true,
      "should_auto_save_notes": true
    },
    "reactions": {
      "uuid": "74fe4d71-4eb4-4e8b-bd5e-568637c7ffa0",
      "created_at": "2026-11-04T13:17:36+00:00",
      "updated_at": "2026-11-04T13:17:36+00:00",
      "account_uuid": null,
      "account_name": "Gareth Thompson",
      "reaction": "like"
    }
  },
  "messages_count": 30,
  "files_count": 2,
  "tags": [
    {
      "uuid": "0309180b-e33e-4a35-bfa6-cce6d73a5f3e",
      "created_at": "2026-11-04T13:17:27+00:00",
      "updated_at": "2026-11-04T13:17:27+00:00",
      "name": "Mortgage",
      "slug": "mortgage",
      "colour": "#ef4582"
    }
  ],
  "pinned": true,
  "is_admin": false
}
Response examples (422) 
{
  "message": "The given data was invalid.",
  "errors": {
    "field": [
      "The field is invalid."
    ]
  }
}