Sign in

v1

latestOpenAPI 3.0.22026-07-12121135.6 KB
Custom Variables

Update custom variable

Update custom variable

put/v1/custom-variables/{id}

Path parameters

idstring required

Custom variable ID

Request body

idstring

ID

type'order_table' | 'custom' | 'journey_link' | 'snippet'

Custom variable type

namestring

Custom variable name

keystring required

The key which is used for Handlebar variable syntax {{key}}

_tagsstring[]

The tags of custom variable

_manifeststring[]

The manifest IDs associated with this custom variable

helper_paramsstring[]

The helper function parameter's names

helper_logicstring

The helper function logic

configobject

Variable configuration

templatestring required

Handlebar template that used to generate the variable content

created_atstring

Creation time

created_bystring

Created by

updated_atstring

Last update time

updated_bystring

Updated by

Example request

{
  "id": "rbse777b-3cf8-4bff-bb0c-253fd1123250",
  "name": "My Custom table",
  "key": "my_custom_table",
  "helper_params": [
    "param1",
    "param2"
  ],
  "helper_logic": "return param1 * param2;",
  "config": {
    "header": null,
    "style": {
      "color": "#222",
      "background": "#fff",
      "font-size": "16px",
      "font-family": "",
      "padding-bottom": "4px",
      "font-weight": "bold",
      "border": "none !important",
      "text-align": "left"
    },
    "columns": [
      {
        "id": "item",
        "index": 0,
        "label": {
          "en": "Item",
          "de": "Produkt"
        },
        "enable": true,
        "draggable": true,
        "style": {
          "padding-left": "10px",
          "max-width": "30%"
        }
      },
      {
        "id": "quantity",
        "index": 1,
        "label": {
          "en": "Quanity",
          "de": "Menge"
        },
        "enable": true,
        "draggable": true,
        "style": {
          "min-width": "60px",
          "width": "30%"
        }
      },
      {
        "id": "tax",
        "index": 2,
        "label": {
          "en": "Tax Rate",
          "de": "Steuerrate"
        },
        "enable": true,
        "draggable": true,
        "style": {
          "min-width": "60px",
          "width": "30%"
        }
      },
      {
        "id": "unit_amount",
        "index": 3,
        "label": {
          "en": "Unit Net Price",
          "de": "Nettopreis"
        },
        "enable": true,
        "draggable": true,
        "style": {
          "min-width": "60px",
          "width": "30%"
        }
      },
      {
        "id": "net_total",
        "index": 4,
        "label": {
          "en": "Net total",
          "de": "Nettosumme"
        },
        "enable": "true,",
        "draggable": true,
        "style": {
          "min-width": "60px",
          "width": "30%"
        }
      },
      {
        "id": "gross_total",
        "index": 5,
        "label": {
          "en": "Total",
          "de": "Gesamt"
        },
        "enable": true,
        "draggable": true,
        "style": {
          "min-width": "60px",
          "width": "30%"
        }
      }
    ],
    "body": {
      "product_name": {
        "parent_column": "item",
        "enable": true,
        "style": {
          "color": "#222",
          "background": "#fff",
          "font-size": "14px",
          "font-family": "",
          "font-weight": "bold",
          "font-style": "normal",
          "padding-top": "16px",
          "padding-bottom": "8px",
          "border": "none !important",
          "vertical-align": "top",
          "text-align": "left",
          "max-width": "30%",
          "padding-left": "10px"
        }
      },
      "price_description": {
        "parent_column": "item",
        "enable": true,
        "style": {
          "color": "#222",
          "background": "#fff",
          "font-size": "12px",
          "font-family": "",
          "font-weight": "normal",
          "font-style": "normal",
          "text-align": "left",
          "max-width": "30%"
        }
      },
      "product_description": {
        "parent_column": "item",
        "enable": true,
        "style": {
          "color": "#222",
          "background": "#fff",
          "font-size": "12px",
          "font-family": "",
          "font-weight": "normal",
          "font-style": "normal",
          "text-align": "left",
          "max-width": "30%"
        }
      },
      "quantity": {
        "enable": true,
        "style": {
          "color": "#222",
          "background": "#fff",
          "font-size": "12px",
          "font-family": "",
          "font-weight": "normal",
          "font-style": "normal",
          "text-align": "left",
          "max-width": "30%"
        }
      },
      "tax": {
        "enable": true,
        "style": {
          "color": "#222",
          "background": "#fff",
          "font-size": "12px",
          "font-family": "",
          "font-weight": "normal",
          "font-style": "normal",
          "text-align": "left",
          "max-width": "30%"
        }
      },
      "unit_amount": {
        "enable": true,
        "style": {
          "color": "#222",
          "background": "#fff",
          "font-size": "12px",
          "font-family": "",
          "font-weight": "normal",
          "font-style": "normal",
          "text-align": "left",
          "max-width": "30%"
        }
      },
      "net_total": {
        "enable": true,
        "style": {
          "color": "#222",
          "background": "#fff",
          "font-size": "12px",
          "font-family": "",
          "font-weight": "normal",
          "font-style": "normal",
          "text-align": "left",
          "max-width": "30%"
        }
      },
      "gross_total": {
        "enable": true,
        "style": {
          "color": "#222",
          "background": "#fff",
          "font-size": "12px",
          "font-family": "",
          "font-weight": "normal",
          "font-style": "normal",
          "text-align": "left",
          "max-width": "30%"
        }
      }
    },
    "footer": {
      "payment_type": {
        "enable": true,
        "style": {
          "color": "#222",
          "background": "#fff",
          "font-size": "12px",
          "font-family": "",
          "font-weight": "normal",
          "font-style": "normal",
          "text-align": "left",
          "max-width": "30%"
        }
      },
      "net_total": {
        "enable": true,
        "style": {
          "color": "#222",
          "background": "#fff",
          "font-size": "12px",
          "font-family": "",
          "font-weight": "normal",
          "font-style": "normal",
          "text-align": "left",
          "max-width": "30%"
        }
      },
      "amount_tax": {
        "enable": true,
        "style": {
          "color": "#222",
          "background": "#fff",
          "font-size": "12px",
          "font-family": "",
          "font-weight": "normal",
          "font-style": "normal",
          "text-align": "left",
          "max-width": "30%"
        }
      },
      "gross_total": {
        "enable": true,
        "style": {
          "color": "#222",
          "background": "#fff",
          "font-size": "12px",
          "font-family": "",
          "font-weight": "normal",
          "font-style": "normal",
          "text-align": "left",
          "max-width": "30%"
        }
      }
    }
  },
  "template": "<table style=\"table-layout: fixed;width: 100%;max-width: 1000px;border-collapse: collapse;\">\n  <thead>\n    <tr style=\"height: 48px;border-bottom: 1px solid #D5E1ED;\">\n      {{#each table_config.header.columns as |column|}}\n        {{#if column.enable}}\n          <th style=\"{{makeStyle @root.table_config.header.style}};{{makeStyle column.style}};\">{{column._label}}</th>\n        {{/if}}\n      {{/each}}\n    </tr>\n  </thead>\n  <tbody style=\"vertical-align: baseline  !important;font-weight: 400;font-size: 12px;position: relative;\">\n    <!-- Start rendering products -->\n    {{#each order.products as |product|}}\n      {{#if @last}}\n        <tr style=\"height: 48px;;font-size:14px;border-bottom: 1px solid #D5E1ED;\">\n      {{else}}\n        <tr style=\"height: 48px;;font-size:14px;\">\n      {{/if}}\n        {{#each @root.table_config.header.columns as |column|}}\n          {{#if column.enable}}\n            {{#if (eq column.id 'item')}}\n              <!-- Item -->\n              <td style=\"{{makeStyle @root.table_config.body.product_name.style}}\">\n                {{#if @root.table_config.body.product_name.enable}}\n                  {{product.name}}\n                {{/if}}\n                {{#if @root.table_config.body.price_description.enable}}\n                  <br>\n                  <span style=\"{{makeStyle @root.table_config.body.price_description.style}}\">{{product.price.description}}</span>\n                {{/if}}\n                {{#if @root.table_config.body.product_description.enable}}\n                  <br>\n                  <span style=\"{{makeStyle @root.table_config.body.product_description.style}}\">{{product.description}}</span>\n                {{/if}}\n              </td>\n            {{/if}}\n            {{#if (eq column.id 'quantity')}}\n              <!-- Quantity -->\n              <td style=\"{{makeStyle @root.table_config.body.quantity.style}}\">{{product.price.quantity}}\n              </td>\n            {{/if}}\n            {{#if (eq column.id 'tax')}}\n              <!-- Tax -->\n              <td style=\"{{makeStyle @root.table_config.body.tax.style}}\">\n                {{product.price.tax_rate}}\n              </td>\n            {{/if}}\n            {{#if (eq column.id 'unit_amount')}}\n              <!-- Unit amount -->\n              <td style=\"{{makeStyle @root.table_config.body.unit_amount.style}}\">\n                {{product.price.unit_amount_net}}\n              </td>\n            {{/if}}\n            {{#if (eq column.id 'net_total')}}\n              <!-- Amount Subtotal -->\n              <td style=\"{{makeStyle @root.table_config.body.net_total.style}}\">\n                {{product.price.amount_subtotal}}\n              </td>\n            {{/if}}\n            {{#if (eq column.id 'amount_tax')}}\n              <!-- Tax amount-->\n              <td style=\"{{makeStyle @root.table_config.body.amount_tax.style}}\">\n                {{product.price.amount_tax}}\n              </td>\n            {{/if}}\n            {{#if (eq column.id 'gross_total')}}\n              <!-- Gross total -->\n              <td style=\"{{makeStyle @root.table_config.body.gross_total.style}}\">\n                {{product.price.amount_total}}\n                {{#if @root.table_config.body.payment_type.enable}}\n                  {{#if (eq product.price.type 'recurring')}}\n                    <br>\n                    <span style=\"{{makeStyle @root.table_config.body.payment_type.style}}\">{{product.price.billing_period}}</span>\n                  {{/if}}\n                {{/if}}\n              </td>\n            {{/if}}\n          {{/if}}\n        {{/each}}\n        </tr>\n    {{/each}}\n    <!-- Finish rendering products -->\n    {{#if table_config.footer.gross_total.enable}}\n      {{#each order.total_details.recurrences as |item|}}\n        <tr style=\"height: 48px;font-size: 14px;\">\n          <td style=\"padding-top: 16px; padding-bottom: 8px; border: none !important; vertical-align: top;\" colspan=\"{{calculate_colspan @root.table_config}}\"></td>\n          {{#if @root.table_config.footer.payment_type.enable}}\n            <td style=\"{{makeStyle @root.table_config.footer.payment_type.style}}\" colspan=\"2\">{{item.billing_period}}</td>\n          {{/if}}\n          {{#if (isColumnEnabled @root.table_config 'net_total')}}\n            {{#if @root.table_config.footer.net_total.enable}}\n              <td style=\"{{makeStyle @root.table_config.footer.net_total.style}}\">{{item.amount_subtotal}}</td>\n            {{/if}}\n          {{/if}}\n          <td style=\"{{makeStyle @root.table_config.footer.gross_total.style}}\">{{item.amount_total}}\n            {{#if @root.table_config.footer.amount_tax.enable}}\n              <br>\n              <span style=\"{{makeStyle @root.table_config.footer.amount_tax.style}}\">{{item.full_amount_tax}}</span>\n            {{/if}}\n          </td>\n        </tr>\n      {{/each}}\n    {{/if}}\n    <tr style=\"height:16px !important;\"></tr>\n  </tbody>\n</table>\n",
  "created_at": "2022-04-19T12:41:43.662Z",
  "created_by": "100042",
  "updated_at": "2022-04-20T12:41:43.662Z",
  "updated_by": "100042"
}

