• getList Styles
• getGet Style
• putPut Style
• getList Templates
• getGet Template Sample Data
• putPut Sample Data
• getGet Sample Data
• getGet Template Documentation
• postRender Template
• postPreview Template
• getGet Template
• putPut Template
• delDelete Template

API docs by Redocly

Template Service (2.0.0)

Download OpenAPI specification:Download

Template Service API

List Styles

Get all styles

header Parameters

tenant required

string (Tenant)

Responses

Production environment

/v0/d/templates/styles

Staging environment

/v0/d/templates/styles

Platform internal

/templates/styles

Response samples

• 200
• 422

Content type

application/json

{

• "data": [

  • {

    • "name": "string"

    }

  ]

}

Get Style

Get style

path Parameters

style_name required

string (Style Name)

header Parameters

tenant required

string (Tenant)

Responses

Production environment

/v0/d/templates/styles/{style_name}

Staging environment

/v0/d/templates/styles/{style_name}

Platform internal

/templates/styles/{style_name}

Response samples

• 422

Content type

application/json

{

• "detail": [

  • {

    • "loc": [

      • "string"

      ],
    • "msg": "string",
    • "type": "string"

    }

  ]

}

Put Style

Update style

path Parameters

style_name required

string (Style Name)

header Parameters

content-type required	any (ContentTypeHeader) Value: "application/json" An enumeration.
tenant required	string (Tenant)

Request Body schema: application/json

style_name	string (Style Name) Name of the style
content required	string (Content) Content of the style

Responses

Production environment

/v0/d/templates/styles/{style_name}

Staging environment

/v0/d/templates/styles/{style_name}

Platform internal

/templates/styles/{style_name}

Request samples

• Payload

Content type

application/json

{

• "style_name": "string",
• "content": "string"

}

Response samples

• 422

Content type

application/json

{

• "detail": [

  • {

    • "loc": [

      • "string"

      ],
    • "msg": "string",
    • "type": "string"

    }

  ]

}

List Templates

Get all templates

header Parameters

tenant required

string (Tenant)

Responses

Production environment

/v0/d/templates/templates

Staging environment

/v0/d/templates/templates

Platform internal

/templates/templates

Response samples

• 200
• 422

Content type

application/json

{

• "data": [

  • {

    • "id": "string",
    • "updated_at": "string",
    • "locale": "en_US",
    • "isDefault": true

    }

  ]

}

Get Template Sample Data

Get template sample data

path Parameters

template_id required

string (Template Id)

Responses

Production environment

/v0/d/templates/templates/{template_id}/sample_data

Staging environment

/v0/d/templates/templates/{template_id}/sample_data

Platform internal

/templates/templates/{template_id}/sample_data

Response samples

• 200
• 422

Content type

application/json

{ }

Put Sample Data

Update sample data by locale

path Parameters

template_id required	string (Template ID)
locale required	string (Locale)

header Parameters

Tenant required

string (Tenant)

Request Body schema: text/plain

The sample data as plain text.

string

Responses

Production environment

/v0/d/templates/templates/{template_id}/localization/{locale}/sample_data

Staging environment

/v0/d/templates/templates/{template_id}/localization/{locale}/sample_data

Platform internal

/templates/templates/{template_id}/localization/{locale}/sample_data

Response samples

• 200
• 422

Content type

application/json

null

Get Sample Data

Get sample data by locale

path Parameters

template_id required	string (Template Id)
locale required	string (Locale)

header Parameters

Tenant required

string (Tenant)

Responses

Production environment

/v0/d/templates/templates/{template_id}/localization/{locale}/sample_data

Staging environment

/v0/d/templates/templates/{template_id}/localization/{locale}/sample_data

Platform internal

/templates/templates/{template_id}/localization/{locale}/sample_data

Response samples

• 200

Content type

application/json

{ }

Get Template Documentation

Get template documentation

path Parameters

template_id required

string (Template Id)

header Parameters

tenant required

string (Tenant)

Responses

Production environment

/v0/d/templates/templates/{template_id}/documentation

Staging environment

/v0/d/templates/templates/{template_id}/documentation

Platform internal

/templates/templates/{template_id}/documentation

Response samples

• 422

Content type

application/json

