sib_api_v3_sdk.Api.TransactionalEmailsApi

All URIs are relative to https://api.sendinblue.com/v3

Method	HTTP request	Description
BlockNewDomain	POST /smtp/blockedDomains	Add a new domain to the list of blocked domains
CreateSmtpTemplate	POST /smtp/templates	Create an email template
DeleteBlockedDomain	DELETE /smtp/blockedDomains/{domain}	Unblock an existing domain from the list of blocked domains
DeleteHardbounces	POST /smtp/deleteHardbounces	Delete hardbounces
DeleteScheduledEmailById	DELETE /smtp/email/{identifier}	Delete scheduled emails by batchId or messageId
DeleteSmtpTemplate	DELETE /smtp/templates/{templateId}	Delete an inactive email template
GetAggregatedSmtpReport	GET /smtp/statistics/aggregatedReport	Get your transactional email activity aggregated over a period of time
GetBlockedDomains	GET /smtp/blockedDomains	Get the list of blocked domains
GetEmailEventReport	GET /smtp/statistics/events	Get all your transactional email activity (unaggregated events)
GetScheduledEmailByBatchId	GET /smtp/emailStatus/{batchId}	Fetch scheduled emails by batchId
GetScheduledEmailByMessageId	GET /smtp/emailStatus/{messageId}	Fetch scheduled email by messageId
GetSmtpReport	GET /smtp/statistics/reports	Get your transactional email activity aggregated per day
GetSmtpTemplate	GET /smtp/templates/{templateId}	Returns the template information
GetSmtpTemplates	GET /smtp/templates	Get the list of email templates
GetTransacBlockedContacts	GET /smtp/blockedContacts	Get the list of blocked or unsubscribed transactional contacts
GetTransacEmailContent	GET /smtp/emails/{uuid}	Get the personalized content of a sent transactional email
GetTransacEmailsList	GET /smtp/emails	Get the list of transactional emails on the basis of allowed filters
SendTestTemplate	POST /smtp/templates/{templateId}/sendTest	Send a template to your test list
SendTransacEmail	POST /smtp/email	Send a transactional email
SmtpBlockedContactsEmailDelete	DELETE /smtp/blockedContacts/{email}	Unblock or resubscribe a transactional contact
SmtpLogMessageIdDelete	DELETE /smtp/log/{messageId}	Delete an SMTP transactional log
UpdateSmtpTemplate	PUT /smtp/templates/{templateId}	Update an email template

BlockNewDomain

void BlockNewDomain (BlockDomain blockDomain)

Add a new domain to the list of blocked domains

Blocks a new domain in order to avoid messages being sent to the same

Example

using System;
using System.Diagnostics;
using sib_api_v3_sdk.Api;
using sib_api_v3_sdk.Client;
using sib_api_v3_sdk.Model;