Response

Success

idstring

ID

type'order_table' | 'custom' | 'journey_link' | 'snippet'

Custom variable type

namestring

Custom variable name

keystring required

The key which is used for Handlebar variable syntax {{key}}

_tagsstring[]

The tags of custom variable

_manifeststring[]

The manifest IDs associated with this custom variable

helper_paramsstring[]

The helper function parameter's names

helper_logicstring

The helper function logic

configobject

Variable configuration

templatestring required

Handlebar template that used to generate the variable content

created_atstring

Creation time

created_bystring

Created by

updated_atstring

Last update time

updated_bystring

Updated by

Example response

{
  "id": "rbse777b-3cf8-4bff-bb0c-253fd1123250",
  "name": "My Custom table",
  "key": "my_custom_table",
  "helper_params": [
    "param1",
    "param2"
  ],
  "helper_logic": "return param1 * param2;",
  "config": {
    "header": null,
    "style": {
      "color": "#222",
      "background": "#fff",
      "font-size": "16px",
      "font-family": "",
      "padding-bottom": "4px",
      "font-weight": "bold",
      "border": "none !important",
      "text-align": "left"
    },
    "columns": [
      {
        "id": "item",
        "index": 0,
        "label": {
          "en": "Item",
          "de": "Produkt"
        },
        "enable": true,
        "draggable": true,
        "style": {
          "padding-left": "10px",
          "max-width": "30%"
        }
      },
      {
        "id": "quantity",
        "index": 1,
        "label": {
          "en": "Quanity",
          "de": "Menge"
        },
        "enable": true,
        "draggable": true,
        "style": {
          "min-width": "60px",
          "width": "30%"
        }
      },
      {
        "id": "tax",
        "index": 2,
        "label": {
          "en": "Tax Rate",
          "de": "Steuerrate"
        },
        "enable": true,
        "draggable": true,
        "style": {
          "min-width": "60px",
          "width": "30%"
        }
      },
      {
        "id": "unit_amount",
        "index": 3,
        "label": {
          "en": "Unit Net Price",
          "de": "Nettopreis"
        },
        "enable": true,
        "draggable": true,
        "style": {
          "min-width": "60px",
          "width": "30%"
        }
      },
      {
        "id": "net_total",
        "index": 4,
        "label": {
          "en": "Net total",
          "de": "Nettosumme"
        },
        "enable": "true,",
        "draggable": true,
        "style": {
          "min-width": "60px",
          "width": "30%"
        }
      },
      {
        "id": "gross_total",
        "index": 5,
        "label": {
          "en": "Total",
          "de": "Gesamt"
        },
        "enable": true,
        "draggable": true,
        "style": {
          "min-width": "60px",
          "width": "30%"
        }
      }
    ],
    "body": {
      "product_name": {
        "parent_column": "item",
        "enable": true,
        "style": {
          "color": "#222",
          "background": "#fff",
          "font-size": "14px",
          "font-family": "",
          "font-weight": "bold",
          "font-style": "normal",
          "padding-top": "16px",
          "padding-bottom": "8px",
          "border": "none !important",
          "vertical-align": "top",
          "text-align": "left",
          "max-width": "30%",
          "padding-left": "10px"
        }
      },
      "price_description": {
        "parent_column": "item",
        "enable": true,
        "style": {
          "color": "#222",
          "background": "#fff",
          "font-size": "12px",
          "font-family": "",
          "font-weight": "normal",
          "font-style": "normal",
          "text-align": "left",
          "max-width": "30%"
        }
      },
      "product_description": {
        "parent_column": "item",
        "enable": true,
        "style": {
          "color": "#222",
          "background": "#fff",
          "font-size": "12px",
          "font-family": "",
          "font-weight": "normal",
          "font-style": "normal",
          "text-align": "left",
          "max-width": "30%"
        }
      },
      "quantity": {
        "enable": true,
        "style": {
          "color": "#222",
          "background": "#fff",
          "font-size": "12px",
          "font-family": "",
          "font-weight": "normal",
          "font-style": "normal",
          "text-align": "left",
          "max-width": "30%"
        }
      },
      "tax": {
        "enable": true,
        "style": {
          "color": "#222",
          "background": "#fff",
          "font-size": "12px",
          "font-family": "",
          "font-weight": "normal",
          "font-style": "normal",
          "text-align": "left",
          "max-width": "30%"
        }
      },
      "unit_amount": {
        "enable": true,
        "style": {
          "color": "#222",
          "background": "#fff",
          "font-size": "12px",
          "font-family": "",
          "font-weight": "normal",
          "font-style": "normal",
          "text-align": "left",
          "max-width": "30%"
        }
      },
      "net_total": {
        "enable": true,
        "style": {
          "color": "#222",
          "background": "#fff",
          "font-size": "12px",
          "font-family": "",
          "font-weight": "normal",
          "font-style": "normal",
          "text-align": "left",
          "max-width": "30%"
        }
      },
      "gross_total": {
        "enable": true,
        "style": {
          "color": "#222",
          "background": "#fff",
          "font-size": "12px",
          "font-family": "",
          "font-weight": "normal",
          "font-style": "normal",
          "text-align": "left",
          "max-width": "30%"
        }
      }
    },
    "footer": {
      "payment_type": {
        "enable": true,
        "style": {
          "color": "#222",
          "background": "#fff",
          "font-size": "12px",
          "font-family": "",
          "font-weight": "normal",
          "font-style": "normal",
          "text-align": "left",
          "max-width": "30%"
        }
      },
      "net_total": {
        "enable": true,
        "style": {
          "color": "#222",
          "background": "#fff",
          "font-size": "12px",
          "font-family": "",
          "font-weight": "normal",
          "font-style": "normal",
          "text-align": "left",
          "max-width": "30%"
        }
      },
      "amount_tax": {
        "enable": true,
        "style": {
          "color": "#222",
          "background": "#fff",
          "font-size": "12px",
          "font-family": "",
          "font-weight": "normal",
          "font-style": "normal",
          "text-align": "left",
          "max-width": "30%"
        }
      },
      "gross_total": {
        "enable": true,
        "style": {
          "color": "#222",
          "background": "#fff",
          "font-size": "12px",
          "font-family": "",
          "font-weight": "normal",
          "font-style": "normal",
          "text-align": "left",
          "max-width": "30%"
        }
      }
    }
  },
  "template": "<table style=\"table-layout: fixed;width: 100%;max-width: 1000px;border-collapse: collapse;\">\n  <thead>\n    <tr style=\"height: 48px;border-bottom: 1px solid #D5E1ED;\">\n      {{#each table_config.header.columns as |column|}}\n        {{#if column.enable}}\n          <th style=\"{{makeStyle @root.table_config.header.style}};{{makeStyle column.style}};\">{{column._label}}</th>\n        {{/if}}\n      {{/each}}\n    </tr>\n  </thead>\n  <tbody style=\"vertical-align: baseline  !important;font-weight: 400;font-size: 12px;position: relative;\">\n    <!-- Start rendering products -->\n    {{#each order.products as |product|}}\n      {{#if @last}}\n        <tr style=\"height: 48px;;font-size:14px;border-bottom: 1px solid #D5E1ED;\">\n      {{else}}\n        <tr style=\"height: 48px;;font-size:14px;\">\n      {{/if}}\n        {{#each @root.table_config.header.columns as |column|}}\n          {{#if column.enable}}\n            {{#if (eq column.id 'item')}}\n              <!-- Item -->\n              <td style=\"{{makeStyle @root.table_config.body.product_name.style}}\">\n                {{#if @root.table_config.body.product_name.enable}}\n                  {{product.name}}\n                {{/if}}\n                {{#if @root.table_config.body.price_description.enable}}\n                  <br>\n                  <span style=\"{{makeStyle @root.table_config.body.price_description.style}}\">{{product.price.description}}</span>\n                {{/if}}\n                {{#if @root.table_config.body.product_description.enable}}\n                  <br>\n                  <span style=\"{{makeStyle @root.table_config.body.product_description.style}}\">{{product.description}}</span>\n                {{/if}}\n              </td>\n            {{/if}}\n            {{#if (eq column.id 'quantity')}}\n              <!-- Quantity -->\n              <td style=\"{{makeStyle @root.table_config.body.quantity.style}}\">{{product.price.quantity}}\n              </td>\n            {{/if}}\n            {{#if (eq column.id 'tax')}}\n              <!-- Tax -->\n              <td style=\"{{makeStyle @root.table_config.body.tax.style}}\">\n                {{product.price.tax_rate}}\n              </td>\n            {{/if}}\n            {{#if (eq column.id 'unit_amount')}}\n              <!-- Unit amount -->\n              <td style=\"{{makeStyle @root.table_config.body.unit_amount.style}}\">\n                {{product.price.unit_amount_net}}\n              </td>\n            {{/if}}\n            {{#if (eq column.id 'net_total')}}\n              <!-- Amount Subtotal -->\n              <td style=\"{{makeStyle @root.table_config.body.net_total.style}}\">\n                {{product.price.amount_subtotal}}\n              </td>\n            {{/if}}\n            {{#if (eq column.id 'amount_tax')}}\n              <!-- Tax amount-->\n              <td style=\"{{makeStyle @root.table_config.body.amount_tax.style}}\">\n                {{product.price.amount_tax}}\n              </td>\n            {{/if}}\n            {{#if (eq column.id 'gross_total')}}\n              <!-- Gross total -->\n              <td style=\"{{makeStyle @root.table_config.body.gross_total.style}}\">\n                {{product.price.amount_total}}\n                {{#if @root.table_config.body.payment_type.enable}}\n                  {{#if (eq product.price.type 'recurring')}}\n                    <br>\n                    <span style=\"{{makeStyle @root.table_config.body.payment_type.style}}\">{{product.price.billing_period}}</span>\n                  {{/if}}\n                {{/if}}\n              </td>\n            {{/if}}\n          {{/if}}\n        {{/each}}\n        </tr>\n    {{/each}}\n    <!-- Finish rendering products -->\n    {{#if table_config.footer.gross_total.enable}}\n      {{#each order.total_details.recurrences as |item|}}\n        <tr style=\"height: 48px;font-size: 14px;\">\n          <td style=\"padding-top: 16px; padding-bottom: 8px; border: none !important; vertical-align: top;\" colspan=\"{{calculate_colspan @root.table_config}}\"></td>\n          {{#if @root.table_config.footer.payment_type.enable}}\n            <td style=\"{{makeStyle @root.table_config.footer.payment_type.style}}\" colspan=\"2\">{{item.billing_period}}</td>\n          {{/if}}\n          {{#if (isColumnEnabled @root.table_config 'net_total')}}\n            {{#if @root.table_config.footer.net_total.enable}}\n              <td style=\"{{makeStyle @root.table_config.footer.net_total.style}}\">{{item.amount_subtotal}}</td>\n            {{/if}}\n          {{/if}}\n          <td style=\"{{makeStyle @root.table_config.footer.gross_total.style}}\">{{item.amount_total}}\n            {{#if @root.table_config.footer.amount_tax.enable}}\n              <br>\n              <span style=\"{{makeStyle @root.table_config.footer.amount_tax.style}}\">{{item.full_amount_tax}}</span>\n            {{/if}}\n          </td>\n        </tr>\n      {{/each}}\n    {{/if}}\n    <tr style=\"height:16px !important;\"></tr>\n  </tbody>\n</table>\n",
  "created_at": "2022-04-19T12:41:43.662Z",
  "created_by": "100042",
  "updated_at": "2022-04-20T12:41:43.662Z",
  "updated_by": "100042"
}