Create 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
Personal access token & O auth2

Headers

  • X-PLANNR-ACCOUNT-UUID string
application/json

Body

  • name string Required

    The name of the document.

  • client_uuids array[string(uuid)] Required

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

  • template_uuid string(uuid)

    The UUID of the document template you want to be used with this document. You must not provide the sfdt or docx fields when creating from a template.

  • known_dependants object

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

    Additional properties are allowed.

Responses

  • 201 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
POST /api/v1/document 
curl \
 --request POST 'https://api.plannrcrm.com/api/v1/document' \
 --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": [
    "56083a58-d6f4-4e43-87c5-4f0f6dab10f2",
    "bf85fd11-625c-4ac5-ac68-8cc34d55e431",
    "348f27dc-e582-47bf-b03b-d9fa528bf5f9"
  ],
  "template_uuid": "a35b1f6c-59a5-46e3-9bea-f9d5344c48d4",
  "known_dependants": {
    "client-1": "244ed75d-625d-4da8-b985-3e16c6c4569a"
  }
}'
Request examples 
# Headers
X-PLANNR-ACCOUNT-UUID: {YOUR_PLANNR_ACCOUNT_UUID}

# Payload
{
  "name": "Client Service Agreement",
  "client_uuids": [
    "56083a58-d6f4-4e43-87c5-4f0f6dab10f2",
    "bf85fd11-625c-4ac5-ac68-8cc34d55e431",
    "348f27dc-e582-47bf-b03b-d9fa528bf5f9"
  ],
  "template_uuid": "a35b1f6c-59a5-46e3-9bea-f9d5344c48d4",
  "known_dependants": {
    "client-1": "244ed75d-625d-4da8-b985-3e16c6c4569a"
  }
}
Response examples (201) 
[
  {
    "uuid": "fa93bbf2-cffc-440e-949d-489563894cbd",
    "created_at": "2026-10-08T11:55:17+01:00",
    "updated_at": "2026-10-08T11:55:17+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": "fa1494c9-0ed8-46fd-9413-9f1027f923a3"
    },
    "public_docx_url": "https://api.plannrcrm.com/document/db524028-9df3-4997-81f7-adc48fdd054f/content/docx?plannr_account_uuid=16ebb0dc-de84-415f-b6e3-7bf769145c08",
    "public_sfdt_url": "https://api.plannrcrm.com/document/f1f343a5-d5f2-4c36-9ca3-ad0d97df3054/content/sfdt?plannr_account_uuid=93ba5b11-e61c-4e46-b07a-e65efbc51bb2",
    "public_pdf_url": "https://api.plannrcrm.com/document/6d24f6ed-03cc-448b-ac9c-00383834bdc6/content/pdf?plannr_account_uuid=85d8e88d-ffd5-4a20-98c6-752a03fc9a5f",
    "public_preview_url": "https://api.plannrcrm.com/document/e13a4f35-2a99-4d67-9a49-3d31643c03d5/content/preview?plannr_account_uuid=a5567e95-9580-4c7f-bbc0-9a3c11ed3a70"
  }
]
Response examples (422) 
{
  "message": "The given data was invalid.",
  "errors": {
    "field": [
      "The field is invalid."
    ]
  }
}