{

• "detail": [

  • {

    • "loc": [

      • "string"

      ],
    • "msg": "string",
    • "type": "string"

    }

  ]

}

Render Template

Render template

path Parameters

template_id required

string (Template Id)

header Parameters

content-type required	any (ContentTypeHeader) Value: "application/json" An enumeration.
tenant required	string (Tenant)

Request Body schema: application/json

locale	string (Locale) Locale to use for rendering. If not specified, the default locale (en_US) will be used. A locale is defined by a language and country separated by an underscore. Example locales are en_US, en_UK, de_DE, de_AT, fr_FR, fr_CA, da_DK, jp_JP.
data required	object (Data) Data to use for rendering
content_type	string (ContentTypes) Enum: "html" "pdf" "text" Can be either pdf, html or text
ttl	string (Time to live) Time to live in days, will be kept indefinitely if not set.

Responses

Production environment

/v0/d/templates/templates/{template_id}/render

Staging environment

/v0/d/templates/templates/{template_id}/render

Platform internal

/templates/templates/{template_id}/render

Request samples

• Payload

Content type

application/json

{

• "locale": "en_US",
• "data": { },
• "content_type": "html",
• "ttl": "string"

}

Response samples

• 200
• 422

Content type

application/json

{

• "content_type": "html",
• "output": "string",
• "permanent_link": "string",
• "s3_params": { },
• "vault_data_id": null

}

Preview Template

Preview template

path Parameters

template_id required

string (Template Id)

header Parameters

content-type required	any (ContentTypeHeader) Value: "application/json" An enumeration.
tenant required	string (Tenant)

Request Body schema: application/json

locale	string (Locale) Locale to use for rendering. If not specified, the default locale (en_US) will be used. A locale is defined by a language and country separated by an underscore. Example locales are en_US, en_UK, de_DE, de_AT, fr_FR, fr_CA, da_DK, jp_JP.
data	object (Data) Template data
content_type	any (ContentTypes) Enum: "html" "pdf" "text" Can be either pdf, html or text
template	string (Template) Template id
style	string (Style) Style to use in the template

Responses

Production environment

/v0/d/templates/templates/{template_id}/preview

Staging environment

/v0/d/templates/templates/{template_id}/preview

Platform internal

/templates/templates/{template_id}/preview

Request samples

• Payload

Content type

application/json

{

• "locale": "en_US",
• "data": { },
• "content_type": "html",
• "template": "string",
• "style": "string"

}

Response samples

• 422

Content type

application/json

{

• "detail": [

  • {

    • "loc": [

      • "string"

      ],
    • "msg": "string",
    • "type": "string"

    }

  ]

}

Get Template

Get template by locale

path Parameters

template_id required	string (Template Id)
locale required	string (Locale)

header Parameters

tenant required

string (Tenant)

Responses

Production environment

/v0/d/templates/templates/{template_id}/localization/{locale}

Staging environment

/v0/d/templates/templates/{template_id}/localization/{locale}

Platform internal

/templates/templates/{template_id}/localization/{locale}

Response samples

• 422

Content type

application/json

{

• "detail": [

  • {

    • "loc": [

      • "string"

      ],
    • "msg": "string",
    • "type": "string"

    }

  ]

}

Put Template

Update template by locale

path Parameters

template_id required	string (Template Id)
locale required	string (Locale)

header Parameters

content-type required	any (ContentTypeHeader) Value: "application/json" An enumeration.
tenant required	string (Tenant)

Responses

Production environment

/v0/d/templates/templates/{template_id}/localization/{locale}

Staging environment

/v0/d/templates/templates/{template_id}/localization/{locale}

Platform internal

/templates/templates/{template_id}/localization/{locale}

Response samples

• 200
• 422

Content type

application/json

null

Delete Template

Delete template by locale

path Parameters

template_id required	string (Template Id)
locale required	string (Locale)

header Parameters

content-type required	any (ContentTypeHeader) Value: "application/json" An enumeration.
tenant required	string (Tenant)

Responses

Production environment

/v0/d/templates/templates/{template_id}/localization/{locale}

Staging environment

/v0/d/templates/templates/{template_id}/localization/{locale}

Platform internal

/templates/templates/{template_id}/localization/{locale}

Response samples

• 200
• 422

Content type

application/json

null