Render image from HTML (v1)

Last modified: March 06, 2024

This endpoint allows you to create images based on a template designed in HTML Template Editor.

This endpoint has been deprecated. Please use Render Image v2 instead.

POST Endpoint

Example request

    --request POST '' \
    --header 'X-API-KEY: <API_KEY>' \
    --header 'Content-Type: application/json' \
    --data-raw '{
        "template": "<TEMPLATE_ID>",
        "mergeFields": {
            "myMergeTag": "My HTML Editor Value"
            "myArray": [

Request body

  • template (required) - template identifier,
  • mergeFields (optional) - values for merge fields for given template,
  • expires (optional) - link expiration time in seconds, available values from 1 to 604800,
  • webhookUrl (optional) - send response to the given URL as a POST request
  • metadata (optional) - any JSON object, can be used as metadata container

Successful response

  "requestId": "febbd34c-cadf-43e6-926c-5942016aea4e",
  "href": ""

GET Endpoint

Use Query String notation in order to provide changes.

Sample request!&

Please note that only the first change element is separated with ? (question mark) and all other changes must be separated with & (ampersand).