SmtpTemplateById: Sendinblue SMTP Template by ID |
Returns the template information
Catalog: Brevo
Schema: SMTP
Label: SMTP Template by ID
This is a read-only table function. The Sendinblue API may not support changing the data or the Invantive UniversalSQL driver for Sendinblue does not cover it. In the latter case, please use the table NativePlatformScalarRequests to upload data to the Sendinblue API.
Parameters of Table Function
The following parameters can be used to control the behaviour of the table function SmtpTemplateById. A value must be provided at all times for required parameters, but optional parameters in general do not need to have a value and the execution will default to a pre-defined behaviour. Values can be specified by position and by name. In both cases, all parameters not specified will be evaluated using their default values.
Value specification by position is done by listing all values from the first to the last needed value. For example: a `select * from table(value1, value2, value3)` on a table with four parameters will use the default value for the fourth parameter and the specified values for the first three.
Value specification by name is done by listing all values that require a value. For example with `select * from table(name1 => value1, name3 => value3)` on the same table will use the default values for the second and fourth parameters and the specified values for the first and third.
Name |
Data Type |
Required |
Default Value |
Documentation |
---|---|---|---|---|
templateId |
int64 |
☑ |
|
id of the template |
Columns of Table Function
The columns of the table function SmtpTemplateById are shown below. Each column has an SQL data type.
Name |
Data Type |
Label |
Required |
Documentation |
---|---|---|---|---|
createdAt |
datetime |
Creation Date |
☐ |
Creation UTC date-time of the template (YYYY-MM-DDTHH:mm:ss.SSSZ) |
doiTemplate |
boolean |
DOI Template |
☐ |
It is true if template is a valid Double opt-in (DOI) template, otherwise it is false. This field will be available only in case of single template detail call. |
htmlContent |
string |
HTML Content |
☐ |
HTML content of the template |
id |
int64 |
ID |
☐ |
ID of the template |
isActive |
boolean |
Is Active |
☐ |
Status of template (true=active, false=inactive) |
modifiedAt |
datetime |
Modified Date |
☐ |
Last modification UTC date-time of the template (YYYY-MM-DDTHH:mm:ss.SSSZ) |
name |
string |
Name |
☐ |
Name of the template |
replyTo |
string |
Reply-to |
☐ |
Email defined as the "Reply to" for the template |
sender_email |
string |
Sender Email Address |
☐ |
From email for the template |
sender_id |
string |
Sender ID |
☐ |
Sender id of the template |
sender_name |
string |
Sender Name |
☐ |
From email for the template |
subject |
string |
Subject |
☐ |
Subject of the template |
tag |
string |
Tag |
☐ |
Tag of the template |
testSent |
boolean |
Test Sent |
☐ |
Status of test sending for the template (true=test email has been sent, false=test email has not been sent) |
toField |
string |
To Field |
☐ |
Customisation of the "to" field for the template |
17-09-2024 15:16 Version 24.1.8-BETA+4877