Endpoints

Return rendered template

Return a template rendered for different resources and languages

PUT

/v1/templates/render

curl --request PUT \
  --url https://public-api.bladepro.io/v1/templates/render \
  --header 'Content-Type: application/json' \
  --data '
{
  "locales": "<any>",
  "resource_ids": "<any>",
  "template_id": 123
}
'

{
  "data": {
    "created": "2019-11-25T14:52:56.000Z",
    "id": 1,
    "modified": "2019-11-25T14:52:56.000Z",
    "name": "Default despatch note",
    "organisation_id": 1,
    "status": "portrait",
    "template_category_code": "DESPATCH_NOTE",
    "template_category_id": 1
  },
  "meta": {
    "request_reference": "233f2gjwz-c893v86"
  }
}

Scope(s): APP::TEMPLATES::READ

Body

localesanyrequired

List of resource ID's.

resource_idsanyrequired

List of resource ID's.

template_idintegerrequired

ID of template.

Response

successful operation

createdany

Created date in BladePRO.

idnumber

ID of the template.

modifiedany

Last modified date in BladePRO.

namestring

Name of the template.

organisation_idnumber

ID of the organisation.

statusenum<string>

Orientation.

Available options: portrait, landscape

template_category_codenumber

Code of the template category.

template_category_idnumber

ID of the template category.

Still need help? Share an idea