Config

Template Rendered with Customer data_Retrieve a Template

Render Template including Customer data.Retrieves the rendered Template with the given Template ID and Customer ID.

get/admin/config/templates/{template_id}-render-{customer_id}

Request

  • Base URL: https://demo.splynx.com/api/2.0
  • URL: https://demo.splynx.com/api/2.0/admin/config/templates/{template_id}-render-{customer_id}
  • Auth: HTTP basic

Path parameters

template_idnumber double required
Example:40

The ID of the desired Template.

customer_idnumber double required
Example:1

The ID of the Customer or Lead.

Query parameters

paramsobject

Optional custom data passed to the template render. In addition to the standard placeholders available for the template type, you can supply an array of key => value pairs — each key becomes a placeholder usable in the template, e.g. params[greeting]=Hello renders as {{ greeting }}. Nested keys are supported (params[order][number]=1024 renders as {{ order.number }}). Passed as a query object.

Example: params[greeting]=Hello&params[order][number]=1024.

{
  "greeting": "Hello",
  "order": {
    "number": 1024
  }
}

Response

resultstring

Rendered Template

Example response

{
  "result": "Rendered Template"
}

Changes

No recorded changes to this operation across all 1 revision of this API.