Update a document pack | PlannrCRM API documentation

Update a document pack 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"
  }
}

PUT /api/v1/document-pack/document-pack/{uuid}

Personal access token & O auth2

Path parameters

uuid string Required

application/json

Body

name string Required

Name of the document pack.
description string Required

Short description of the document pack.
is_template boolean

Denotes whether document pack is a template or not.

Responses

200 application/json
Hide response attribute Show response attribute object
- data array[object]
  
  Hide data attributes Show data attributes object
  
  uuid string
  
  created_at string
  
  updated_at string
  
  name string
  
  policy_number string
  
  latest_valuation object
  
  Hide latest_valuation attributes Show latest_valuation attributes object
  
  uuid string
  
  created_at string
  
  updated_at string
  
  valued_at string
  
  value object
  
  Hide value attributes Show value attributes object
  
  amount object
  
  Hide amount attributes Show amount attributes object
  
  example string
  
  description string
  
  formatted object
  
  Hide formatted attributes Show formatted attributes object
  
  example string
  
  description string
  
  currency object
  
  Hide currency attributes Show currency attributes object
  
  example string
  
  description string
  
  sub_account object
  
  Hide sub_account attributes Show sub_account attributes object
  
  uuid
  
  UUID of the sub account
  
  created_at
  
  The timestamp of when the resource was created.
  
  updated_at
  
  The timestamp of when the resource was created.
  
  name
  
  Descriptive name of the sub account
  
  policy_number
  
  Provider reference of the sub account
  
  is_main_account
  
  Denotes if the sub account a main account of the plan
  
  statistics
  
  The statistics on a sub account. Only displayed when you retrieve an individual sub-account.
  
  is_main_account boolean
  
  active_portfolio object
  
  Hide active_portfolio attributes Show active_portfolio attributes object
  
  uuid string
  
  created_at string
  
  updated_at string
  
  is_proposed boolean
  
  proposed_at string
  
  name string
  
  statistics object
  
  Hide statistics attribute Show statistics attribute object
  
  recent_growth integer
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

PUT /api/v1/document-pack/document-pack/{uuid}

curl \
 --request PUT 'https://api.plannrcrm.com/api/v1/document-pack/document-pack/6ff8f7f6-1eb3-3525-be4a-3932c805afed' \
 --header "Authorization: Bearer $ACCESS_TOKEN" \
 --header "Content-Type: application/json" \
 --data '{
  "name": "Terms and Conditions",
  "description": "Terms and Conditions for our services",
  "is_template": true
}'

Request examples

{
  "name": "Terms and Conditions",
  "description": "Terms and Conditions for our services",
  "is_template": true
}

Response examples (200)

{
  "data": [
    {
      "uuid": "15f9be63-66c7-4212-8e1b-aec819dd07d7",
      "created_at": "2026-10-30T16:30:05+00:00",
      "updated_at": "2026-10-30T16:30:05+00:00",
      "name": "John's ISA",
      "policy_number": "AVI-4837",
      "latest_valuation": {
        "uuid": "772151eb-bcda-45f6-9f38-51f4fade8435",
        "created_at": "2026-10-30T16:30:05+00:00",
        "updated_at": "2026-10-30T16:30:05+00:00",
        "valued_at": "2026-10-30T16:30:05+00:00",
        "value": {
          "amount": {
            "example": "4000",
            "description": "Money amount at their lowest denominator (for example: pennies)"
          },
          "formatted": {
            "example": "£40.00",
            "description": "Money amount formatted with currency"
          },
          "currency": {
            "example": "GBP",
            "description": "Currency of the money"
          }
        },
        "sub_account": {
          "uuid": "db3ec774-3ab1-45a0-b708-efb927f89909",
          "created_at": "2026-10-30T16:30:12+00:00",
          "updated_at": "2026-10-30T16:30:12+00:00",
          "name": "John's ISA",
          "policy_number": "AVI-4837",
          "is_main_account": false,
          "statistics": {
            "recent_growth": 100
          }
        }
      },
      "is_main_account": false,
      "active_portfolio": {
        "uuid": "63c0f056-704c-48e9-9a90-d8bc8ab3d6b4",
        "created_at": "2026-10-30T16:30:05+00:00",
        "updated_at": "2026-10-30T16:30:05+00:00",
        "is_proposed": true,
        "proposed_at": "2026-10-30T00:00:00+00:00",
        "name": "Risky Portfolio"
      },
      "statistics": {
        "recent_growth": 100
      }
    }
  ]
}

Response examples (422)

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