Create a fact-find request

POST /api/v1/fact-find/request

Headers

application/json

Body Required

  • client_uuid string Required

    The UUID of the client account to send the fact-find request. Can be individual, joint, business, trust.

  • fact_find_schema_uuid string Required

    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.

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.
POST /api/v1/fact-find/request 
curl \
 -X POST https://api.plannrcrm.com/api/v1/fact-find/request \
 -H "Authorization: Bearer {OAUTH_ACCESS_TOKEN or PERSONAL_ACCESS_TOKEN}" \
 -H "Content-Type: application/json" \
 -H "Accept: application/json" \
 -H "X-PLANNR-ACCOUNT-UUID: {YOUR_PLANNR_ACCOUNT_UUID}" \
 -d '{"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": "cacc2a75-8a03-486e-8d4c-939bc5b69c30",
  "schema": {
    "name": "Default fact-find",
    "uuid": "bc384fc1-6725-43b6-9a08-568ab9a441db",
    "created_at": "2024-10-16T11:10:16+01:00",
    "updated_at": "2024-10-16T11:10:16+01:00",
    "archived_at": "2024-10-15T11:10:16+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",
  "created_at": "2024-10-16T11:10:16+01:00",
  "updated_at": "2024-10-16T11:10:16+01:00",
  "latest_file": {
    "firm": "App\\Http\\Resources\\FirmResource",
    "name": "Welcome to Plannr",
    "size": "21691783",
    "tags": "App\\Http\\Resources\\TagResource",
    "type": "type",
    "uuid": "c8c99308-afce-4162-a9cc-4737bcde5f62",
    "parent": "Object",
    "status": "uploaded",
    "account": "App\\Http\\Resources\\AccountResource",
    "filename": "Welcome to Plannr.pdf",
    "progress": "100",
    "extension": "pdf",
    "created_at": "2024-10-16T11:10:16+01:00",
    "updated_at": "2024-10-16T11:10:16+01:00",
    "folder_name": "folder 2",
    "uploaded_at": "2024-10-16T11:10:16+01:00",
    "download_url": "https://plannr.valet/file/00035dd8-850f-4e7b-8ede-7a6d40e65c9f/download",
    "last_modified": "2024-10-16T11:10:16+01:00",
    "original_created_at": "2024-10-16T11:10:16+01:00"
  },
  "completed_at": "2024-10-11T11:10:16+01:00",
  "invitation_text": "Please complete this fact-find!"
}