Boldem is a comprehensive digital marketing platform designed to streamline and optimize your marketing efforts. It provides robust features for email marketing, SMS campaigns, social media management, and marketing automation. Boldem helps businesses of all sizes enhance their marketing strategies, engage with their audience, and drive growth through targeted and personalized communication.
Connector that sends transactional email by Boldem API.
Prerequisites for calling Boldem API endpoints
To successfully call the endpoints of the Boldem API, ensure the following prerequisites are met:
-
Boldem account
-
Profi plan
-
API key (Client ID and Secret Key) generated in your Boldem account, which you will use to control the API
-
Access token and refresh token obtained by calling the appropriate endpoint using your API key
Generating an API Key
-
Log in to your Boldem account
-
Navigate to Settings/API
-
Click the New API Key button
-
Enter a name for the key for your reference
-
A dialog will appear with the API key details – Client ID and Client Secret
Configuration
Boldem - Connection (ver. 1.0.0)
Client ID
Client ID for Boldem API.
Client secret
Client secret for the connection.
Boldem - Send Transactional Email Settings (ver. 1.0.0)
Error behavior
The available values are:
-
Fail and return response: The connector fails at the specified line but generates output with error details.
-
Fail without response: The connector fails - the error will be displayed only in the log.
-
Do not fail and return response: The connector does not fail but generates output records that may be marked with an error and detailed information.
Input & Output Schema
Input
Boldem - Send Transactional Email Request (ver. 1.1.0)
| Column | Data type | Allow null | Description |
|---|---|---|---|
| TemplateID | Integer | Yes | The ID of the email template to use |
| GroupID | Integer | Yes | The ID of the group to send the email to |
| From | String | Yes | The email address of the sender |
| FromDisplayName | String | Yes | The display name of the sender |
| ReplyTo | String | Yes | The email address for replies |
| ReplyToDisplayName | String | Yes | The display name for the reply-to address |
| Subject | String | Yes | The subject line of the email |
| IsBulk | Bool | No | Indicates whether the email is a bulk email |
| SendAt | DateTime | Yes | The date and time to send the email |
| Tags | String | Yes | Tags associated with the email for tracking purposes |
| BodyHTML | String | Yes | The HTML content of the email body |
| BodyText | String | Yes | The plain text content of the email body |
| TrackOpens | Bool | No | Indicates whether to track email opens |
| TrackClicks | Bool | No | Indicates whether to track clicks within the email |
| AllowUnsubscribe | Bool | Yes | Indicates whether to include an unsubscribe option in the email |
| Variables | JSON | Yes | JSON object containing variables for personalization |
| Attachments | Boldem - Attachment Data v1.0.0 |
Yes | Attachments to include with the email |
| To | Boldem - Transactional Email Recipient v1.1.0 |
No | Recipient details for the transactional email |
Boldem - Attachment Data (ver. 1.0.0)
| Column | Data type | Allow null | Description |
|---|---|---|---|
| Name | String | Yes | The name of the transactional email |
| ContentType | String | Yes | The MIME type of the email content |
| Content | Base64 | Yes | The base64-encoded content of the email |
Boldem - Transactional Email Recipient (ver. 1.1.0)
| Column | Data type | Allow null | Description |
|---|---|---|---|
| Address | String | No | The email address of the recipient |
| GUID | String | Yes | The globally unique identifier for the recipient |
| DisplayName | String | Yes | The display name of the recipient |
| Variables | JSON | Yes | JSON object containing variables for personalization specific to the recipient |
Output
Boldem - Send Transactional Email Response (ver. 1.0.0)
| Column | Data type | Allow null | Description |
|---|---|---|---|
| StatusCode | Integer | No | A numerical response from the server to an HTTP request sent to an API |
| IsError | Bool | No | Indicates whether there was an error during the operation |
| Message | String | Yes | Error or status message providing additional information |
Status Code
- 200 Success
- 400 Bad request
- 500 Server error
Release notes
3.0.2
- First release