namespace Example
{
    public class BlockNewDomainExample
    {
        public void main()
        {
            // Configure API key authorization: api-key
            Configuration.Default.AddApiKey("api-key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.AddApiKeyPrefix("api-key", "Bearer");
            // Configure API key authorization: partner-key
            Configuration.Default.AddApiKey("partner-key", "YOUR_PARTNER_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.AddApiKeyPrefix("partner-key", "Bearer");

            var apiInstance = new TransactionalEmailsApi();
            var blockDomain = new BlockDomain(); // BlockDomain | 

            try
            {
                // Add a new domain to the list of blocked domains
                apiInstance.BlockNewDomain(blockDomain);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling TransactionalEmailsApi.BlockNewDomain: " + e.Message );
            }
        }
    }
}

Parameters

Name	Type	Description	Notes
blockDomain	BlockDomain

Return type

void (empty response body)

Authorization

api-key, partner-key

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

CreateSmtpTemplate

CreateModel CreateSmtpTemplate (CreateSmtpTemplate smtpTemplate)

Create an email template

Example

using System;
using System.Diagnostics;
using sib_api_v3_sdk.Api;
using sib_api_v3_sdk.Client;
using sib_api_v3_sdk.Model;

namespace Example
{
    public class CreateSmtpTemplateExample
    {
        public void main()
        {
            // Configure API key authorization: api-key
            Configuration.Default.AddApiKey("api-key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.AddApiKeyPrefix("api-key", "Bearer");
            // Configure API key authorization: partner-key
            Configuration.Default.AddApiKey("partner-key", "YOUR_PARTNER_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.AddApiKeyPrefix("partner-key", "Bearer");

            var apiInstance = new TransactionalEmailsApi();
            var smtpTemplate = new CreateSmtpTemplate(); // CreateSmtpTemplate | values to update in transactional email template

            try
            {
                // Create an email template
                CreateModel result = apiInstance.CreateSmtpTemplate(smtpTemplate);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling TransactionalEmailsApi.CreateSmtpTemplate: " + e.Message );
            }
        }
    }
}

Parameters

Name	Type	Description	Notes
smtpTemplate	CreateSmtpTemplate	values to update in transactional email template

Return type

CreateModel

Authorization

api-key, partner-key

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

DeleteBlockedDomain

void DeleteBlockedDomain (string domain)

Unblock an existing domain from the list of blocked domains

Unblocks an existing domain from the list of blocked domains

Example

using System;
using System.Diagnostics;
using sib_api_v3_sdk.Api;
using sib_api_v3_sdk.Client;
using sib_api_v3_sdk.Model;

namespace Example
{
    public class DeleteBlockedDomainExample
    {
        public void main()
        {
            // Configure API key authorization: api-key
            Configuration.Default.AddApiKey("api-key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.AddApiKeyPrefix("api-key", "Bearer");
            // Configure API key authorization: partner-key
            Configuration.Default.AddApiKey("partner-key", "YOUR_PARTNER_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.AddApiKeyPrefix("partner-key", "Bearer");

            var apiInstance = new TransactionalEmailsApi();
            var domain = domain_example;  // string | The name of the domain to be deleted

            try
            {
                // Unblock an existing domain from the list of blocked domains
                apiInstance.DeleteBlockedDomain(domain);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling TransactionalEmailsApi.DeleteBlockedDomain: " + e.Message );
            }
        }
    }
}

Parameters

Name	Type	Description	Notes
domain	string	The name of the domain to be deleted

Return type

void (empty response body)

Authorization

api-key, partner-key

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

DeleteHardbounces

void DeleteHardbounces (DeleteHardbounces deleteHardbounces = null)

Delete hardbounces

Delete hardbounces. To use carefully (e.g. in case of temporary ISP failures)

Example

using System;
using System.Diagnostics;
using sib_api_v3_sdk.Api;
using sib_api_v3_sdk.Client;
using sib_api_v3_sdk.Model;

namespace Example
{
    public class DeleteHardbouncesExample
    {
        public void main()
        {
            // Configure API key authorization: api-key
            Configuration.Default.AddApiKey("api-key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.AddApiKeyPrefix("api-key", "Bearer");
            // Configure API key authorization: partner-key
            Configuration.Default.AddApiKey("partner-key", "YOUR_PARTNER_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.AddApiKeyPrefix("partner-key", "Bearer");

            var apiInstance = new TransactionalEmailsApi();
            var deleteHardbounces = new DeleteHardbounces(); // DeleteHardbounces | values to delete hardbounces (optional) 

            try
            {
                // Delete hardbounces
                apiInstance.DeleteHardbounces(deleteHardbounces);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling TransactionalEmailsApi.DeleteHardbounces: " + e.Message );
            }
        }
    }
}

Parameters

Name	Type	Description	Notes
deleteHardbounces	DeleteHardbounces	values to delete hardbounces	[optional]

Return type

void (empty response body)

Authorization

api-key, partner-key

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

DeleteScheduledEmailById

void DeleteScheduledEmailById (string identifier)

Delete scheduled emails by batchId or messageId

Delete scheduled batch of emails by batchId or single scheduled email by messageId

Example

using System;
using System.Diagnostics;
using sib_api_v3_sdk.Api;
using sib_api_v3_sdk.Client;
using sib_api_v3_sdk.Model;

namespace Example
{
    public class DeleteScheduledEmailByIdExample
    {
        public void main()
        {
            // Configure API key authorization: api-key
            Configuration.Default.AddApiKey("api-key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.AddApiKeyPrefix("api-key", "Bearer");
            // Configure API key authorization: partner-key
            Configuration.Default.AddApiKey("partner-key", "YOUR_PARTNER_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.AddApiKeyPrefix("partner-key", "Bearer");

            var apiInstance = new TransactionalEmailsApi();
            var identifier = identifier_example;  // string | The `batchId` of scheduled emails batch (Should be a valid UUIDv4) or the `messageId` of scheduled email.

            try
            {
                // Delete scheduled emails by batchId or messageId
                apiInstance.DeleteScheduledEmailById(identifier);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling TransactionalEmailsApi.DeleteScheduledEmailById: " + e.Message );
            }
        }
    }
}

Parameters

Name	Type	Description	Notes
identifier	string	The `batchId` of scheduled emails batch (Should be a valid UUIDv4) or the `messageId` of scheduled email.

Return type

void (empty response body)

Authorization

api-key, partner-key

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

DeleteSmtpTemplate

void DeleteSmtpTemplate (long? templateId)

Delete an inactive email template

Example

using System;
using System.Diagnostics;
using sib_api_v3_sdk.Api;
using sib_api_v3_sdk.Client;
using sib_api_v3_sdk.Model;

namespace Example
{
    public class DeleteSmtpTemplateExample
    {
        public void main()
        {
            // Configure API key authorization: api-key
            Configuration.Default.AddApiKey("api-key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.AddApiKeyPrefix("api-key", "Bearer");
            // Configure API key authorization: partner-key
            Configuration.Default.AddApiKey("partner-key", "YOUR_PARTNER_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.AddApiKeyPrefix("partner-key", "Bearer");

            var apiInstance = new TransactionalEmailsApi();
            var templateId = 789;  // long? | id of the template

            try
            {
                // Delete an inactive email template
                apiInstance.DeleteSmtpTemplate(templateId);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling TransactionalEmailsApi.DeleteSmtpTemplate: " + e.Message );
            }
        }
    }
}

Parameters

Name	Type	Description	Notes
templateId	long?	id of the template

Return type

void (empty response body)

Authorization

api-key, partner-key

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetAggregatedSmtpReport

GetAggregatedReport GetAggregatedSmtpReport (string startDate = null, string endDate = null, long? days = null, string tag = null)

Get your transactional email activity aggregated over a period of time

This endpoint will show the aggregated stats for past 90 days by default if startDate and endDate OR days is not passed. The date range can not exceed 90 days

Example

using System;
using System.Diagnostics;
using sib_api_v3_sdk.Api;
using sib_api_v3_sdk.Client;
using sib_api_v3_sdk.Model;

namespace Example
{
    public class GetAggregatedSmtpReportExample
    {
        public void main()
        {
            // Configure API key authorization: api-key
            Configuration.Default.AddApiKey("api-key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.AddApiKeyPrefix("api-key", "Bearer");
            // Configure API key authorization: partner-key
            Configuration.Default.AddApiKey("partner-key", "YOUR_PARTNER_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.AddApiKeyPrefix("partner-key", "Bearer");

            var apiInstance = new TransactionalEmailsApi();
            var startDate = startDate_example;  // string | Mandatory if endDate is used. Starting date of the report (YYYY-MM-DD). Must be lower than equal to endDate (optional) 
            var endDate = endDate_example;  // string | Mandatory if startDate is used. Ending date of the report (YYYY-MM-DD). Must be greater than equal to startDate (optional) 
            var days = 789;  // long? | Number of days in the past including today (positive integer). Not compatible with 'startDate' and 'endDate' (optional) 
            var tag = tag_example;  // string | Tag of the emails (optional) 

            try
            {
                // Get your transactional email activity aggregated over a period of time
                GetAggregatedReport result = apiInstance.GetAggregatedSmtpReport(startDate, endDate, days, tag);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling TransactionalEmailsApi.GetAggregatedSmtpReport: " + e.Message );
            }
        }
    }
}

Parameters

Name	Type	Description	Notes
startDate	string	Mandatory if endDate is used. Starting date of the report (YYYY-MM-DD). Must be lower than equal to endDate	[optional]
endDate	string	Mandatory if startDate is used. Ending date of the report (YYYY-MM-DD). Must be greater than equal to startDate	[optional]
days	long?	Number of days in the past including today (positive integer). Not compatible with 'startDate' and 'endDate'	[optional]
tag	string	Tag of the emails	[optional]

Return type

GetAggregatedReport

Authorization

api-key, partner-key

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetBlockedDomains

GetBlockedDomains GetBlockedDomains ()

Get the list of blocked domains

Example

using System;
using System.Diagnostics;
using sib_api_v3_sdk.Api;
using sib_api_v3_sdk.Client;
using sib_api_v3_sdk.Model;

namespace Example
{
    public class GetBlockedDomainsExample
    {
        public void main()
        {
            // Configure API key authorization: api-key
            Configuration.Default.AddApiKey("api-key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.AddApiKeyPrefix("api-key", "Bearer");
            // Configure API key authorization: partner-key
            Configuration.Default.AddApiKey("partner-key", "YOUR_PARTNER_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.AddApiKeyPrefix("partner-key", "Bearer");

            var apiInstance = new TransactionalEmailsApi();

            try
            {
                // Get the list of blocked domains
                GetBlockedDomains result = apiInstance.GetBlockedDomains();
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling TransactionalEmailsApi.GetBlockedDomains: " + e.Message );
            }
        }
    }
}

Parameters

This endpoint does not need any parameter.

Return type

GetBlockedDomains

Authorization

api-key, partner-key

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetEmailEventReport

GetEmailEventReport GetEmailEventReport (long? limit = null, long? offset = null, string startDate = null, string endDate = null, long? days = null, string email = null, string _event = null, string tags = null, string messageId = null, long? templateId = null, string sort = null)

Get all your transactional email activity (unaggregated events)

This endpoint will show the aggregated stats for past 30 days by default if startDate and endDate OR days is not passed. The date range can not exceed 90 days

Example

using System;
using System.Diagnostics;
using sib_api_v3_sdk.Api;
using sib_api_v3_sdk.Client;
using sib_api_v3_sdk.Model;

namespace Example
{
    public class GetEmailEventReportExample
    {
        public void main()
        {
            // Configure API key authorization: api-key
            Configuration.Default.AddApiKey("api-key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.AddApiKeyPrefix("api-key", "Bearer");
            // Configure API key authorization: partner-key
            Configuration.Default.AddApiKey("partner-key", "YOUR_PARTNER_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.AddApiKeyPrefix("partner-key", "Bearer");

            var apiInstance = new TransactionalEmailsApi();
            var limit = 789;  // long? | Number limitation for the result returned (optional)  (default to 2500)
            var offset = 789;  // long? | Beginning point in the list to retrieve from. (optional)  (default to 0)
            var startDate = startDate_example;  // string | Mandatory if endDate is used. Starting date of the report (YYYY-MM-DD). Must be lower than equal to endDate (optional) 
            var endDate = endDate_example;  // string | Mandatory if startDate is used. Ending date of the report (YYYY-MM-DD). Must be greater than equal to startDate (optional) 
            var days = 789;  // long? | Number of days in the past including today (positive integer). Not compatible with 'startDate' and 'endDate' (optional) 
            var email = email_example;  // string | Filter the report for a specific email addresses (optional) 
            var _event = _event_example;  // string | Filter the report for a specific event type (optional) 
            var tags = tags_example;  // string | Filter the report for tags (serialized and urlencoded array) (optional) 
            var messageId = messageId_example;  // string | Filter on a specific message id (optional) 
            var templateId = 789;  // long? | Filter on a specific template id (optional) 
            var sort = sort_example;  // string | Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed (optional)  (default to desc)

            try
            {
                // Get all your transactional email activity (unaggregated events)
                GetEmailEventReport result = apiInstance.GetEmailEventReport(limit, offset, startDate, endDate, days, email, _event, tags, messageId, templateId, sort);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling TransactionalEmailsApi.GetEmailEventReport: " + e.Message );
            }
        }
    }
}

Parameters

Name	Type	Description	Notes
limit	long?	Number limitation for the result returned	[optional] [default to 2500]
offset	long?	Beginning point in the list to retrieve from.	[optional] [default to 0]
startDate	string	Mandatory if endDate is used. Starting date of the report (YYYY-MM-DD). Must be lower than equal to endDate	[optional]
endDate	string	Mandatory if startDate is used. Ending date of the report (YYYY-MM-DD). Must be greater than equal to startDate	[optional]
days	long?	Number of days in the past including today (positive integer). Not compatible with 'startDate' and 'endDate'	[optional]
email	string	Filter the report for a specific email addresses	[optional]
_event	string	Filter the report for a specific event type	[optional]
tags	string	Filter the report for tags (serialized and urlencoded array)	[optional]
messageId	string	Filter on a specific message id	[optional]
templateId	long?	Filter on a specific template id	[optional]
sort	string	Sort the results in the ascending/descending order of record creation. Default order is descending if `sort` is not passed	[optional] [default to desc]

Return type

GetEmailEventReport

Authorization

api-key, partner-key

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetScheduledEmailByBatchId

GetScheduledEmailByBatchId GetScheduledEmailByBatchId (string batchId, DateTime? startDate = null, DateTime? endDate = null, string sort = null, string status = null, long? limit = null, long? offset = null)

Fetch scheduled emails by batchId

Fetch scheduled batch of emails by batchId (Can retrieve data upto 30 days old)

Example

using System;
using System.Diagnostics;
using sib_api_v3_sdk.Api;
using sib_api_v3_sdk.Client;
using sib_api_v3_sdk.Model;

namespace Example
{
    public class GetScheduledEmailByBatchIdExample
    {
        public void main()
        {
            // Configure API key authorization: api-key
            Configuration.Default.AddApiKey("api-key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.AddApiKeyPrefix("api-key", "Bearer");
            // Configure API key authorization: partner-key
            Configuration.Default.AddApiKey("partner-key", "YOUR_PARTNER_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.AddApiKeyPrefix("partner-key", "Bearer");

            var apiInstance = new TransactionalEmailsApi();
            var batchId = batchId_example;  // string | The batchId of scheduled emails batch (Should be a valid UUIDv4)
            var startDate = 2013-10-20;  // DateTime? | Mandatory if `endDate` is used. Starting date (YYYY-MM-DD) from which you want to fetch the list. Can be maximum 30 days older tha current date. (optional) 
            var endDate = 2013-10-20;  // DateTime? | Mandatory if `startDate` is used. Ending date (YYYY-MM-DD) till which you want to fetch the list. Maximum time period that can be selected is one month. (optional) 
            var sort = sort_example;  // string | Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed (optional)  (default to desc)
            var status = status_example;  // string | Filter the records by `status` of the scheduled email batch or message. (optional) 
            var limit = 789;  // long? | Number of documents returned per page (optional)  (default to 100)
            var offset = 789;  // long? | Index of the first document on the page (optional)  (default to 0)

            try
            {
                // Fetch scheduled emails by batchId
                GetScheduledEmailByBatchId result = apiInstance.GetScheduledEmailByBatchId(batchId, startDate, endDate, sort, status, limit, offset);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling TransactionalEmailsApi.GetScheduledEmailByBatchId: " + e.Message );
            }
        }
    }
}

Parameters

Name	Type	Description	Notes
batchId	string	The batchId of scheduled emails batch (Should be a valid UUIDv4)
startDate	DateTime?	Mandatory if `endDate` is used. Starting date (YYYY-MM-DD) from which you want to fetch the list. Can be maximum 30 days older tha current date.	[optional]
endDate	DateTime?	Mandatory if `startDate` is used. Ending date (YYYY-MM-DD) till which you want to fetch the list. Maximum time period that can be selected is one month.	[optional]
sort	string	Sort the results in the ascending/descending order of record creation. Default order is descending if `sort` is not passed	[optional] [default to desc]
status	string	Filter the records by `status` of the scheduled email batch or message.	[optional]
limit	long?	Number of documents returned per page	[optional] [default to 100]
offset	long?	Index of the first document on the page	[optional] [default to 0]

Return type

GetScheduledEmailByBatchId

Authorization

api-key, partner-key

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetScheduledEmailByMessageId

GetScheduledEmailByMessageId GetScheduledEmailByMessageId (string messageId, DateTime? startDate = null, DateTime? endDate = null)

Fetch scheduled email by messageId

Fetch scheduled email by messageId (Can retrieve data upto 30 days old)

Example

using System;
using System.Diagnostics;
using sib_api_v3_sdk.Api;
using sib_api_v3_sdk.Client;
using sib_api_v3_sdk.Model;

namespace Example
{
    public class GetScheduledEmailByMessageIdExample
    {
        public void main()
        {
            // Configure API key authorization: api-key
            Configuration.Default.AddApiKey("api-key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.AddApiKeyPrefix("api-key", "Bearer");
            // Configure API key authorization: partner-key
            Configuration.Default.AddApiKey("partner-key", "YOUR_PARTNER_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.AddApiKeyPrefix("partner-key", "Bearer");

            var apiInstance = new TransactionalEmailsApi();
            var messageId = messageId_example;  // string | The messageId of scheduled email
            var startDate = 2013-10-20;  // DateTime? | Mandatory if endDate is used. Starting date (YYYY-MM-DD) from which you want to fetch the list. Can be maximum 30 days older tha current date. (optional) 
            var endDate = 2013-10-20;  // DateTime? | Mandatory if startDate is used. Ending date (YYYY-MM-DD) till which you want to fetch the list. Maximum time period that can be selected is one month. (optional) 

            try
            {
                // Fetch scheduled email by messageId
                GetScheduledEmailByMessageId result = apiInstance.GetScheduledEmailByMessageId(messageId, startDate, endDate);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling TransactionalEmailsApi.GetScheduledEmailByMessageId: " + e.Message );
            }
        }
    }
}

Parameters

Name	Type	Description	Notes
messageId	string	The messageId of scheduled email
startDate	DateTime?	Mandatory if endDate is used. Starting date (YYYY-MM-DD) from which you want to fetch the list. Can be maximum 30 days older tha current date.	[optional]
endDate	DateTime?	Mandatory if startDate is used. Ending date (YYYY-MM-DD) till which you want to fetch the list. Maximum time period that can be selected is one month.	[optional]

Return type

GetScheduledEmailByMessageId

Authorization

api-key, partner-key

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetSmtpReport

GetReports GetSmtpReport (long? limit = null, long? offset = null, string startDate = null, string endDate = null, long? days = null, string tag = null, string sort = null)

Get your transactional email activity aggregated per day

Example

using System;
using System.Diagnostics;
using sib_api_v3_sdk.Api;
using sib_api_v3_sdk.Client;
using sib_api_v3_sdk.Model;

namespace Example
{
    public class GetSmtpReportExample
    {
        public void main()
        {
            // Configure API key authorization: api-key
            Configuration.Default.AddApiKey("api-key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.AddApiKeyPrefix("api-key", "Bearer");
            // Configure API key authorization: partner-key
            Configuration.Default.AddApiKey("partner-key", "YOUR_PARTNER_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.AddApiKeyPrefix("partner-key", "Bearer");

            var apiInstance = new TransactionalEmailsApi();
            var limit = 789;  // long? | Number of documents returned per page (optional)  (default to 10)
            var offset = 789;  // long? | Index of the first document on the page (optional)  (default to 0)
            var startDate = startDate_example;  // string | Mandatory if endDate is used. Starting date of the report (YYYY-MM-DD) (optional) 
            var endDate = endDate_example;  // string | Mandatory if startDate is used. Ending date of the report (YYYY-MM-DD) (optional) 
            var days = 789;  // long? | Number of days in the past including today (positive integer). Not compatible with 'startDate' and 'endDate' (optional) 
            var tag = tag_example;  // string | Tag of the emails (optional) 
            var sort = sort_example;  // string | Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed (optional)  (default to desc)

            try
            {
                // Get your transactional email activity aggregated per day
                GetReports result = apiInstance.GetSmtpReport(limit, offset, startDate, endDate, days, tag, sort);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling TransactionalEmailsApi.GetSmtpReport: " + e.Message );
            }
        }
    }
}

Parameters

Name	Type	Description	Notes
limit	long?	Number of documents returned per page	[optional] [default to 10]
offset	long?	Index of the first document on the page	[optional] [default to 0]
startDate	string	Mandatory if endDate is used. Starting date of the report (YYYY-MM-DD)	[optional]
endDate	string	Mandatory if startDate is used. Ending date of the report (YYYY-MM-DD)	[optional]
days	long?	Number of days in the past including today (positive integer). Not compatible with 'startDate' and 'endDate'	[optional]
tag	string	Tag of the emails	[optional]
sort	string	Sort the results in the ascending/descending order of record creation. Default order is descending if `sort` is not passed	[optional] [default to desc]

Return type

GetReports

Authorization

api-key, partner-key

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetSmtpTemplate

GetSmtpTemplateOverview GetSmtpTemplate (long? templateId)

Returns the template information

Example

using System;
using System.Diagnostics;
using sib_api_v3_sdk.Api;
using sib_api_v3_sdk.Client;
using sib_api_v3_sdk.Model;

namespace Example
{
    public class GetSmtpTemplateExample
    {
        public void main()
        {
            // Configure API key authorization: api-key
            Configuration.Default.AddApiKey("api-key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.AddApiKeyPrefix("api-key", "Bearer");
            // Configure API key authorization: partner-key
            Configuration.Default.AddApiKey("partner-key", "YOUR_PARTNER_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.AddApiKeyPrefix("partner-key", "Bearer");

            var apiInstance = new TransactionalEmailsApi();
            var templateId = 789;  // long? | id of the template

            try
            {
                // Returns the template information
                GetSmtpTemplateOverview result = apiInstance.GetSmtpTemplate(templateId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling TransactionalEmailsApi.GetSmtpTemplate: " + e.Message );
            }
        }
    }
}

Parameters

Name	Type	Description	Notes
templateId	long?	id of the template

Return type

GetSmtpTemplateOverview

Authorization

api-key, partner-key

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetSmtpTemplates

GetSmtpTemplates GetSmtpTemplates (bool? templateStatus = null, long? limit = null, long? offset = null, string sort = null)

Get the list of email templates

Example

using System;
using System.Diagnostics;
using sib_api_v3_sdk.Api;
using sib_api_v3_sdk.Client;
using sib_api_v3_sdk.Model;

namespace Example
{
    public class GetSmtpTemplatesExample
    {
        public void main()
        {
            // Configure API key authorization: api-key
            Configuration.Default.AddApiKey("api-key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.AddApiKeyPrefix("api-key", "Bearer");
            // Configure API key authorization: partner-key
            Configuration.Default.AddApiKey("partner-key", "YOUR_PARTNER_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.AddApiKeyPrefix("partner-key", "Bearer");

            var apiInstance = new TransactionalEmailsApi();
            var templateStatus = true;  // bool? | Filter on the status of the template. Active = true, inactive = false (optional) 
            var limit = 789;  // long? | Number of documents returned per page (optional)  (default to 50)
            var offset = 789;  // long? | Index of the first document in the page (optional)  (default to 0)
            var sort = sort_example;  // string | Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed (optional)  (default to desc)

            try
            {
                // Get the list of email templates
                GetSmtpTemplates result = apiInstance.GetSmtpTemplates(templateStatus, limit, offset, sort);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling TransactionalEmailsApi.GetSmtpTemplates: " + e.Message );
            }
        }
    }
}

Parameters

Name	Type	Description	Notes
templateStatus	bool?	Filter on the status of the template. Active = true, inactive = false	[optional]
limit	long?	Number of documents returned per page	[optional] [default to 50]
offset	long?	Index of the first document in the page	[optional] [default to 0]
sort	string	Sort the results in the ascending/descending order of record creation. Default order is descending if `sort` is not passed	[optional] [default to desc]

Return type

GetSmtpTemplates

Authorization

api-key, partner-key

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetTransacBlockedContacts

GetTransacBlockedContacts GetTransacBlockedContacts (string startDate = null, string endDate = null, long? limit = null, long? offset = null, List senders = null, string sort = null)

Get the list of blocked or unsubscribed transactional contacts

Example

using System;
using System.Diagnostics;
using sib_api_v3_sdk.Api;
using sib_api_v3_sdk.Client;
using sib_api_v3_sdk.Model;

namespace Example
{
    public class GetTransacBlockedContactsExample
    {
        public void main()
        {
            // Configure API key authorization: api-key
            Configuration.Default.AddApiKey("api-key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.AddApiKeyPrefix("api-key", "Bearer");
            // Configure API key authorization: partner-key
            Configuration.Default.AddApiKey("partner-key", "YOUR_PARTNER_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.AddApiKeyPrefix("partner-key", "Bearer");

            var apiInstance = new TransactionalEmailsApi();
            var startDate = startDate_example;  // string | Mandatory if endDate is used. Starting date (YYYY-MM-DD) from which you want to fetch the blocked or unsubscribed contacts (optional) 
            var endDate = endDate_example;  // string | Mandatory if startDate is used. Ending date (YYYY-MM-DD) till which you want to fetch the blocked or unsubscribed contacts (optional) 
            var limit = 789;  // long? | Number of documents returned per page (optional)  (default to 50)
            var offset = 789;  // long? | Index of the first document on the page (optional)  (default to 0)
            var senders = new List<string>(); // List<string> | Comma separated list of emails of the senders from which contacts are blocked or unsubscribed (optional) 
            var sort = sort_example;  // string | Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed (optional)  (default to desc)

            try
            {
                // Get the list of blocked or unsubscribed transactional contacts
                GetTransacBlockedContacts result = apiInstance.GetTransacBlockedContacts(startDate, endDate, limit, offset, senders, sort);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling TransactionalEmailsApi.GetTransacBlockedContacts: " + e.Message );
            }
        }
    }
}

Parameters

Name	Type	Description	Notes
startDate	string	Mandatory if endDate is used. Starting date (YYYY-MM-DD) from which you want to fetch the blocked or unsubscribed contacts	[optional]
endDate	string	Mandatory if startDate is used. Ending date (YYYY-MM-DD) till which you want to fetch the blocked or unsubscribed contacts	[optional]
limit	long?	Number of documents returned per page	[optional] [default to 50]
offset	long?	Index of the first document on the page	[optional] [default to 0]
senders	List<string>	Comma separated list of emails of the senders from which contacts are blocked or unsubscribed	[optional]
sort	string	Sort the results in the ascending/descending order of record creation. Default order is descending if `sort` is not passed	[optional] [default to desc]

Return type

GetTransacBlockedContacts

Authorization

api-key, partner-key

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetTransacEmailContent

GetTransacEmailContent GetTransacEmailContent (string uuid)

Get the personalized content of a sent transactional email

Example

using System;
using System.Diagnostics;
using sib_api_v3_sdk.Api;
using sib_api_v3_sdk.Client;
using sib_api_v3_sdk.Model;

namespace Example
{
    public class GetTransacEmailContentExample
    {
        public void main()
        {
            // Configure API key authorization: api-key
            Configuration.Default.AddApiKey("api-key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.AddApiKeyPrefix("api-key", "Bearer");
            // Configure API key authorization: partner-key
            Configuration.Default.AddApiKey("partner-key", "YOUR_PARTNER_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.AddApiKeyPrefix("partner-key", "Bearer");

            var apiInstance = new TransactionalEmailsApi();
            var uuid = uuid_example;  // string | Unique id of the transactional email that has been sent to a particular contact

            try
            {
                // Get the personalized content of a sent transactional email
                GetTransacEmailContent result = apiInstance.GetTransacEmailContent(uuid);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling TransactionalEmailsApi.GetTransacEmailContent: " + e.Message );
            }
        }
    }
}

Parameters

Name	Type	Description	Notes
uuid	string	Unique id of the transactional email that has been sent to a particular contact

Return type

GetTransacEmailContent

Authorization

api-key, partner-key

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetTransacEmailsList

GetTransacEmailsList GetTransacEmailsList (string email = null, long? templateId = null, string messageId = null, string startDate = null, string endDate = null, string sort = null, long? limit = null, long? offset = null)

Get the list of transactional emails on the basis of allowed filters

This endpoint will show the list of emails for past 30 days by default. To retrieve emails before that time, please pass startDate and endDate in query filters.

Example

using System;
using System.Diagnostics;
using sib_api_v3_sdk.Api;
using sib_api_v3_sdk.Client;
using sib_api_v3_sdk.Model;

namespace Example
{
    public class GetTransacEmailsListExample
    {
        public void main()
        {
            // Configure API key authorization: api-key
            Configuration.Default.AddApiKey("api-key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.AddApiKeyPrefix("api-key", "Bearer");
            // Configure API key authorization: partner-key
            Configuration.Default.AddApiKey("partner-key", "YOUR_PARTNER_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.AddApiKeyPrefix("partner-key", "Bearer");

            var apiInstance = new TransactionalEmailsApi();
            var email = email_example;  // string | Mandatory if templateId and messageId are not passed in query filters. Email address to which transactional email has been sent. (optional) 
            var templateId = 789;  // long? | Mandatory if email and messageId are not passed in query filters. Id of the template that was used to compose transactional email. (optional) 
            var messageId = messageId_example;  // string | Mandatory if templateId and email are not passed in query filters. Message ID of the transactional email sent. (optional) 
            var startDate = startDate_example;  // string | Mandatory if endDate is used. Starting date (YYYY-MM-DD) from which you want to fetch the list. Maximum time period that can be selected is one month. (optional) 
            var endDate = endDate_example;  // string | Mandatory if startDate is used. Ending date (YYYY-MM-DD) till which you want to fetch the list. Maximum time period that can be selected is one month. (optional) 
            var sort = sort_example;  // string | Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed (optional)  (default to desc)
            var limit = 789;  // long? | Number of documents returned per page (optional)  (default to 500)
            var offset = 789;  // long? | Index of the first document in the page (optional)  (default to 0)

            try
            {
                // Get the list of transactional emails on the basis of allowed filters
                GetTransacEmailsList result = apiInstance.GetTransacEmailsList(email, templateId, messageId, startDate, endDate, sort, limit, offset);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling TransactionalEmailsApi.GetTransacEmailsList: " + e.Message );
            }
        }
    }
}

Parameters

Name	Type	Description	Notes
email	string	Mandatory if templateId and messageId are not passed in query filters. Email address to which transactional email has been sent.	[optional]
templateId	long?	Mandatory if email and messageId are not passed in query filters. Id of the template that was used to compose transactional email.	[optional]
messageId	string	Mandatory if templateId and email are not passed in query filters. Message ID of the transactional email sent.	[optional]
startDate	string	Mandatory if endDate is used. Starting date (YYYY-MM-DD) from which you want to fetch the list. Maximum time period that can be selected is one month.	[optional]
endDate	string	Mandatory if startDate is used. Ending date (YYYY-MM-DD) till which you want to fetch the list. Maximum time period that can be selected is one month.	[optional]
sort	string	Sort the results in the ascending/descending order of record creation. Default order is descending if `sort` is not passed	[optional] [default to desc]
limit	long?	Number of documents returned per page	[optional] [default to 500]
offset	long?	Index of the first document in the page	[optional] [default to 0]

Return type

GetTransacEmailsList

Authorization

api-key, partner-key

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

SendTestTemplate

void SendTestTemplate (long? templateId, SendTestEmail sendTestEmail)

Send a template to your test list

Example

using System;
using System.Diagnostics;
using sib_api_v3_sdk.Api;
using sib_api_v3_sdk.Client;
using sib_api_v3_sdk.Model;

namespace Example
{
    public class SendTestTemplateExample
    {
        public void main()
        {
            // Configure API key authorization: api-key
            Configuration.Default.AddApiKey("api-key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.AddApiKeyPrefix("api-key", "Bearer");
            // Configure API key authorization: partner-key
            Configuration.Default.AddApiKey("partner-key", "YOUR_PARTNER_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.AddApiKeyPrefix("partner-key", "Bearer");

            var apiInstance = new TransactionalEmailsApi();
            var templateId = 789;  // long? | Id of the template
            var sendTestEmail = new SendTestEmail(); // SendTestEmail | 

            try
            {
                // Send a template to your test list
                apiInstance.SendTestTemplate(templateId, sendTestEmail);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling TransactionalEmailsApi.SendTestTemplate: " + e.Message );
            }
        }
    }
}

Parameters

Name	Type	Description	Notes
templateId	long?	Id of the template
sendTestEmail	SendTestEmail

Return type

void (empty response body)

Authorization

api-key, partner-key

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

SendTransacEmail

CreateSmtpEmail SendTransacEmail (SendSmtpEmail sendSmtpEmail)

Send a transactional email

Example

using System;
using System.Diagnostics;
using sib_api_v3_sdk.Api;
using sib_api_v3_sdk.Client;
using sib_api_v3_sdk.Model;

namespace Example
{
    public class SendTransacEmailExample
    {
        public void main()
        {
            // Configure API key authorization: api-key
            Configuration.Default.AddApiKey("api-key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.AddApiKeyPrefix("api-key", "Bearer");
            // Configure API key authorization: partner-key
            Configuration.Default.AddApiKey("partner-key", "YOUR_PARTNER_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.AddApiKeyPrefix("partner-key", "Bearer");

            var apiInstance = new TransactionalEmailsApi();
            var sendSmtpEmail = new SendSmtpEmail(); // SendSmtpEmail | Values to send a transactional email

            try
            {
                // Send a transactional email
                CreateSmtpEmail result = apiInstance.SendTransacEmail(sendSmtpEmail);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling TransactionalEmailsApi.SendTransacEmail: " + e.Message );
            }
        }
    }
}

Parameters

Name	Type	Description	Notes
sendSmtpEmail	SendSmtpEmail	Values to send a transactional email

Return type

CreateSmtpEmail

Authorization

api-key, partner-key

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

SmtpBlockedContactsEmailDelete

void SmtpBlockedContactsEmailDelete (string email)

Unblock or resubscribe a transactional contact

Example

using System;
using System.Diagnostics;
using sib_api_v3_sdk.Api;
using sib_api_v3_sdk.Client;
using sib_api_v3_sdk.Model;

namespace Example
{
    public class SmtpBlockedContactsEmailDeleteExample
    {
        public void main()
        {
            // Configure API key authorization: api-key
            Configuration.Default.AddApiKey("api-key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.AddApiKeyPrefix("api-key", "Bearer");
            // Configure API key authorization: partner-key
            Configuration.Default.AddApiKey("partner-key", "YOUR_PARTNER_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.AddApiKeyPrefix("partner-key", "Bearer");

            var apiInstance = new TransactionalEmailsApi();
            var email = email_example;  // string | contact email (urlencoded) to unblock.

            try
            {
                // Unblock or resubscribe a transactional contact
                apiInstance.SmtpBlockedContactsEmailDelete(email);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling TransactionalEmailsApi.SmtpBlockedContactsEmailDelete: " + e.Message );
            }
        }
    }
}

Parameters

Name	Type	Description	Notes
email	string	contact email (urlencoded) to unblock.

Return type

void (empty response body)

Authorization

api-key, partner-key

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

SmtpLogMessageIdDelete

void SmtpLogMessageIdDelete (string messageId)

Delete an SMTP transactional log

Example

using System;
using System.Diagnostics;
using sib_api_v3_sdk.Api;
using sib_api_v3_sdk.Client;
using sib_api_v3_sdk.Model;

namespace Example
{
    public class SmtpLogMessageIdDeleteExample
    {
        public void main()
        {
            // Configure API key authorization: api-key
            Configuration.Default.AddApiKey("api-key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.AddApiKeyPrefix("api-key", "Bearer");
            // Configure API key authorization: partner-key
            Configuration.Default.AddApiKey("partner-key", "YOUR_PARTNER_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.AddApiKeyPrefix("partner-key", "Bearer");

            var apiInstance = new TransactionalEmailsApi();
            var messageId = messageId_example;  // string | MessageId of the transactional log to delete

            try
            {
                // Delete an SMTP transactional log
                apiInstance.SmtpLogMessageIdDelete(messageId);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling TransactionalEmailsApi.SmtpLogMessageIdDelete: " + e.Message );
            }
        }
    }
}

Parameters

Name	Type	Description	Notes
messageId	string	MessageId of the transactional log to delete

Return type

void (empty response body)

Authorization

api-key, partner-key

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

UpdateSmtpTemplate

void UpdateSmtpTemplate (long? templateId, UpdateSmtpTemplate smtpTemplate)

Update an email template

Example

using System;
using System.Diagnostics;
using sib_api_v3_sdk.Api;
using sib_api_v3_sdk.Client;
using sib_api_v3_sdk.Model;

namespace Example
{
    public class UpdateSmtpTemplateExample
    {
        public void main()
        {
            // Configure API key authorization: api-key
            Configuration.Default.AddApiKey("api-key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.AddApiKeyPrefix("api-key", "Bearer");
            // Configure API key authorization: partner-key
            Configuration.Default.AddApiKey("partner-key", "YOUR_PARTNER_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.AddApiKeyPrefix("partner-key", "Bearer");

            var apiInstance = new TransactionalEmailsApi();
            var templateId = 789;  // long? | id of the template
            var smtpTemplate = new UpdateSmtpTemplate(); // UpdateSmtpTemplate | values to update in transactional email template

            try
            {
                // Update an email template
                apiInstance.UpdateSmtpTemplate(templateId, smtpTemplate);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling TransactionalEmailsApi.UpdateSmtpTemplate: " + e.Message );
            }
        }
    }
}

Parameters

Name	Type	Description	Notes
templateId	long?	id of the template
smtpTemplate	UpdateSmtpTemplate	values to update in transactional email template

Return type

void (empty response body)

Authorization

api-key, partner-key

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

Files

TransactionalEmailsApi.md

Latest commit

History

TransactionalEmailsApi.md

File metadata and controls

sib_api_v3_sdk.Api.TransactionalEmailsApi

BlockNewDomain

Example

Parameters

Return type

Authorization

HTTP request headers

CreateSmtpTemplate

Example

Parameters

Return type

Authorization

HTTP request headers

DeleteBlockedDomain

Example

Parameters

Return type

Authorization

HTTP request headers

DeleteHardbounces

Example

Parameters

Return type

Authorization

HTTP request headers

DeleteScheduledEmailById

Example

Parameters

Return type

Authorization

HTTP request headers

DeleteSmtpTemplate

Example

Parameters

Return type

Authorization

HTTP request headers

GetAggregatedSmtpReport

Example

Parameters

Return type

Authorization

HTTP request headers

GetBlockedDomains

Example

Parameters

Return type

Authorization

HTTP request headers

GetEmailEventReport

Example

Parameters

Return type

Authorization

HTTP request headers

GetScheduledEmailByBatchId

Example

Parameters

Return type

Authorization

HTTP request headers

GetScheduledEmailByMessageId

Example

Parameters

Return type

Authorization

HTTP request headers

GetSmtpReport

Example

Parameters

Return type

Authorization

HTTP request headers

GetSmtpTemplate