Update a document
Headers
-
Content-Type string
-
Accept string
-
X-PLANNR-ACCOUNT-UUID string
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 \
-X PUT https://api.plannrcrm.com/api/v1/document/uuid \
-H "Authorization: Bearer {OAUTH_ACCESS_TOKEN or PERSONAL_ACCESS_TOKEN}" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "X-PLANNR-ACCOUNT-UUID: {YOUR_PLANNR_ACCOUNT_UUID}" \
-d '{"name":"Client Service Agreement","client_uuids":["77af634d-1967-4461-8f2e-180d94d20b3d","f7e82708-ad4b-4c52-b7a2-9bb2c252352a"],"known_dependants":[{"client-1":"ab60243f-726d-4532-97cb-dd6d931d281b"}]}'
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": [
"77af634d-1967-4461-8f2e-180d94d20b3d",
"f7e82708-ad4b-4c52-b7a2-9bb2c252352a"
],
"known_dependants": [
{
"client-1": "ab60243f-726d-4532-97cb-dd6d931d281b"
}
]
}
Response examples (200)
{
"name": "Welcome Template",
"uuid": "f9081b37-bac0-4027-a7fe-8f5af0ec67d6",
"status": "published",
"version": 3,
"created_at": "2025-01-20T23:10:35+00:00",
"updated_at": "2025-01-20T23:10:35+00:00",
"public_pdf_url": "https://plannr.valet/document/658a5a9d-b315-416b-9ed2-538ee3c813e0/content/pdf?plannr_account_uuid=88d35086-31ba-40b0-9b50-8610c8d52603",
"public_docx_url": "https://plannr.valet/document/bf784b84-fe3d-4462-802b-07edddfff905/content/docx?plannr_account_uuid=2ca31202-5236-4b19-ad4d-63c70d8f5750",
"public_sfdt_url": "https://plannr.valet/document/c962d03f-7c0a-4e4a-9e11-09811fe372ac/content/sfdt?plannr_account_uuid=0cd1a2aa-6c14-448c-a7d7-e71bd9c0b447",
"known_dependants": {
"client-1": "fe01285c-778b-4146-9286-76e02c06003f"
},
"public_preview_url": "https://plannr.valet/document/eb110c71-5102-4ecb-a8ef-8e6a00c60139/content/preview?plannr_account_uuid=c4e49292-32cb-4e50-bc0b-bac82c1ebd0e",
"required_dependants": {
"client-1": "client"
}
}