Create a fact-find schema

POST /api/v1/fact-find/schema
Personal access token & O auth2

Headers

  • X-PLANNR-ACCOUNT-UUID string
application/json

Body Required

  • name string Required

    The name of the fact-find schema. Must be unique.

  • introduction_html string

    The name of the fact-find schema. Must be unique.

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.

    • archived_at string

      If the schema has been archived, the datetime of when it was archived.

    • is_archived boolean

      Denotes if the schema has been archived.

    • name string

      The name of the fact-find schema.

    • introduction_html string

      The name of the fact-find schema. Must be unique.

    • sections_count integer

      The number of sections inside of a fact-find schema.

    • public_url string

      The public URL of the fact-find schema.
POST /api/v1/fact-find/schema 
curl \
 --request POST 'https://api.plannrcrm.com/api/v1/fact-find/schema' \
 --header "Authorization: Bearer $ACCESS_TOKEN" \
 --header "Content-Type: application/json" \
 --header "X-PLANNR-ACCOUNT-UUID: {YOUR_PLANNR_ACCOUNT_UUID}" \
 --data '{"name":"Mortgage Client Fact-Find","introduction_html":"Welcome to our fact-find! \u003cb\u003eYou can use some HTML too.\u003c/b\u003e"}'
Request examples 
# Headers
X-PLANNR-ACCOUNT-UUID: {YOUR_PLANNR_ACCOUNT_UUID}

# Payload
{
  "name": "Mortgage Client Fact-Find",
  "introduction_html": "Welcome to our fact-find! <b>You can use some HTML too.</b>"
}
Response examples (201) 
{
  "name": "Default fact-find",
  "uuid": "d28f5c87-44b3-40b4-9c2e-c78b43fcc781",
  "created_at": "2025-06-26T11:37:09+01:00",
  "public_url": "https://api.plannrcrm.com/fact-find/4d2b3d99-c6d2-4e09-b17a-2dcf128c5151",
  "updated_at": "2025-06-26T11:37:09+01:00",
  "archived_at": "2025-06-25T11:37:09+01:00",
  "is_archived": false,
  "sections_count": 5,
  "introduction_html": "Welcome to our fact-find! <b>You can use some HTML too.</b>"
}