Templates

The Template object provides functionality for templates to be made and automatically delivered once a set of rules based on type is met. This enables the client to know what is happening with their order and if anything is needed of them.

The Template object contains the following properties:

Field
Type
Description

id

string

The template's ID.

Example: TPL-1234-5678

href

string

A relative reference to the object in the API.

Example: v1/products/PRD-1234-1234/templates/TPL-1234-5678-0001

name

string

The name of the template.

Example: Thank you for your interest.

type

string

The type of template.

Example: RequestProcessing

content

string

The content of the template.

Example:

<p>We are delighted that you have contacted us at SoftwareOne. Your interest in the Microsoft 365 Online Services product is greatly valued, and we are here to provide all the support you need. Our dedicated team is actively working on your query, and we are committed to responding within 24 hours. \n Thank you!!!<p>

default

boolean

  • Each product has 4 defaults automatically generated upon product creation (against each status).

  • Each template automatically created has a default system message that the client account will need to update.

  • The default cannot be deleted, but non-default can be deleted.

Example: true

product

A reference to the Product object.

Example:

{
    "id": "PRD-1111-1111-1111",
    "name": "Microsoft Office 365 NCE",
    "icon": "/static/PRD-1111-1111-1111/logo.png"
} 

audit

A reference to the Audit object.

Example

{
  "id": "TPL-1234-5678-0001",
  "name": "Thank you for your interest",
  "type": "RequestProcessing",
  "content": "We are delighted that you have contacted us at SoftwareOne. Your interest in Microsoft 365 Online Services product is greatly valued, and we are here to provide all the support you need. Our dedicated team is actively working on your query, and we are committed to responding within 24 hours. \n Thank you!!!",
  "isDefault": true,
  "product": {
    "id": "PRD-1234-5678-0001"
  }
}

Last updated

Was this helpful?