Skip to main content
POST
/
api
/
crm
/
documenttemplates
Create DocumentTemplate
curl --request POST \
  --url https://spaces.nexudus.com/api/crm/documenttemplates \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "BusinessId": 123,
  "Name": "<string>",
  "TemplateOutputFormat": 123
}
'
{
  "Status": 123,
  "Message": "<string>",
  "Value": "<any>",
  "WasSuccessful": true,
  "Errors": [
    {
      "AttemptedValue": "<any>",
      "Message": "<string>",
      "PropertyName": "<string>"
    }
  ]
}
A DocumentTemplate defines a reusable template for generating documents such as contracts, proposals, or invoices. Templates support HTML, Word, and binary output formats and can include dynamic merge fields populated from customer and business data.

​
Authentication

This endpoint requires OAuth2 authentication. Include a valid bearer token in the Authorization header. The authenticated user must be a full unrestricted administrator or have the DocumentTemplate-Create role.

​
Enums

ValueName
1Html
2Word
3Binary

​
Request Body

​
Required Fields

​
BusinessId
integer
required
ID of the business linked to this record.
​
Name
string
required
The name value for this document template.
​
TemplateOutputFormat
integer
required
The template output format value for this document template.

​
Optional Fields

​
Document
string
The document value for this document template.
​
NewBinaryDocumentUrl
string
URL of a new file to upload as the binary document.
​
ClearBinaryDocumentFile
boolean
Set to true to remove the current binary document file.

​
Code Examples

curl -X POST \
  "https://spaces.nexudus.com/api/crm/documenttemplates" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "BusinessId": 0,
    "Name": "",
    "TemplateOutputFormat": 0
}'

​
Response

​
200

​
Status
integer
HTTP status code. 200 on success.
​
Message
string
A human-readable message confirming the creation.
​
Value
object
Contains the Id of the newly created record.
​
WasSuccessful
boolean
true if the documenttemplate was created successfully.
​
Errors
array
null on success.
Example Response
{
  "Status": 200,
  "Message": "DocumentTemplate was successfully created.",
  "Value": {
    "Id": 87654321
  },
  "OpenInDialog": false,
  "OpenInWindow": false,
  "RedirectURL": null,
  "JavaScript": null,
  "UpdatedOn": "2025-01-15T10:30:00Z",
  "UpdatedBy": "admin@example.com",
  "Errors": null,
  "WasSuccessful": true
}

​
400

​
Message
string
A summary of the validation error(s), in the format PropertyName: error message.
​
Value
any
null on validation failure.
​
Errors
object[]
Array of validation errors.
​
WasSuccessful
boolean
false when the request fails validation.
Example Response
{
  "Message": "Name: is a required field",
  "Value": null,
  "Errors": [
    {
      "AttemptedValue": null,
      "Message": "is a required field",
      "PropertyName": "Name"
    }
  ],
  "WasSuccessful": false
}