Finish the fact-find request

POST /api/v1/fact-find/request/{factFindRequest_uuid}/finish
Personal access token & O auth2

Will mark the fact-find request as completed overall regardless of fact-find pass progress.

Headers

Path parameters

Responses

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

      The UUID of the resource.

    • created_at string

      The timestamp of when the resource was created.

    • updated_at string

      The timestamp of when the resource was updated.

    • status string

      The status of the fact-find request. Available options: in_progress,complete

    • completed_at string

      The datetime when the fact-find request has been completed

    • invitation_text string

      The text that is used in the notification/email sent out to the client.

    • schema object

      The fact-find schema used for the fact-find request.

      Additional properties are allowed.

    • latest_file object

      The latest file that has been generated for the fact-find request.

      Additional properties are allowed.

    • account object

      The account that the fact-find request was sent to. Only visible when listing fact-find requests for a circle.

      Additional properties are allowed.

    • invitation_url string

      The invitation URL sent to the client.

    • fact_find_passes object

      The fact find passes added to the fact-find request.

      Additional properties are allowed.
POST /api/v1/fact-find/request/{factFindRequest_uuid}/finish 
curl \
 --request POST https://api.plannrcrm.com/api/v1/fact-find/request/factFindRequest_uuid/finish \
 --header "Authorization: Bearer {OAUTH_ACCESS_TOKEN or PERSONAL_ACCESS_TOKEN}" \
 --header "Content-Type: application/json" \
 --header "Accept: application/json" \
 --header "X-PLANNR-ACCOUNT-UUID: {YOUR_PLANNR_ACCOUNT_UUID}"
Response examples (200) 
{
  "uuid": "475d6965-1f7f-43f1-bffa-f062cf20839e",
  "schema": {
    "name": "Default fact-find",
    "uuid": "f871e27c-46f1-491f-9f0c-906744339af5",
    "created_at": "2025-03-10T22:05:31+00:00",
    "public_url": "https://plannr.valet/fact-find/15ab6368-6bd6-4246-a85e-06e180006b45",
    "updated_at": "2025-03-10T22:05:31+00:00",
    "archived_at": "2025-03-09T22:05:31+00:00",
    "is_archived": false,
    "sections_count": 5,
    "introduction_html": "Welcome to our fact-find! <b>You can use some HTML too.</b>"
  },
  "status": "complete",
  "account": {
    "name": "Gareth Thompson",
    "role": "client",
    "type": "client",
    "uuid": "b32e98e5-c114-41fe-899f-59bae0f693bf",
    "email": "gareth@codepotato.co.uk",
    "last_name": "Thompson",
    "photo_url": "https://eu.ui-avatars.com/api/?name=Gareth+Thompson",
    "created_at": "2025-03-10T22:05:31+00:00",
    "first_name": "Gareth",
    "updated_at": "2025-03-10T22:05:31+00:00",
    "external_references": "App\\Http\\Resources\\ExternalReferenceResource"
  },
  "created_at": "2025-03-10T22:05:31+00:00",
  "updated_at": "2025-03-10T22:05:31+00:00",
  "latest_file": {
    "firm": "App\\Http\\Resources\\FirmResource",
    "name": "Welcome to Plannr",
    "path": "Gareth Thompson/Subfolder/Welcome to Plannr.pdf",
    "size": "21691783",
    "tags": "App\\Http\\Resources\\TagResource",
    "type": "type",
    "uuid": "bfb3d44a-4be6-46eb-8102-b5be7bbbf598",
    "folder": "App\\Http\\Resources\\FolderResource",
    "status": "uploaded",
    "account": "App\\Http\\Resources\\MinimalAccountResource",
    "filename": "Welcome to Plannr.pdf",
    "progress": "100",
    "extension": "pdf",
    "navigator": {
      "model_type": "account",
      "model_uuid": "6da0ba5e-d6f4-4823-a5e7-7b1687814019"
    },
    "created_at": "2025-03-10T22:05:31+00:00",
    "updated_at": "2025-03-10T22:05:31+00:00",
    "folder_name": "folder 2",
    "uploaded_at": "2025-03-10T22:05:31+00:00",
    "documentable": "Object",
    "download_url": "https://plannr.valet/file/5f310d67-b095-4df8-a94b-61ebafcdfd1d/download",
    "last_modified": "2025-03-10T22:05:31+00:00",
    "documentable_type": "account",
    "original_created_at": "2025-03-10T22:05:31+00:00"
  },
  "completed_at": "2025-03-05T22:05:31+00:00",
  "invitation_url": "https://plannr.valet/fact-find/9c672690-6697-49d2-89b7-a4cba2b54ebc/ce31c370-3c70-4e09-9fdd-199f53e13c41",
  "invitation_text": "Please complete this fact-find!",
  "fact_find_passes": {
    "firm": {
      "name": "Codepotato Ltd",
      "uuid": "9163b8ca-6e63-4dfe-8f72-34b1dd787d58"
    },
    "uuid": "23cece49-7d23-4e02-9a42-125e0350c907",
    "circle": {
      "name": "The Codepotato Gang",
      "uuid": "116d13eb-78c3-4087-9f35-71b133936d9c"
    },
    "account": "App\\Http\\Resources\\MinimalAccountResource",
    "progress": 50,
    "created_at": "2025-03-10T22:05:31+00:00",
    "expires_at": "2025-03-10T22:05:31+00:00",
    "updated_at": "2025-03-10T22:05:31+00:00",
    "is_complete": false,
    "completed_sections": 2
  }
}