SalesKing Documentation » SalesKing API

h1(title). Placeholders - Text substitution

h1. Contents

{{toc}}

h1. Audience

SalesKing Users who want to customize text in emails or elsewhere.

h1. Example

Placeholders occur in text you are using inside the SalesKing. 

For example in an email:

<pre>

Dear [customer.name],

thanks for your payment of Invoice no.: [invoice.number] which was: [invoice.total_sum]

</pre>

h1. Description

Each placeholder is made up of a prefix, to specify the realm of the following data field value.

The surrounding brackets [] tell the system that this is a special text which will be substituted with real data.

<pre>

[invoice.number] -> realm invoice field number

[client.number] -> realm client, field number

[product.number] -> realm product, field number

[company.name] -> realm company, field name

[settings.company_info] -> realm settings (invoice print settings), field company_info

</pre>

If a placeholder can´t be substituted because the field is not available it will show the placeholder itself.

If a placeholder is available but empty, it will be substituted with this empty string.