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":"41f55e73-3546-4222-9866-3f07f89e009a","client_uuid":"fff612f2-90cc-45e1-a8b2-d812698baf61","circle_uuid":"4d945889-b0c2-4491-a455-2acf14d0c37d","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": "41f55e73-3546-4222-9866-3f07f89e009a",
  "client_uuid": "fff612f2-90cc-45e1-a8b2-d812698baf61",
  "circle_uuid": "4d945889-b0c2-4491-a455-2acf14d0c37d",
  "send_invitation_email": true,
  "invitation_text": "Please complete this fact-find."
}

Response examples (201)

{
  "uuid": "1dc02cc1-4722-419d-929d-2e0f2d3d144d",
  "schema": {
    "name": "Default fact-find",
    "uuid": "0b008452-6920-4fa0-b092-51614f720e22",
    "created_at": "2025-04-22T13:44:20+01:00",
    "public_url": "https://plannr.valet/fact-find/2975308a-6027-4c3d-b58c-3d9b1c4d6025",
    "updated_at": "2025-04-22T13:44:20+01:00",
    "archived_at": "2025-04-21T13:44:20+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": "d5e81ffd-e2aa-43f2-a71a-e42fbd6026a1",
    "email": "gareth@codepotato.co.uk",
    "last_name": "Thompson",
    "photo_url": "https://eu.ui-avatars.com/api/?name=Gareth+Thompson",
    "created_at": "2025-04-22T13:44:20+01:00",
    "first_name": "Gareth",
    "updated_at": "2025-04-22T13:44:20+01:00",
    "external_references": "App\\Http\\Resources\\ExternalReferenceResource"
  },
  "created_at": "2025-04-22T13:44:20+01:00",
  "updated_at": "2025-04-22T13:44:20+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": "957721cb-3f39-4179-86d1-c48404ca5ee9",
    "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": "2eabe5da-0353-4e13-b1bd-9e2888026a28"
    },
    "created_at": "2025-04-22T13:44:20+01:00",
    "updated_at": "2025-04-22T13:44:20+01:00",
    "folder_name": "folder 2",
    "uploaded_at": "2025-04-22T13:44:20+01:00",
    "documentable": "Object",
    "download_url": "https://plannr.valet/file/b4290f85-9d80-4600-89f8-bf18dec18951/download",
    "last_modified": "2025-04-22T13:44:20+01:00",
    "documentable_type": "account",
    "original_created_at": "2025-04-22T13:44:20+01:00"
  },
  "completed_at": "2025-04-17T13:44:20+01:00",
  "invitation_url": "https://plannr.valet/fact-find/0e736264-8abe-486e-9dea-9ac0396175ec/5a7d760f-2ff0-4fb3-8190-982f5357e477",
  "invitation_text": "Please complete this fact-find!",
  "fact_find_passes": {
    "firm": {
      "name": "Codepotato Ltd",
      "uuid": "be8beca6-aae4-41ce-b450-ff30eed96748"
    },
    "uuid": "6ad3bdd5-6275-404e-9661-195d7f74bdf2",
    "circle": {
      "name": "The Codepotato Gang",
      "uuid": "898975af-298f-45e6-80db-b88633aedbdc"
    },
    "account": "App\\Http\\Resources\\MinimalAccountResource",
    "progress": 50,
    "created_at": "2025-04-22T13:44:20+01:00",
    "expires_at": "2025-04-22T13:44:20+01:00",
    "updated_at": "2025-04-22T13:44:20+01:00",
    "is_complete": false,
    "completed_sections": 2
  }
}