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 \
--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":["6ab3a3da-a02d-46b2-9ccc-ff5692e1c484","7843a036-ea75-409e-a984-64ff1496e344"],"known_dependants":[{"client-1":"66660c21-f68d-4b95-876a-15852efdba88"}]}'
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": [
"6ab3a3da-a02d-46b2-9ccc-ff5692e1c484",
"7843a036-ea75-409e-a984-64ff1496e344"
],
"known_dependants": [
{
"client-1": "66660c21-f68d-4b95-876a-15852efdba88"
}
]
}
Response examples (200)
{
"name": "Welcome Template",
"uuid": "ec56fe8e-dd57-4c95-8c9a-4f60249b456f",
"status": "published",
"version": 3,
"created_at": "2025-02-20T10:13:03+00:00",
"updated_at": "2025-02-20T10:13:03+00:00",
"public_pdf_url": "https://plannr.valet/document/80751f44-7308-47b1-80bc-096237a27331/content/pdf?plannr_account_uuid=985b65e2-364f-4c9f-9c6f-bab06b906119",
"public_docx_url": "https://plannr.valet/document/1075308d-cff3-4fa7-a619-1292e07d408a/content/docx?plannr_account_uuid=9434c709-677d-4dfe-b878-0164644c26da",
"public_sfdt_url": "https://plannr.valet/document/d22da2a2-23ea-47ed-ae13-69ee9d8a2598/content/sfdt?plannr_account_uuid=7fc53542-a71f-410d-84db-efad41c4e746",
"known_dependants": {
"client-1": "458eea17-b100-4179-bcf7-2910bcca7260"
},
"public_preview_url": "https://plannr.valet/document/8637c0ff-a88b-4cfa-9c5d-ee890be0765b/content/preview?plannr_account_uuid=2d49c536-b8ec-44a5-8b2f-5142090037e8",
"required_dependants": {
"client-1": "client"
}
}