Update a document 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

mcp.json 
{
  "PlannrCRM MCP server": {
    "url": "https://apidocs.plannrcrm.com/mcp"
  }
}
Close
PUT /api/v1/document/{uuid}
Personal access token & O auth2

Headers

  • X-PLANNR-ACCOUNT-UUID string

Path parameters

  • uuid string Required
application/json

Body

  • name string

    The name of the document.

  • client_uuids array[string(uuid)]

    An array containing the client uuids that should be sent the document when it is built.

  • known_dependants object

    Optional: The document variable dependants. Used to swap variables out for real data.

    Additional properties are allowed.

Responses

  • 200 application/json
    Hide response attributes Show response attributes object
    • uuid string
    • created_at string
    • updated_at string
    • version integer
    • name string
    • status string
    • last_publishing_error string
    • required_dependants object
      Hide required_dependants attribute Show required_dependants attribute object
      • client-1 string
    • known_dependants object
      Hide known_dependants attribute Show known_dependants attribute object
      • client-1 string
    • public_docx_url string
    • public_sfdt_url string
    • public_pdf_url string
    • public_preview_url string
  • 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/{uuid} 
curl \
 --request PUT 'https://api.plannrcrm.com/api/v1/document/6ff8f7f6-1eb3-3525-be4a-3932c805afed' \
 --header "Authorization: Bearer $ACCESS_TOKEN" \
 --header "Content-Type: application/json" \
 --header "X-PLANNR-ACCOUNT-UUID: {YOUR_PLANNR_ACCOUNT_UUID}" \
 --data '{
  "name": "Client Service Agreement",
  "client_uuids": [
    "7c31d2af-f8ac-4fca-846a-48307854fcc5",
    "655ee548-b4a7-4527-bfb9-129314981bb0",
    "afed5a5b-7e8e-4a99-9edc-4a8f42db51e3"
  ],
  "known_dependants": {
    "client-1": "19bb5c1c-c6c6-49d8-89e9-82036b30aa05"
  }
}'
Request examples 
# Headers
X-PLANNR-ACCOUNT-UUID: {YOUR_PLANNR_ACCOUNT_UUID}

# Payload
{
  "name": "Client Service Agreement",
  "client_uuids": [
    "7c31d2af-f8ac-4fca-846a-48307854fcc5",
    "655ee548-b4a7-4527-bfb9-129314981bb0",
    "afed5a5b-7e8e-4a99-9edc-4a8f42db51e3"
  ],
  "known_dependants": {
    "client-1": "19bb5c1c-c6c6-49d8-89e9-82036b30aa05"
  }
}
Response examples (200) 
[
  {
    "uuid": "0acdebc3-6569-416a-9d52-b60e6079be2a",
    "created_at": "2026-10-08T16:24:03+01:00",
    "updated_at": "2026-10-08T16:24:03+01:00",
    "version": 3,
    "name": "Welcome Template",
    "status": "published",
    "last_publishing_error": "There was an error converting this file to PDF. Please try again later.",
    "required_dependants": {
      "client-1": "client"
    },
    "known_dependants": {
      "client-1": "e52541d9-21c8-4943-853f-bd626791fc4a"
    },
    "public_docx_url": "https://api.plannrcrm.com/document/f44d4c7d-eeeb-4ee5-836a-8d083dca4e33/content/docx?plannr_account_uuid=3be3cf78-df1c-481a-8cad-b3cdbd6962d8",
    "public_sfdt_url": "https://api.plannrcrm.com/document/f74265c3-954c-4076-b3c7-7489ca19baf4/content/sfdt?plannr_account_uuid=5be9092e-f3db-4229-946f-5dfcade044b4",
    "public_pdf_url": "https://api.plannrcrm.com/document/74a9b107-9be4-4844-93cc-bd9ecc49af1b/content/pdf?plannr_account_uuid=33f487c9-a32e-4fb9-877f-de9889ffdb5d",
    "public_preview_url": "https://api.plannrcrm.com/document/b0e34a39-c084-4cb4-bf08-63db88266187/content/preview?plannr_account_uuid=9ea11056-ad3c-4268-a908-ee4ce4921616"
  }
]
Response examples (422) 
{
  "message": "The given data was invalid.",
  "errors": {
    "field": [
      "The field is invalid."
    ]
  }
}