Create a fact-find schema

POST /api/v1/fact-find/schema

Headers

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.

POST /api/v1/fact-find/schema

curl \
 -X POST https://api.plannrcrm.com/api/v1/fact-find/schema \
 -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 '{"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
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
{
  "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": "fdc2cdfa-d2e5-4127-9620-78a0476ee62e",
  "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>"
}