Skip to content

Latest commit

 

History

History
277 lines (214 loc) · 7.96 KB

TransactionalEmailApi.md

File metadata and controls

277 lines (214 loc) · 7.96 KB

IO.ClickSend.ClickSend.Api.TransactionalEmailApi

All URIs are relative to https://rest.clicksend.com/v3

Method HTTP request Description
EmailHistoryExportGet GET /email/history/export Export all Transactional Email history
EmailHistoryGet GET /email/history Get all transactional email history
EmailPricePost POST /email/price Get transactional email price
EmailSendPost POST /email/send Send transactional email

EmailHistoryExportGet

string EmailHistoryExportGet (string filename, int? dateFrom = null, int? dateTo = null)

Export all Transactional Email history

Export all Transactional Email history

Example

using System;
using System.Diagnostics;
using IO.ClickSend.ClickSend.Api;
using IO.ClickSend.Client;
using IO.ClickSend.ClickSend.Model;

namespace Example
{
    public class EmailHistoryExportGetExample
    {
        public void main()
        {
            // Configure HTTP basic authorization: BasicAuth
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";

            var apiInstance = new TransactionalEmailApi();
            var filename = filename_example;  // string | Filename to download history as
            var dateFrom = 56;  // int? | Start date (optional) 
            var dateTo = 56;  // int? | End date (optional) 

            try
            {
                // Export all Transactional Email history
                string result = apiInstance.EmailHistoryExportGet(filename, dateFrom, dateTo);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling TransactionalEmailApi.EmailHistoryExportGet: " + e.Message );
            }
        }
    }
}

Parameters

Name Type Description Notes
filename string Filename to download history as
dateFrom int? Start date [optional]
dateTo int? End date [optional]

Return type

string

Authorization

BasicAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

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

EmailHistoryGet

string EmailHistoryGet (int? dateFrom = null, int? dateTo = null, int? page = null, int? limit = null)

Get all transactional email history

Get all transactional email history

Example

using System;
using System.Diagnostics;
using IO.ClickSend.ClickSend.Api;
using IO.ClickSend.Client;
using IO.ClickSend.ClickSend.Model;

namespace Example
{
    public class EmailHistoryGetExample
    {
        public void main()
        {
            // Configure HTTP basic authorization: BasicAuth
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";

            var apiInstance = new TransactionalEmailApi();
            var dateFrom = 56;  // int? | Start date (optional) 
            var dateTo = 56;  // int? | End date (optional) 
            var page = 56;  // int? | Page number (optional)  (default to 1)
            var limit = 56;  // int? | Number of records per page (optional)  (default to 10)

            try
            {
                // Get all transactional email history
                string result = apiInstance.EmailHistoryGet(dateFrom, dateTo, page, limit);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling TransactionalEmailApi.EmailHistoryGet: " + e.Message );
            }
        }
    }
}

Parameters

Name Type Description Notes
dateFrom int? Start date [optional]
dateTo int? End date [optional]
page int? Page number [optional] [default to 1]
limit int? Number of records per page [optional] [default to 10]

Return type

string

Authorization

BasicAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

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

EmailPricePost

string EmailPricePost (Email body)

Get transactional email price

Get transactional email price

Example

using System;
using System.Diagnostics;
using IO.ClickSend.ClickSend.Api;
using IO.ClickSend.Client;
using IO.ClickSend.ClickSend.Model;

namespace Example
{
    public class EmailPricePostExample
    {
        public void main()
        {
            // Configure HTTP basic authorization: BasicAuth
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";

            var apiInstance = new TransactionalEmailApi();
            var body = new Email(); // Email | Email model

            try
            {
                // Get transactional email price
                string result = apiInstance.EmailPricePost(body);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling TransactionalEmailApi.EmailPricePost: " + e.Message );
            }
        }
    }
}

Parameters

Name Type Description Notes
body Email Email model

Return type

string

Authorization

BasicAuth

HTTP request headers

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

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

EmailSendPost

string EmailSendPost (Email body)

Send transactional email

Send transactional email

Example

using System;
using System.Diagnostics;
using IO.ClickSend.ClickSend.Api;
using IO.ClickSend.Client;
using IO.ClickSend.ClickSend.Model;

namespace Example
{
    public class EmailSendPostExample
    {
        public void main()
        {
            // Configure HTTP basic authorization: BasicAuth
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";

            var apiInstance = new TransactionalEmailApi();
            var body = new Email(); // Email | Email model

            try
            {
                // Send transactional email
                string result = apiInstance.EmailSendPost(body);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling TransactionalEmailApi.EmailSendPost: " + e.Message );
            }
        }
    }
}

Parameters

Name Type Description Notes
body Email Email model

Return type

string

Authorization

BasicAuth

HTTP request headers

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

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