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":["815d82c4-052c-442c-aae8-fff6358165b2","d0954a3e-db21-455b-ad59-be3e2a176e4a"],"known_dependants":[{"client-1":"08a0db0c-4282-47c3-b14c-33de77ef0105"}]}'
Request examples
# Headers
X-PLANNR-ACCOUNT-UUID: {YOUR_PLANNR_ACCOUNT_UUID}
# Payload
{
"name": "Client Service Agreement",
"client_uuids": [
"815d82c4-052c-442c-aae8-fff6358165b2",
"d0954a3e-db21-455b-ad59-be3e2a176e4a"
],
"known_dependants": [
{
"client-1": "08a0db0c-4282-47c3-b14c-33de77ef0105"
}
]
}
Response examples (200)
{
"name": "Welcome Template",
"uuid": "8956f764-eda6-4f01-aa73-fac369f9f0fd",
"status": "published",
"version": 3,
"created_at": "2025-08-27T17:31:26+01:00",
"updated_at": "2025-08-27T17:31:26+01:00",
"public_pdf_url": "https://api.plannrcrm.com/document/fd1d8536-1271-4037-90f6-22ac80c9e002/content/pdf?plannr_account_uuid=59bae8c0-b5d4-46e9-ae90-c8c594779b82",
"public_docx_url": "https://api.plannrcrm.com/document/e01e1f19-a387-445e-b8ce-137af07f3544/content/docx?plannr_account_uuid=98dbb36f-d3c0-4b52-86a3-612a64b9f824",
"public_sfdt_url": "https://api.plannrcrm.com/document/53ffc80e-f50c-4bfa-a207-c2482e4c6943/content/sfdt?plannr_account_uuid=a101f41b-2d5d-4edf-b741-6eb0186f243c",
"known_dependants": {
"client-1": "da1cb687-110e-41c3-97e6-a37e35e594d2"
},
"public_preview_url": "https://api.plannrcrm.com/document/3b178595-15fe-46b6-925a-709fc493939a/content/preview?plannr_account_uuid=659e6ea7-b3f7-457e-bb29-8cac4a02f5e8",
"required_dependants": {
"client-1": "client"
},
"last_publishing_error": "There was an error converting this file to PDF. Please try again later."
}