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":["e7180fd5-0167-44b5-b0dc-0fb6ffe986c8","5d7b0575-3b72-4dc9-98b4-e12610b4e115"],"known_dependants":[{"client-1":"7482820e-3a06-4e08-8d84-db6e62e29929"}]}'
Request examples
# Headers
X-PLANNR-ACCOUNT-UUID: {YOUR_PLANNR_ACCOUNT_UUID}
# Payload
{
"name": "Client Service Agreement",
"client_uuids": [
"e7180fd5-0167-44b5-b0dc-0fb6ffe986c8",
"5d7b0575-3b72-4dc9-98b4-e12610b4e115"
],
"known_dependants": [
{
"client-1": "7482820e-3a06-4e08-8d84-db6e62e29929"
}
]
}
Response examples (200)
{
"name": "Welcome Template",
"uuid": "1c379517-eb7f-4775-b770-df98f105befc",
"status": "published",
"version": 3,
"created_at": "2025-10-24T10:34:19+01:00",
"updated_at": "2025-10-24T10:34:19+01:00",
"public_pdf_url": "https://api.plannrcrm.com/document/180ebbb0-2574-4795-849d-9330a559f4e5/content/pdf?plannr_account_uuid=574b2d52-5748-4e82-8a93-2ffe66e918d6",
"public_docx_url": "https://api.plannrcrm.com/document/fc596277-205f-4412-a123-2cb2f871394f/content/docx?plannr_account_uuid=fb70f0d4-31d2-4db4-8b4e-a8c9b4ce1d5c",
"public_sfdt_url": "https://api.plannrcrm.com/document/1be79596-d452-4cff-b5b4-7f635b0c91f8/content/sfdt?plannr_account_uuid=8c9d0915-9a40-496e-adbc-9950232743a9",
"known_dependants": {
"client-1": "fecc4e90-f7db-45aa-8232-944e208b29a4"
},
"public_preview_url": "https://api.plannrcrm.com/document/716fd617-b695-4983-a98e-0908a2b78cce/content/preview?plannr_account_uuid=c4f26d90-e35f-451c-8da6-8436b77e39fa",
"required_dependants": {
"client-1": "client"
},
"last_publishing_error": "There was an error converting this file to PDF. Please try again later."
}