Archive a fact-find schema

POST /api/v1/fact-find/schema/{factFindSchema_uuid}/archive
Personal access token & O auth2

Headers

  • X-PLANNR-ACCOUNT-UUID string

Path parameters

  • factFindSchema_uuid string Required

Responses

  • 200 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/{factFindSchema_uuid}/archive 
curl \
 --request POST 'https://api.plannrcrm.com/api/v1/fact-find/schema/6ff8f7f6-1eb3-3525-be4a-3932c805afed/archive' \
 --header "Authorization: Bearer $ACCESS_TOKEN" \
 --header "X-PLANNR-ACCOUNT-UUID: {YOUR_PLANNR_ACCOUNT_UUID}"
Response examples (200) 
{
  "name": "Default fact-find",
  "uuid": "f1d7edf8-da47-4088-96ae-c6bfbb015cfb",
  "created_at": "2025-08-27T17:31:27+01:00",
  "public_url": "https://api.plannrcrm.com/fact-find/b22718a0-c7c0-4b4f-9ccc-1b5c827e660f",
  "updated_at": "2025-08-27T17:31:27+01:00",
  "archived_at": "2025-08-26T17:31:27+01:00",
  "is_archived": false,
  "sections_count": 5,
  "introduction_html": "Welcome to our fact-find! <b>You can use some HTML too.</b>"
}