Publish a document
This will make the document un-editable and will upload a DOCX and PDF file to the client.
Headers
-
Content-Type
string -
Accept
string -
X-PLANNR-ACCOUNT-UUID
string
Path parameters
-
document_uuid
string Required
POST
/api/v1/document/{document_uuid}/publish
curl \
--request POST 'https://api.plannrcrm.com/api/v1/document/document_uuid/publish' \
--header "Authorization: Bearer {OAUTH_ACCESS_TOKEN or PERSONAL_ACCESS_TOKEN}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--header "X-PLANNR-ACCOUNT-UUID: {YOUR_PLANNR_ACCOUNT_UUID}"
Response examples (200)
{
"name": "Welcome Template",
"uuid": "8899acea-d4b1-4861-a27b-9614033c26f2",
"status": "published",
"version": 3,
"created_at": "2025-04-22T13:44:19+01:00",
"updated_at": "2025-04-22T13:44:19+01:00",
"public_pdf_url": "https://plannr.valet/document/ad9be5f0-983e-41ef-bfd6-02f0a77b79f5/content/pdf?plannr_account_uuid=94e5dbd3-e0e7-4373-9540-e35fc66ac4dc",
"public_docx_url": "https://plannr.valet/document/7247e444-8d36-49d3-893b-4a012d438150/content/docx?plannr_account_uuid=332c250a-d5e8-4365-9103-8eb169253b65",
"public_sfdt_url": "https://plannr.valet/document/dd57fa06-433e-4cfd-8f45-ea8f5b77484f/content/sfdt?plannr_account_uuid=e3f1e0ac-2e9e-4c32-ae30-66b72fbb0ef9",
"known_dependants": {
"client-1": "83f29da0-0179-4bc1-bcf3-9baaeb3d21e5"
},
"public_preview_url": "https://plannr.valet/document/47059a3a-d482-49e7-ad44-fa99fbfb195c/content/preview?plannr_account_uuid=f53bc39e-ff43-4a8c-8d49-8fcd00b069ad",
"required_dependants": {
"client-1": "client"
},
"last_publishing_error": "There was an error converting this file to PDF. Please try again later."
}