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":["3146bfb6-d865-4982-b313-42bf8ac2e742","60ce92e0-f100-41b9-b154-eeca84c21a7b"],"known_dependants":[{"client-1":"f94909bf-e0f9-48bc-a452-91ecfcd6fc3c"}]}'
Request examples
# Headers
X-PLANNR-ACCOUNT-UUID: {YOUR_PLANNR_ACCOUNT_UUID}
# Payload
{
"name": "Client Service Agreement",
"client_uuids": [
"3146bfb6-d865-4982-b313-42bf8ac2e742",
"60ce92e0-f100-41b9-b154-eeca84c21a7b"
],
"known_dependants": [
{
"client-1": "f94909bf-e0f9-48bc-a452-91ecfcd6fc3c"
}
]
}
Response examples (200)
{
"name": "Welcome Template",
"uuid": "4235eb10-c1b7-4fc7-9299-fbf09a49d4a6",
"status": "published",
"version": 3,
"created_at": "2025-08-07T13:41:43+01:00",
"updated_at": "2025-08-07T13:41:43+01:00",
"public_pdf_url": "https://api.plannrcrm.com/document/f8273e34-16d5-4f8b-89d2-18e9c348da63/content/pdf?plannr_account_uuid=fd6dd605-8984-4329-bc74-5cb49fa71795",
"public_docx_url": "https://api.plannrcrm.com/document/bb025b72-cd65-428a-94cd-2223e6efc73a/content/docx?plannr_account_uuid=03a3a884-3e4d-4666-b227-933a17c7f2ea",
"public_sfdt_url": "https://api.plannrcrm.com/document/47f0521d-b377-4899-a69e-4a2914a84076/content/sfdt?plannr_account_uuid=9f31b288-7ba2-4deb-bd37-34a5b3d8534a",
"known_dependants": {
"client-1": "0e22bc47-da2c-4994-9bad-320221b639cb"
},
"public_preview_url": "https://api.plannrcrm.com/document/5594c6c8-9d9c-4b4d-acc4-f8c502d4ab81/content/preview?plannr_account_uuid=e3b255e3-8093-4644-a290-e2b2aa6091f3",
"required_dependants": {
"client-1": "client"
},
"last_publishing_error": "There was an error converting this file to PDF. Please try again later."
}