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 creates subscribe request 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 - Create Subscribe 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 - Create Subscribe Request (ver. 1.0.0)
| Column | Data type | Allow null | Description |
|---|---|---|---|
| FirstName | String | Yes | The first name of the subscriber |
| LastName | String | Yes | The last name of the subscriber |
| Sex | Integer | No | The gender of the subscriber (e.g., 1 = Male, 2 = Female) |
| Phone | String | Yes | The phone number of the subscriber |
| Company | String | Yes | The company name of the subscriber |
| Salutation | String | Yes | The salutation or title of the subscriber (e.g., Mr., Ms.) |
| String | No | The email address of the subscriber | |
| MainMailingListID | Integer | No | The primary mailing list ID to which the subscriber is added |
| CustomColumns | Boldem - Custom Column v1.0.0 |
Yes | Custom columns for additional subscriber data |
| MailingListIDs | Boldem - Int Value v1.0.0 |
Yes | IDs of additional mailing lists the subscriber belongs to |
Boldem - Custom Column (ver. 1.0.0)
| Column | Data type | Allow null | Description |
|---|---|---|---|
| Name | String | Yes | Name of the custom attribute |
| BooleanValue | Bool | Yes | Boolean value of the custom attribute |
| StringValue | String | Yes | String value of the custom attribute |
| DateValue | DateTime | Yes | Date and time value of the custom attribute |
| IntValue | Integer | Yes | Integer value of the custom attribute |
| DoubleValue | Double | Yes | Double (floating-point) value of the custom attribute |
Boldem - Int Value (ver. 1.0.0)
| Column | Data type | Allow null | Description |
|---|---|---|---|
| Value | Integer | No | The integer value of the attribute |
Output
Boldem - Create Subscribe Response (ver. 1.0.0)
| Column | Data type | Allow null | Description |
|---|---|---|---|
| StatusCode | Integer | No | Numerical response from the server to an HTTP request sent to an API |
| Contact | Boldem - Contact v1.0.0 |
Yes | Details of the contact associated with the subscription request |
| SubscribeRequest | Boldem - Subscribe Request Result v1.0.0 |
Yes | Details of the subscription request result |
| 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
Boldem - Contact (ver. 1.0.0)
| Column | Data type | Allow null | Description |
|---|---|---|---|
| FirstName | String | Yes | The first name of the subscriber |
| LastName | String | Yes | The last name of the subscriber |
| Sex | Integer | No | The gender of the subscriber (e.g., 1 = Male, 2 = Female) |
| Phone | String | Yes | The phone number of the subscriber |
| Company | String | Yes | The company name of the subscriber |
| Salutation | String | Yes | The salutation or title of the subscriber (e.g., Mr., Ms.) |
| ContactID | Integer | No | The unique identifier for the subscriber |
| String | Yes | The email address of the subscriber | |
| Created | DateTime | No | The date and time when the subscription was created |
| Updated | DateTime | No | The date and time when the subscription was last updated |
| LastOpen | DateTime | Yes | The date and time when the subscriber last opened an email |
| LastClick | DateTime | Yes | The date and time when the subscriber last clicked a link |
| DateConfirmed | DateTime | Yes | The date and time when the subscription was confirmed |
| CustomColumns | Boldem - Custom Column v1.0.0 |
Yes | Custom columns for additional subscriber data |
| MailingListIDs | Boldem - Int Value v1.0.0 |
Yes | IDs of the mailing lists the subscriber belongs to |
| MailingLists | Boldem - Contact Mailing List v1.1.0 |
Yes | Details of the mailing lists the subscriber is subscribed to |
Boldem - Custom Column (ver. 1.0.0)
| Column | Data type | Allow null | Description |
|---|---|---|---|
| Name | String | Yes | Name of the custom attribute |
| BooleanValue | Bool | Yes | Boolean value of the custom attribute |
| StringValue | String | Yes | String value of the custom attribute |
| DateValue | DateTime | Yes | Date and time value of the custom attribute |
| IntValue | Integer | Yes | Integer value of the custom attribute |
| DoubleValue | Double | Yes | Double (floating-point) value of the custom attribute |
Boldem - Int Value (ver. 1.0.0)
| Column | Data type | Allow null | Description |
|---|---|---|---|
| Value | Integer | No | The integer value of the attribute |
Boldem - Contact Mailing List (ver. 1.1.0)
| Column | Data type | Allow null | Description |
|---|---|---|---|
| MailingListID | Integer | No | Unique identifier for the mailing list |
| Created | DateTime | No | Date and time when the mailing list was created |
| Updated | DateTime | No | Date and time when the mailing list was last updated |
| Name | String | Yes | Name of the mailing list |
| Description | String | Yes | Detailed description of the mailing list |
| IsTest | Bool | No | Indicates whether the mailing list is for testing purposes |
| Assigned | DateTime | Yes | Date and time when the mailing list was assigned |
| Origin | Integer | No | Source or origin identifier for the mailing list |
| IsUnsubscribed | Bool | No | Indicates whether the mailing list has unsubscribed users |
Boldem - Subscribe Request Result (ver. 1.0.0)
| Column | Data type | Allow null | Description |
|---|---|---|---|
| SubscribeRequestID | Integer | Yes | The unique identifier for the subscribe request |
| Created | DateTime | Yes | The date and time when the subscribe request was created |
| String | Yes | The email address associated with the subscribe request | |
| TransactionalEmailGUID | String | Yes | The GUID of the transactional email sent as part of the subscribe request |
| MainMailingListID | Integer | Yes | The primary mailing list ID associated with the subscribe request |
Release notes
3.0.3
- First release