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": "80628739-3986-430e-b1a5-278bb95214e9",
"schema": {
"name": "Default fact-find",
"uuid": "897605e0-c6b6-4666-9ce6-264383b70ff5",
"created_at": "2025-04-30T15:05:06+01:00",
"public_url": "https://plannr.valet/fact-find/95a9ae26-335c-4813-8e66-a813dce1636f",
"updated_at": "2025-04-30T15:05:06+01:00",
"archived_at": "2025-04-29T15:05:06+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": "9510773b-8aa5-41ea-b89d-ef9fc56e885a",
"email": "gareth@codepotato.co.uk",
"last_name": "Thompson",
"photo_url": "https://eu.ui-avatars.com/api/?name=Gareth+Thompson",
"created_at": "2025-04-30T15:05:06+01:00",
"first_name": "Gareth",
"updated_at": "2025-04-30T15:05:06+01:00",
"external_references": "App\\Http\\Resources\\ExternalReferenceResource"
},
"created_at": "2025-04-30T15:05:06+01:00",
"updated_at": "2025-04-30T15:05:06+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": "fbf3810a-f5c6-4751-a637-a0c3167fffde",
"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": "e523ca6d-924d-4753-ad03-ca7680226302"
},
"created_at": "2025-04-30T15:05:06+01:00",
"updated_at": "2025-04-30T15:05:06+01:00",
"folder_name": "folder 2",
"uploaded_at": "2025-04-30T15:05:06+01:00",
"documentable": "Object",
"download_url": "https://plannr.valet/file/9b597d53-1e75-4039-b0cf-eb68d79a70d0/download",
"last_modified": "2025-04-30T15:05:06+01:00",
"documentable_type": "account",
"original_created_at": "2025-04-30T15:05:06+01:00"
},
"completed_at": "2025-04-25T15:05:06+01:00",
"invitation_url": "https://plannr.valet/fact-find/6e9307e5-3b5a-4447-81ab-573cb57110d5/88818101-e9b9-41ed-8258-6e9af3812b76",
"invitation_text": "Please complete this fact-find!",
"fact_find_passes": {
"firm": {
"name": "Codepotato Ltd",
"uuid": "10834234-95b1-4d2f-bb5e-335b73a69173"
},
"uuid": "408179c3-fd5c-42b0-944f-1adbdcad5a14",
"circle": {
"name": "The Codepotato Gang",
"uuid": "87fbff3f-1edc-4893-a262-20c9fcb6481e"
},
"account": "App\\Http\\Resources\\MinimalAccountResource",
"progress": 50,
"created_at": "2025-04-30T15:05:06+01:00",
"expires_at": "2025-04-30T15:05:06+01:00",
"updated_at": "2025-04-30T15:05:06+01:00",
"is_complete": false,
"completed_sections": 2
}
}