Publish a fact-find template. | PlannrCRM API documentation

Publish a fact-find template. Run in API Explorer

Add MCP server to your AI tool

Allow AI tools and LLMs to interact with the API documentation portal through MCP.

MCP server URL


        
          
            https://apidocs.plannrcrm.com/mcp

Standard setup for AI tools providing an mcp.json file

{
  "PlannrCRM MCP server": {
    "url": "https://apidocs.plannrcrm.com/mcp"
  }
}

POST /api/v2/fact-find/templates/{factFindTemplate_uuid}/publish

Personal access token & O auth2

Allowed even when the template is locked — publishing only flips a flag and never affects any in-flight or historical session. Pairs with unpublish so an adviser can retire a locked template (preventing new sessions from being created against it) and bring a clone forward as the active version.

Rejected with a 422 if the template has been archived — a template is either live or archived, never both, and archiving is permanent.

Headers

X-PLANNR-ACCOUNT-UUID string

Path parameters

factFindTemplate_uuid string Required

Responses

200 application/json
Hide response attributes Show response attributes object
- uuid string
- created_at string
- updated_at string
- name string
- display_name string
- description string
- opening_statement string
- closing_statement string
- is_published boolean
- archived_at string
- is_archived boolean
- is_locked boolean
- active_session_count integer
- sections object
  
  Hide sections attributes Show sections attributes object
  
  uuid string
  
  created_at string
  
  updated_at string
  
  fact_find_template object
  
  Hide fact_find_template attributes Show fact_find_template attributes object
  
  uuid
  
  The UUID of the resource.
  
  created_at
  
  The timestamp of when the resource was created.
  
  updated_at
  
  The timestamp of when the resource was updated.
  
  name
  
  The internal reference name of the fact-find template.
  
  display_name
  
  The client-facing name shown when the fact find is sent to a client.
  
  description
  
  A brief description of the template.
  
  opening_statement
  
  An opening statement shown at the start of the fact-find.
  
  closing_statement
  
  A closing statement shown at the end of the fact-find.
  
  is_published
  
  Whether the fact-find template is published and available for use.
  
  archived_at
  
  If the template has been archived, the datetime of when it was archived.
  
  is_archived
  
  Denotes if the template has been archived. Archived templates are hidden from the default list and can no longer start new sessions.
  
  is_locked
  
  Whether the template is locked from edits because at least one client has an in-flight session against it. Clone the template to make changes.
  
  active_session_count
  
  Number of in-flight client sessions blocking edits to this template.
  
  name string
  
  introduction_html string
  
  position integer
  
  is_complete boolean
  
  blocks object
  
  Hide blocks attributes Show blocks attributes object
  
  uuid
  
  The UUID of the resource.
  
  created_at
  
  The timestamp of when the resource was created.
  
  updated_at
  
  The timestamp of when the resource was updated.
  
  name
  
  The name of the fact find block.
  
  introduction_html
  
  HTML introduction shown at the start of this block.
  
  position
  
  The position/order of this block within the section.
422 application/json

Validation error
Hide response attributes Show response attributes object
- message string Required
  
  A human-readable description of the error.
- errors object
  
  Validation messages keyed by the field that failed.
  
  Hide errors attribute Show errors attribute object
  
  * array[string] Additional properties

POST /api/v2/fact-find/templates/{factFindTemplate_uuid}/publish

curl \
 --request POST 'https://api.plannrcrm.com/api/v2/fact-find/templates/6ff8f7f6-1eb3-3525-be4a-3932c805afed/publish' \
 --header "Authorization: Bearer $ACCESS_TOKEN" \
 --header "X-PLANNR-ACCOUNT-UUID: {YOUR_PLANNR_ACCOUNT_UUID}"

Response examples (200)

{
  "uuid": "0a0ecb69-158b-4c76-a0e4-307005eda497",
  "created_at": "2026-10-30T16:30:06+00:00",
  "updated_at": "2026-10-30T16:30:06+00:00",
  "name": "My Fact-Find Template",
  "display_name": "Welcome Pack",
  "description": "A comprehensive fact-find template for new clients.",
  "opening_statement": "Welcome to our fact-find process...",
  "closing_statement": "Thank you for completing the fact find",
  "is_published": true,
  "archived_at": "2026-10-29T16:30:06+00:00",
  "is_archived": false,
  "is_locked": false,
  "active_session_count": 0,
  "sections": {
    "uuid": "4a2326fe-833b-4f8b-9c12-7acd376ea223",
    "created_at": "2026-10-30T16:30:06+00:00",
    "updated_at": "2026-10-30T16:30:06+00:00",
    "fact_find_template": {
      "uuid": "230cc522-a328-4407-b4c6-70fdc2869e8b",
      "created_at": "2026-10-30T16:30:12+00:00",
      "updated_at": "2026-10-30T16:30:12+00:00",
      "name": "My Fact-Find Template",
      "display_name": "Welcome Pack",
      "description": "A comprehensive fact-find template for new clients.",
      "opening_statement": "Welcome to our fact-find process...",
      "closing_statement": "Thank you for completing the fact find",
      "is_published": true,
      "archived_at": "2026-10-29T16:30:12+00:00",
      "is_archived": false,
      "is_locked": false,
      "active_session_count": 0
    },
    "name": "Personal Details",
    "introduction_html": "<p>Please provide your personal details below.</p>",
    "position": 1,
    "is_complete": false,
    "blocks": {
      "uuid": "3a6cfd55-174b-4d40-944d-2a94630319f0",
      "created_at": "2026-10-30T16:30:12+00:00",
      "updated_at": "2026-10-30T16:30:12+00:00",
      "name": "Income Details",
      "introduction_html": "<p>Please provide your income details below.</p>",
      "position": 1
    }
  }
}

Response examples (422)

{
  "message": "The given data was invalid.",
  "errors": {
    "field": [
      "The field is invalid."
    ]
  }
}