Create a document template

POST /api/v1/document-template

Personal access token & O auth2

Headers

X-PLANNR-ACCOUNT-UUID string

application/json

Body Required

name string Required

The name of the document template.

Responses

201 application/json
Hide response attributes Show response attributes object
- uuid string
  
  The UUID of the resource.
- created_at string
  
  The timestamp of when the resource was created.
- updated_at string
  
  The timestamp of when the resource was updated.
- version integer
  
  The document builder version. Used for internal purposes only. Defaults to 3
- name string
  
  The name of the document template.
- required_dependants object
  
  The required dependant variables of the document template.
  
  Hide required_dependants attribute Show required_dependants attribute object
  
  client-1 string
- public_docx_url string
  
  The download URL of the DOCX content. This is intended for the user to download if they are signed into Plannr. You can access this data via the API using the route in /api/v1.
- public_sfdt_url string
  
  The download URL of the SFDT (SyncFusion) content. This is intended for the user to download if they are signed into Plannr. You can access this data via the API using the route in /api/v1.
- public_pdf_url string
  
  The download URL of the PDF content. This is intended for the user to download if they are signed into Plannr. You can access this data via the API using the route in /api/v1.
- public_preview_url string
  
  The image preview URL of the template. This is intended for the user to preview the template before opening it. You can access this data via the API using the route in /api/v1.

POST /api/v1/document-template

curl \
 --request POST 'https://api.plannrcrm.com/api/v1/document-template' \
 --header "Authorization: Bearer $ACCESS_TOKEN" \
 --header "Content-Type: application/json" \
 --header "X-PLANNR-ACCOUNT-UUID: {YOUR_PLANNR_ACCOUNT_UUID}" \
 --data '{"name":"Client Service Agreement"}'

Request examples

# Headers
X-PLANNR-ACCOUNT-UUID: {YOUR_PLANNR_ACCOUNT_UUID}

# Payload
{
  "name": "Client Service Agreement"
}

Response examples (201)

{
  "name": "Welcome Template",
  "uuid": "5165c9cd-da3b-49a7-a5e5-802fb11edb49",
  "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-template/35fbb4f1-019a-4c67-8a39-184cb5f263a5/content/pdf?plannr_account_uuid=3c6add29-3d93-4f28-aea7-006519f0e141",
  "public_docx_url": "https://api.plannrcrm.com/document-template/50a4125b-6a96-4064-8858-c0223401a6b6/content/docx?plannr_account_uuid=2d5d298c-e37a-492a-8559-d5c8694651b3",
  "public_sfdt_url": "https://api.plannrcrm.com/document-template/ef2c1455-566f-482d-be61-9bdbb3b8c84f/content/sfdt?plannr_account_uuid=6fcb5f34-0595-4dc2-88c5-47f7885e0490",
  "public_preview_url": "https://api.plannrcrm.com/document-template/93f6e947-6cf1-4e37-ab39-afdc042570ef/content/preview?plannr_account_uuid=4efb071a-4ade-4828-983e-a35371ba7ef9",
  "required_dependants": {
    "client-1": "client"
  }
}