Headers

• X-PLANNR-ACCOUNT-UUID string

Path parameters

• form_uuid string Required
• submissionRequest_uuid string Required

Responses

• 200 application/json
  Hide response attributes Show response attributes object

  • uuid string
  • created_at string
  • updated_at string
  • description string
  • form object
    Hide form attributes Show form attributes object

    • uuid string
    • created_at string
    • updated_at string
    • title string
    • description string
    • live boolean
    • visibility string
    • sections object
      Hide sections attributes Show sections 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.

      • title

        The title of the question

      • help_text

        Input placeholder text

      • caption

        Text to describe the input

      • type

        The type of question

      • required

        Whether the question is required

      • position

        The position of the question in the section

      • selection_options

        The options for selection questions

      • target_field

        The field to update upon question completion

      • key

        The key to use when updating the target field

      • linked_primary

        Will the this linked field become a primary Address/Phone Number/Email Address

    • allowed_hosts array[string]
    • draft_submissions_count integer
    • submitted_submissions_count integer
    • create_client boolean
    • client_type string
  • has_submission boolean
  • submission object
    Hide submission attributes Show submission attributes object

    • uuid string
    • created_at string
    • updated_at string
    • stage string
    • account object
      Hide account attributes Show 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

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

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

      • description

        The description of the form submission request

      • has_submission

        Denotes if this request has a submission stored against it

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

      • title

        The title of the form

      • description

        The description of the form

      • live

        Whether the form is live

      • visibility

        The visibility of the form

      • allowed_hosts

        Array of allowed domains that this form can be accessed from using different origins

      • draft_submissions_count

        Count of draft submissions against this form

      • submitted_submissions_count

        Count of submitted submissions against this form

      • create_client

        Denotes if this form creates a new client when it is submitted from a public embed

      • client_type

        If create_client is true, then the client_type is the type of client that will be created, possible values are client and prospect

    • answers array[object]
      Hide answers attributes Show answers attributes object

      • first_name string
      • last_name string
• 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