Create a fact-find request

POST /api/v1/fact-find/request

Personal access token & O auth2

Headers

application/json

Body Required

fact_find_schema_uuid string Required

The UUID of the fact-find schema that you would like the client to use.
client_uuid string Required

The UUID of the client account to send the fact-find request. This must only be individual clients. Cannot be used with circle_uuid.
circle_uuid string Required

The UUID of the circle to send the fact-find request to. Cannot be used with client_uuid.
send_invitation_email boolean

This controls if an email to the client is sent to invite them to complete a fact-find. Set this to false if you are going to send your own invitation.
invitation_text string

The text that will appear in the invitation email sent to the client (if enabled)

Responses

201 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.
- latest_file object
  
  The latest file that has been generated for the fact-find request.
- account object
  
  The account that the fact-find request was sent to. Only visible when listing fact-find requests for a circle.
- invitation_url string
  
  The invitation URL sent to the client.
- fact_find_passes object
  
  The fact find passes added to the fact-find request.

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 '{"fact_find_schema_uuid":"9ef550e9-a6ac-4a17-bdd7-4b3c32be7af6","client_uuid":"e40f2316-2fd9-4293-b179-fc225e28df23","circle_uuid":"a0e66ca7-2409-4cf9-a455-b7fe07429a02","send_invitation_email":true,"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
{
  "fact_find_schema_uuid": "9ef550e9-a6ac-4a17-bdd7-4b3c32be7af6",
  "client_uuid": "e40f2316-2fd9-4293-b179-fc225e28df23",
  "circle_uuid": "a0e66ca7-2409-4cf9-a455-b7fe07429a02",
  "send_invitation_email": true,
  "invitation_text": "Please complete this fact-find."
}

Response examples (201)

{
  "uuid": "2640802f-f83c-4723-8615-945b71fe7a7e",
  "schema": {
    "name": "Default fact-find",
    "uuid": "2b80b532-187b-4ea0-bd34-1f039c913192",
    "created_at": "2025-04-02T13:27:58+01:00",
    "public_url": "https://plannr.valet/fact-find/98327c6f-9b67-4ddc-97e0-ee52615c117b",
    "updated_at": "2025-04-02T13:27:58+01:00",
    "archived_at": "2025-04-01T13:27:58+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": "25388aaf-68f5-4724-93ca-86684b1ab13f",
    "email": "gareth@codepotato.co.uk",
    "last_name": "Thompson",
    "photo_url": "https://eu.ui-avatars.com/api/?name=Gareth+Thompson",
    "created_at": "2025-04-02T13:27:58+01:00",
    "first_name": "Gareth",
    "updated_at": "2025-04-02T13:27:58+01:00",
    "external_references": "App\\Http\\Resources\\ExternalReferenceResource"
  },
  "created_at": "2025-04-02T13:27:58+01:00",
  "updated_at": "2025-04-02T13:27:58+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": "37c3d28f-bde9-4d2c-ac16-d2ead5bfe3be",
    "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": "92aae2fd-63f8-4e6a-9c4c-0c882a7a5164"
    },
    "created_at": "2025-04-02T13:27:58+01:00",
    "updated_at": "2025-04-02T13:27:58+01:00",
    "folder_name": "folder 2",
    "uploaded_at": "2025-04-02T13:27:58+01:00",
    "documentable": "Object",
    "download_url": "https://plannr.valet/file/24a036ec-42e2-44cf-92d1-d6f3f15711f7/download",
    "last_modified": "2025-04-02T13:27:58+01:00",
    "documentable_type": "account",
    "original_created_at": "2025-04-02T13:27:58+01:00"
  },
  "completed_at": "2025-03-28T13:27:58+00:00",
  "invitation_url": "https://plannr.valet/fact-find/f87fa2f4-0fa7-4b06-b512-5d1a11ef0c25/845fd008-d32d-4e13-8a53-0f4df8f9d7d0",
  "invitation_text": "Please complete this fact-find!",
  "fact_find_passes": {
    "firm": {
      "name": "Codepotato Ltd",
      "uuid": "0f381d91-915c-45d2-9bc9-28bfbe5ae7b7"
    },
    "uuid": "a8429022-1b79-44df-a280-2b5b04ccb0d4",
    "circle": {
      "name": "The Codepotato Gang",
      "uuid": "7ea46200-610b-485d-9e17-8528ba2f8fbf"
    },
    "account": "App\\Http\\Resources\\MinimalAccountResource",
    "progress": 50,
    "created_at": "2025-04-02T13:27:58+01:00",
    "expires_at": "2025-04-02T13:27:58+01:00",
    "updated_at": "2025-04-02T13:27:58+01:00",
    "is_complete": false,
    "completed_sections": 2
  }
}