Update DocumentTemplate

PUT

api

crm

documenttemplates

curl --request PUT \
  --url https://spaces.nexudus.com/api/crm/documenttemplates \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "Id": 123,
  "BusinessId": 123,
  "Name": "<string>",
  "TemplateOutputFormat": 123,
  "Editor": 123,
  "DataContext": 123
}
'

import requests

url = "https://spaces.nexudus.com/api/crm/documenttemplates"

payload = {
    "Id": 123,
    "BusinessId": 123,
    "Name": "<string>",
    "TemplateOutputFormat": 123,
    "Editor": 123,
    "DataContext": 123
}
headers = {
    "Authorization": "Basic <encoded-value>",
    "Content-Type": "application/json"
}

response = requests.put(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PUT',
  headers: {Authorization: 'Basic <encoded-value>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    Id: 123,
    BusinessId: 123,
    Name: '<string>',
    TemplateOutputFormat: 123,
    Editor: 123,
    DataContext: 123
  })
};

fetch('https://spaces.nexudus.com/api/crm/documenttemplates', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "Status": 123,
  "Message": "<string>",
  "Value": "<any>",
  "WasSuccessful": true,
  "Errors": [
    {
      "AttemptedValue": "<any>",
      "Message": "<string>",
      "PropertyName": "<string>"
    }
  ]
}

Updates an existing DocumentTemplate record. You must include the Id of the record to update along with all required fields.

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-Edit role.

Enums

eDocumentTemplateFormat — TemplateOutputFormat values

Value	Name
1	Html
2	Word
3	Binary

Request Body

Required Fields

integer

required

The Id of the DocumentTemplate record to update.

integer

required

ID of the required location that owns this document template; only operators linked to that location can see or use it..

string

required

Required name used to identify this document template to operators; also used as the file name of documents generated from it..

integer

required

Selects the generated format: Html, Word (Liquid source converted to a Word document) or Binary (the uploaded BinaryDocument used for mail merge, so it only makes sense together with an uploaded file). Saving a Designer template forces this back to Html..

integer

required

Which editor owns the template: Classic (uploaded Word document merged with TX Text Control, or raw Liquid HTML) or Designer (a design authored in the Document Designer and compiled to Liquid HTML). Designer templates require DataContext and DesignJson, are validated and compiled on every save, and have TemplateOutputFormat forced to Html and any uploaded BinaryDocument cleared..

integer

required

What the template is about: Customer, Contract, Proposal or Booking. Decides which data roots (Location, Customer, Contract, Proposal, Booking) the design can use. Designer templates must set one of the four; saving a Designer template while this is Unspecified is rejected. Classic templates leave it Unspecified..

Optional Fields

string

Liquid HTML source rendered for Classic templates when TemplateOutputFormat is Html or Word. The variables available come from the data context built for the record the document is generated for (Location, Customer, Contract, Proposal and Booking roots), falling back to a small legacy set when no context can be built. For Designer templates this is generated from DesignJson on every save, so any value sent here is overwritten; change DesignJson instead..

string

URL of a new file to upload as the binary document.

boolean

Set to true to remove the current binary document file.

string

Document Designer design (JSON, schema version 1) for Designer templates, holding the blocks, fields, conditions, repeats and signature blocks. Validate it with the document_template_designer tool before saving; the platform validates it again and compiles it into Document (Liquid HTML) on save, and a failed validation aborts the save. Ignored for Classic templates..

Code Examples

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

const response = await fetch(
  'https://spaces.nexudus.com/api/crm/documenttemplates',
  {
    method: 'PUT',
    headers: {
      'Authorization': 'Bearer YOUR_TOKEN',
      'Content-Type': 'application/json'
    },
    body: JSON.stringify({
      BusinessId: 0,
      Name: '',
      TemplateOutputFormat: 0,
      Editor: 0,
      DataContext: 0,
      Id: 87654321
    })
  }
);

const data = await response.json();

import requests

response = requests.put(
    'https://spaces.nexudus.com/api/crm/documenttemplates',
    headers={
        'Authorization': 'Bearer YOUR_TOKEN',
        'Content-Type': 'application/json'
    },
    json={
        'BusinessId': 0,
        'Name': '',
        'TemplateOutputFormat': 0,
        'Editor': 0,
        'DataContext': 0,
        'Id': 87654321
    }
)

data = response.json()

Response

200

integer

HTTP status code. 200 on success.

string

A human-readable message confirming the update.

object

Contains the Id of the updated record.

boolean

true if the documenttemplate was updated successfully.

array

null on success.

Example Response

{
  "Status": 200,
  "Message": "DocumentTemplate was successfully updated.",
  "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

string

A summary of the validation error(s), in the format PropertyName: error message.

any

null on validation failure.

object[]

Array of validation errors.

Show child attributes

any

The value that was submitted for the field, or null if missing.

string

The validation error message.

string

The name of the property that failed validation.

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
}

Update DocumentTemplate

curl --request PUT \
  --url https://spaces.nexudus.com/api/crm/documenttemplates \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "Id": 123,
  "BusinessId": 123,
  "Name": "<string>",
  "TemplateOutputFormat": 123,
  "Editor": 123,
  "DataContext": 123
}
'

import requests

url = "https://spaces.nexudus.com/api/crm/documenttemplates"

payload = {
    "Id": 123,
    "BusinessId": 123,
    "Name": "<string>",
    "TemplateOutputFormat": 123,
    "Editor": 123,
    "DataContext": 123
}
headers = {
    "Authorization": "Basic <encoded-value>",
    "Content-Type": "application/json"
}

response = requests.put(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PUT',
  headers: {Authorization: 'Basic <encoded-value>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    Id: 123,
    BusinessId: 123,
    Name: '<string>',
    TemplateOutputFormat: 123,
    Editor: 123,
    DataContext: 123
  })
};

fetch('https://spaces.nexudus.com/api/crm/documenttemplates', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "Status": 123,
  "Message": "<string>",
  "Value": "<any>",
  "WasSuccessful": true,
  "Errors": [
    {
      "AttemptedValue": "<any>",
      "Message": "<string>",
      "PropertyName": "<string>"
    }
  ]
}

Overview

Apps & Marketplace

Billing

Collaboration

Community

Content

CRM

Security

Spaces

Support

System

Authentication

Enums

Request Body

Required Fields

Optional Fields

Code Examples

Response

200

400

​Authentication

​Enums

​Request Body

​Required Fields

​Optional Fields

​Code Examples

​Response

​200

​400

Authentication

Enums

Request Body

Required Fields

Optional Fields

Code Examples

Response

200

400