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":["8277df17-f8dc-4f4a-9184-d58b72449914","1b164492-ac06-4576-8f7b-e92a8ada10f8"],"known_dependants":[{"client-1":"831fd76f-6a8f-47b9-8096-ae44869ab728"}]}'
Request examples
# Headers
X-PLANNR-ACCOUNT-UUID: {YOUR_PLANNR_ACCOUNT_UUID}
# Payload
{
"name": "Client Service Agreement",
"client_uuids": [
"8277df17-f8dc-4f4a-9184-d58b72449914",
"1b164492-ac06-4576-8f7b-e92a8ada10f8"
],
"known_dependants": [
{
"client-1": "831fd76f-6a8f-47b9-8096-ae44869ab728"
}
]
}
Response examples (200)
{
"name": "Welcome Template",
"uuid": "63f880fb-933b-4948-a4eb-f09f176f13c8",
"status": "published",
"version": 3,
"created_at": "2025-10-08T10:40:15+01:00",
"updated_at": "2025-10-08T10:40:15+01:00",
"public_pdf_url": "https://api.plannrcrm.com/document/129f281f-2c93-46bb-8cd5-fa6ea9b56e6d/content/pdf?plannr_account_uuid=2499816e-9b6e-4c29-a45b-6f8449679cff",
"public_docx_url": "https://api.plannrcrm.com/document/97b7fc4d-a7fe-4617-affa-9e04ef5f70f2/content/docx?plannr_account_uuid=976efc17-d589-45ed-864c-00024593fbdb",
"public_sfdt_url": "https://api.plannrcrm.com/document/26dc1c62-1b98-4d80-a462-8abdea53b99a/content/sfdt?plannr_account_uuid=ee0e72ee-cf2d-454e-a38b-ddcab8d82b33",
"known_dependants": {
"client-1": "fd555208-f84b-405e-8e8a-817a04397a1a"
},
"public_preview_url": "https://api.plannrcrm.com/document/1d9580fc-cfec-4e41-832e-dbba3c47da3e/content/preview?plannr_account_uuid=7fbead85-4bee-456f-9730-ff24ed6b431b",
"required_dependants": {
"client-1": "client"
},
"last_publishing_error": "There was an error converting this file to PDF. Please try again later."
}