Finish the fact-find request
Will mark the fact-find request as completed overall regardless of fact-find pass progress.
Headers
-
Content-Type
string -
Accept
string -
X-PLANNR-ACCOUNT-UUID
string
Path parameters
-
factFindRequest_uuid
string Required
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": "36f668dd-632d-4153-8a95-8655c1c7e5aa",
"schema": {
"name": "Default fact-find",
"uuid": "038b2e81-e858-4c72-9b90-12e5761d3a4c",
"created_at": "2025-05-21T13:38:04+01:00",
"public_url": "https://plannr.valet/fact-find/0d505bd3-6d10-4580-bda0-691e1873e7e7",
"updated_at": "2025-05-21T13:38:04+01:00",
"archived_at": "2025-05-20T13:38:04+01: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": "b0bd3a57-92b6-4e58-8533-fd979799f4fe",
"email": "gareth@codepotato.co.uk",
"last_name": "Thompson",
"photo_url": "https://eu.ui-avatars.com/api/?name=Gareth+Thompson",
"created_at": "2025-05-21T13:38:04+01:00",
"first_name": "Gareth",
"updated_at": "2025-05-21T13:38:04+01:00",
"external_references": "App\\Http\\Resources\\ExternalReferenceResource"
},
"created_at": "2025-05-21T13:38:04+01:00",
"updated_at": "2025-05-21T13:38:04+01: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": "77eb947a-0283-4bc8-b372-811c4b3235c6",
"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": "7ad03798-9da0-4e23-8a8a-81e18d7fd9ba"
},
"created_at": "2025-05-21T13:38:04+01:00",
"updated_at": "2025-05-21T13:38:04+01:00",
"folder_name": "folder 2",
"uploaded_at": "2025-05-21T13:38:04+01:00",
"documentable": "Object",
"download_url": "https://plannr.valet/file/5ea3b781-e0bb-46b7-8477-ce6621cfcabd/download",
"last_modified": "2025-05-21T13:38:04+01:00",
"documentable_type": "account",
"original_created_at": "2025-05-21T13:38:04+01:00"
},
"completed_at": "2025-05-16T13:38:04+01:00",
"invitation_url": "https://plannr.valet/fact-find/400764a2-c2b7-48ca-a324-e6842a892b79/e67d7e2e-080f-4095-8548-11a1cd73161b",
"invitation_text": "Please complete this fact-find!",
"fact_find_passes": {
"firm": {
"name": "Codepotato Ltd",
"uuid": "b3428bee-01ae-466c-aa61-5c30b44b4063"
},
"uuid": "9fd62d20-2227-4a5b-bec4-7515200d9602",
"circle": {
"name": "The Codepotato Gang",
"uuid": "45baa219-6ecb-40f0-bbef-1533bdaee13d"
},
"account": "App\\Http\\Resources\\MinimalAccountResource",
"progress": 50,
"created_at": "2025-05-21T13:38:04+01:00",
"expires_at": "2025-05-21T13:38:04+01:00",
"updated_at": "2025-05-21T13:38:04+01:00",
"is_complete": false,
"completed_sections": 2
}
}