Headers
-
Content-Type
string -
Accept
string -
X-PLANNR-ACCOUNT-UUID
string
Path parameters
-
uuid
string Required
Body
-
name
string The name of the document.
-
client_uuids
array[string] An array containing the client uuids that should be sent the document when it is built.
-
known_dependants
array[string] Optional: The document variable dependants. Used to swap variables out for real data.
PUT
/api/v1/document/{uuid}
curl \
--request PUT 'https://api.plannrcrm.com/api/v1/document/uuid' \
--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}" \
--data '{"name":"Client Service Agreement","client_uuids":["caf013d2-d31d-49d2-95e2-d1ddb45bd6c2","ad35b42d-26e4-4316-8f4d-35ee6a7a6c4d"],"known_dependants":[{"client-1":"93b24eba-c556-48b3-bf5e-8a330fce184d"}]}'
Request examples
# Headers
Authorization: Bearer {OAUTH_ACCESS_TOKEN or PERSONAL_ACCESS_TOKEN}
Content-Type: application/json
Accept: application/json
X-PLANNR-ACCOUNT-UUID: {YOUR_PLANNR_ACCOUNT_UUID}
# Payload
{
"name": "Client Service Agreement",
"client_uuids": [
"caf013d2-d31d-49d2-95e2-d1ddb45bd6c2",
"ad35b42d-26e4-4316-8f4d-35ee6a7a6c4d"
],
"known_dependants": [
{
"client-1": "93b24eba-c556-48b3-bf5e-8a330fce184d"
}
]
}
Response examples (200)
{
"name": "Welcome Template",
"uuid": "6ec57fe3-9b71-45e8-8fa5-9abfd5e7e306",
"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/a331660a-43d8-43ec-b393-41e4b9951fc6/content/pdf?plannr_account_uuid=f63af229-e645-4577-a397-4161095e57f3",
"public_docx_url": "https://plannr.valet/document/bdf2aca0-a5cc-45de-ba71-bd7809bf08a5/content/docx?plannr_account_uuid=6ba9b9fe-bd37-4eca-bb80-5d8446056366",
"public_sfdt_url": "https://plannr.valet/document/960d2342-4595-4b83-9944-ada4560c59d9/content/sfdt?plannr_account_uuid=5c900a8b-e412-4508-b71f-181db41de667",
"known_dependants": {
"client-1": "723456a7-6fe9-49ee-85d2-9e57993412ec"
},
"public_preview_url": "https://plannr.valet/document/f0ccc209-1c88-4ef6-8dc3-f942ab973ae0/content/preview?plannr_account_uuid=70dd3270-93a1-4046-a435-d3e1f59d4c73",
"required_dependants": {
"client-1": "client"
},
"last_publishing_error": "There was an error converting this file to PDF. Please try again later."
}