Headers
-
Content-Type string
-
Accept string
-
X-PLANNR-ACCOUNT-UUID string
Body Required
-
The UUID of the client account to send the fact-find request. Can be individual, joint, business, trust.
-
The UUID of the fact-find schema that you would like the client to use.
-
invitation_text string
The text that will appear in the invitation email sent to the client.
POST
/api/v1/fact-find/request
curl \
--request POST https://api.plannrcrm.com/api/v1/fact-find/request \
--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}" \
--data '{"client_uuid":"string","fact_find_schema_uuid":"string","invitation_text":"Please complete this fact-find."}'
Request examples
# Headers
Authorization: Bearer {OAUTH_ACCESS_TOKEN or PERSONAL_ACCESS_TOKEN}
Content-Type: application/json
Accept: application/json
X-PLANNR-ACCOUNT-UUID: {YOUR_PLANNR_ACCOUNT_UUID}
# Payload
{
"client_uuid": "string",
"fact_find_schema_uuid": "string",
"invitation_text": "Please complete this fact-find."
}
Response examples (201)
{
"uuid": "76c5ac65-b03d-4d06-adc0-be5c093e9317",
"schema": {
"name": "Default fact-find",
"uuid": "56b744a7-f50d-452c-a080-8acaec257b2b",
"created_at": "2025-02-20T10:13:05+00:00",
"updated_at": "2025-02-20T10:13:05+00:00",
"archived_at": "2025-02-19T10:13:05+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",
"created_at": "2025-02-20T10:13:05+00:00",
"updated_at": "2025-02-20T10:13:05+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": "ae76e026-23c0-48ee-817e-f653697e00d2",
"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": "5f390bef-4e26-416e-b7c1-37ccf977e6c8"
},
"created_at": "2025-02-20T10:13:05+00:00",
"updated_at": "2025-02-20T10:13:05+00:00",
"folder_name": "folder 2",
"uploaded_at": "2025-02-20T10:13:05+00:00",
"documentable": "Object",
"download_url": "https://plannr.valet/file/5c0abba7-dd7d-4828-abff-4ad7f975ba00/download",
"last_modified": "2025-02-20T10:13:05+00:00",
"documentable_type": "account",
"original_created_at": "2025-02-20T10:13:05+00:00"
},
"completed_at": "2025-02-15T10:13:05+00:00",
"invitation_text": "Please complete this fact-find!"
}