Publish 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
POST /api/v1/document/{document_uuid}/publish

This will make the document un-editable and will upload a DOCX and PDF file to the client.

Headers

  • X-PLANNR-ACCOUNT-UUID string

Path parameters

  • document_uuid string Required

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
POST /api/v1/document/{document_uuid}/publish
curl \
 --request POST 'https://api.plannrcrm.com/api/v1/document/6ff8f7f6-1eb3-3525-be4a-3932c805afed/publish' \
 --header "Authorization: Bearer $ACCESS_TOKEN" \
 --header "X-PLANNR-ACCOUNT-UUID: {YOUR_PLANNR_ACCOUNT_UUID}"
Response examples (200)
[
  {
    "uuid": "5e5a3964-4714-431c-92e8-d09a3783add6",
    "created_at": "2026-08-28T07:34:59+01:00",
    "updated_at": "2026-08-28T07:34:59+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": "30ae1424-56a3-419e-a938-0abfbb8a955e"
    },
    "public_docx_url": "https://api.plannrcrm.com/document/fc15aadf-cc9f-429b-9ad4-9dfedc57fa53/content/docx?plannr_account_uuid=befcf782-a30d-49ca-b6dd-2e59e8bd1cba",
    "public_sfdt_url": "https://api.plannrcrm.com/document/9281f88f-5fa7-485f-b47e-9a59406a55b3/content/sfdt?plannr_account_uuid=1734d0e1-048f-492b-ad9a-2a87e313ebf5",
    "public_pdf_url": "https://api.plannrcrm.com/document/8709221a-e329-4a7e-b1e0-2f200196f545/content/pdf?plannr_account_uuid=f2c455b2-bc12-4395-a3bc-07d8fbeff822",
    "public_preview_url": "https://api.plannrcrm.com/document/f8fbbd50-40ff-47eb-8abd-e006a25d230f/content/preview?plannr_account_uuid=7e1c4687-2c80-43c7-8afe-160fe4fbcf7d"
  }
]