Headers
-
Content-Type string
-
Accept string
-
X-PLANNR-ACCOUNT-UUID string
Body Required
-
The name of the document.
-
An array containing the client uuids that should be sent the document when it is built.
-
template_uuid string
The UUID of the document template you want to be used with this document. You must not provide the sfdt or docx fields when creating from a template.
-
known_dependants array[string]
Optional: The document variable dependants. Used to swap variables out for real data.
POST
/api/v1/document
curl \
--request POST https://api.plannrcrm.com/api/v1/document \
--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":["9c1718e2-051e-4cc3-9fe5-525853d2d6ce","4206623f-1b15-4160-8be7-03ee54364171"],"template_uuid":"6e2bf5f0-bbc1-441f-978c-d74d6a90c4f1","known_dependants":[{"client-1":"a48f3c07-68c4-4109-b0ee-95756337114f"}]}'
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": [
"9c1718e2-051e-4cc3-9fe5-525853d2d6ce",
"4206623f-1b15-4160-8be7-03ee54364171"
],
"template_uuid": "6e2bf5f0-bbc1-441f-978c-d74d6a90c4f1",
"known_dependants": [
{
"client-1": "a48f3c07-68c4-4109-b0ee-95756337114f"
}
]
}
Response examples (201)
{
"name": "Welcome Template",
"uuid": "d0cee622-c0e8-478a-93f9-03286260ae8b",
"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/481355ec-254d-4ea7-ad88-12bdcc15f75f/content/pdf?plannr_account_uuid=6d98d08b-80f1-4553-8283-6ec851c4d087",
"public_docx_url": "https://plannr.valet/document/2fef539e-50bb-4eee-86bd-58cace953c3c/content/docx?plannr_account_uuid=12a06ecb-b415-4a95-b081-16976d950c85",
"public_sfdt_url": "https://plannr.valet/document/48c5ade4-01b8-4e23-b479-edb49ef0e2db/content/sfdt?plannr_account_uuid=f5b2398e-9ec4-417c-bd6d-e4853127fee7",
"known_dependants": {
"client-1": "8e8a03f6-0ef0-49e4-a268-24520a3c2967"
},
"public_preview_url": "https://plannr.valet/document/b2c169a1-e058-4c71-bbc8-9c79274f7303/content/preview?plannr_account_uuid=2222cb11-47cd-4263-8685-f297a4dd4f3a",
"required_dependants": {
"client-1": "client"
}
}