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 unsubscribe 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 Unsubscribe Settings (ver. 1.0.0)
Error behavior
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 Unsubscribe Request (ver. 1.0.0)
| Column | Data type | Allow null | Description |
|---|---|---|---|
| String | No | The email address of the contact to unsubscribe | |
| MailingListID | Integer | Yes | The ID of the mailing list from which to unsubscribe |
| CampaignID | Integer | Yes | The ID of the campaign associated with the unsubscribe request |
| ValidFrom | DateTime | Yes | The start date and time for the unsubscribe request validity |
| ValidTo | DateTime | No | The end date and time for the unsubscribe request validity |
| Reason | String | No | The reason for the unsubscribe request |
Output
Boldem - Create Unsubscribe 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 |
| String | Yes | The email address of the contact unsubscribed | |
| MailingListID | Integer | Yes | The ID of the mailing list from which the contact was unsubscribed |
| CampaignID | Integer | Yes | The ID of the campaign associated with the unsubscribe request |
| ValidFrom | DateTime | Yes | The start date and time for the unsubscribe request validity |
| ValidTo | DateTime | Yes | The end date and time for the unsubscribe request validity |
| Reason | String | Yes | The reason for the unsubscribe request |
| UnsubscribeID | Integer | Yes | The unique identifier for the unsubscribe request |
| Created | DateTime | Yes | The date and time when the unsubscribe request was created |
| GeneratorExecutionID | Integer | Yes | The ID of the generator execution associated with the unsubscribe request |
| MassEmailID | Integer | Yes | The ID of the mass email associated with the unsubscribe request |
| TransactionalEmailID | Integer | Yes | The ID of the transactional email associated with the unsubscribe request |
| Variant | Integer | Yes | The variant of the unsubscribe request |
| UnsubscribeOrigin | Integer | Yes | The origin of the unsubscribe request |
| UnsubscribeReason | Integer | Yes | The reason code for the unsubscribe request |
| 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.1
- First release