IO.ClickSend.ClickSend.Api.EmailMarketingApi

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

Method	HTTP request	Description
AllowedEmailAddressGet	GET /email/addresses	Get all email addresses
AllowedEmailAddressPost	POST /email/addresses	Create allowed Email Address
CancelEmailCampaignPut	PUT /email-campaigns/{email_campaign_id}/cancel	Cancel email campaign
EmailCampaignGet	GET /email-campaigns/{email_campaign_id}	Get specific email campaign
EmailCampaignHistoryExportGet	GET /email-campaigns/{email_campaign_id}/history/export	Export specific email campaign history
EmailCampaignHistoryGet	GET /email-campaigns/{email_campaign_id}/history	Get specific email campaign history
EmailCampaignPost	POST /email-campaigns/send	Send email campaign
EmailCampaignPricePost	POST /email-campaigns/price	Calculate email campaign price
EmailCampaignPut	PUT /email-campaigns/{email_campaign_id}	Edit email campaign
EmailCampaignsGet	GET /email-campaigns	Get all email campaigns
SendVerificationTokenGet	PUT /email/address-verify/{email_address_id}/send	Send verification token
SpecificAllowedEmailAddressDelete	DELETE /email/addresses/{email_address_id}	Delete specific email address
SpecificAllowedEmailAddressGet	GET /email/addresses/{email_address_id}	Get specific email address
VerifyAllowedEmailAddressGet	PUT /email/address-verify/{email_address_id}/verify/{activation_token}	Verify email address using verification token

AllowedEmailAddressGet

string AllowedEmailAddressGet (int? page = null, int? limit = null)

Get all email addresses

Example

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

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

            var apiInstance = new EmailMarketingApi();
            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 email addresses
                string result = apiInstance.AllowedEmailAddressGet(page, limit);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling EmailMarketingApi.AllowedEmailAddressGet: " + e.Message );
            }
        }
    }
}

Parameters

Name	Type	Description	Notes
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]

AllowedEmailAddressPost

string AllowedEmailAddressPost (EmailAddress body = null)

Create allowed Email Address

Example

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

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

            var apiInstance = new EmailMarketingApi();
            var body = new EmailAddress(); // EmailAddress |  (optional) 

            try
            {
                // Create allowed Email Address
                string result = apiInstance.AllowedEmailAddressPost(body);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling EmailMarketingApi.AllowedEmailAddressPost: " + e.Message );
            }
        }
    }
}

Parameters

Name	Type	Description	Notes
body	EmailAddress		[optional]

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]

CancelEmailCampaignPut

string CancelEmailCampaignPut (int? emailCampaignId)

Cancel email campaign

Example

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

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

            var apiInstance = new EmailMarketingApi();
            var emailCampaignId = 56;  // int? | Allowed email campaign id

            try
            {
                // Cancel email campaign
                string result = apiInstance.CancelEmailCampaignPut(emailCampaignId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling EmailMarketingApi.CancelEmailCampaignPut: " + e.Message );
            }
        }
    }
}

Parameters

Name	Type	Description	Notes
emailCampaignId	int?	Allowed email campaign id

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]

EmailCampaignGet

string EmailCampaignGet (int? emailCampaignId)

Get specific email campaign

Example

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

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

            var apiInstance = new EmailMarketingApi();
            var emailCampaignId = 56;  // int? | Allowed email campaign id

            try
            {
                // Get specific email campaign
                string result = apiInstance.EmailCampaignGet(emailCampaignId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling EmailMarketingApi.EmailCampaignGet: " + e.Message );
            }
        }
    }
}

Parameters

Name	Type	Description	Notes
emailCampaignId	int?	Allowed email campaign id

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]

EmailCampaignHistoryExportGet

string EmailCampaignHistoryExportGet (int? emailCampaignId, int? dateFrom = null, int? dateTo = null)

Export specific email campaign 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 EmailCampaignHistoryExportGetExample
    {
        public void main()
        {
            // Configure HTTP basic authorization: BasicAuth
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";

            var apiInstance = new EmailMarketingApi();
            var emailCampaignId = 56;  // int? | Allowed email campaign id
            var dateFrom = 56;  // int? | Start date (optional) 
            var dateTo = 56;  // int? | End date (optional) 

            try
            {
                // Export specific email campaign history
                string result = apiInstance.EmailCampaignHistoryExportGet(emailCampaignId, dateFrom, dateTo);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling EmailMarketingApi.EmailCampaignHistoryExportGet: " + e.Message );
            }
        }
    }
}

Parameters

Name	Type	Description	Notes
emailCampaignId	int?	Allowed email campaign id
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]

EmailCampaignHistoryGet

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

Get specific email campaign 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 EmailCampaignHistoryGetExample
    {
        public void main()
        {
            // Configure HTTP basic authorization: BasicAuth
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";

            var apiInstance = new EmailMarketingApi();
            var emailCampaignId = 56;  // int? | Allowed email campaign id
            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 specific email campaign history
                string result = apiInstance.EmailCampaignHistoryGet(emailCampaignId, dateFrom, dateTo, page, limit);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling EmailMarketingApi.EmailCampaignHistoryGet: " + e.Message );
            }
        }
    }
}

Parameters

Name	Type	Description	Notes
emailCampaignId	int?	Allowed email campaign id
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]

EmailCampaignPost

string EmailCampaignPost (EmailCampaign body)

Send email campaign

Example

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

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

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

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

Parameters

Name	Type	Description	Notes
body	EmailCampaign	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]

EmailCampaignPricePost

string EmailCampaignPricePost (EmailCampaign body)

Calculate email campaign 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 EmailCampaignPricePostExample
    {
        public void main()
        {
            // Configure HTTP basic authorization: BasicAuth
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";

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

            try
            {
                // Calculate email campaign price
                string result = apiInstance.EmailCampaignPricePost(body);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling EmailMarketingApi.EmailCampaignPricePost: " + e.Message );
            }
        }
    }
}

Parameters

Name	Type	Description	Notes
body	EmailCampaign	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]

EmailCampaignPut

string EmailCampaignPut (EmailCampaign body, int? emailCampaignId)

Edit email campaign

Example

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

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

            var apiInstance = new EmailMarketingApi();
            var body = new EmailCampaign(); // EmailCampaign | Email model
            var emailCampaignId = 56;  // int? | Allowed email campaign id

            try
            {
                // Edit email campaign
                string result = apiInstance.EmailCampaignPut(body, emailCampaignId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling EmailMarketingApi.EmailCampaignPut: " + e.Message );
            }
        }
    }
}

Parameters

Name	Type	Description	Notes
body	EmailCampaign	Email model
emailCampaignId	int?	Allowed email campaign id

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]

EmailCampaignsGet

string EmailCampaignsGet (int? page = null, int? limit = null)

Get all email campaigns

Example

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

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

            var apiInstance = new EmailMarketingApi();
            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 email campaigns
                string result = apiInstance.EmailCampaignsGet(page, limit);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling EmailMarketingApi.EmailCampaignsGet: " + e.Message );
            }
        }
    }
}

Parameters

Name	Type	Description	Notes
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]

SendVerificationTokenGet

string SendVerificationTokenGet (int? emailAddressId)

Send verification token

Example

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

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

            var apiInstance = new EmailMarketingApi();
            var emailAddressId = 56;  // int? | Allowed email address id

            try
            {
                // Send verification token
                string result = apiInstance.SendVerificationTokenGet(emailAddressId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling EmailMarketingApi.SendVerificationTokenGet: " + e.Message );
            }
        }
    }
}

Parameters

Name	Type	Description	Notes
emailAddressId	int?	Allowed email address id

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]

SpecificAllowedEmailAddressDelete

string SpecificAllowedEmailAddressDelete (int? emailAddressId)

Delete specific email address

Example

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

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

            var apiInstance = new EmailMarketingApi();
            var emailAddressId = 56;  // int? | Allowed email address id

            try
            {
                // Delete specific email address
                string result = apiInstance.SpecificAllowedEmailAddressDelete(emailAddressId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling EmailMarketingApi.SpecificAllowedEmailAddressDelete: " + e.Message );
            }
        }
    }
}

Parameters

Name	Type	Description	Notes
emailAddressId	int?	Allowed email address id

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]

SpecificAllowedEmailAddressGet

string SpecificAllowedEmailAddressGet (int? emailAddressId)

Get specific email address

Example

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

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

            var apiInstance = new EmailMarketingApi();
            var emailAddressId = 56;  // int? | Allowed email address id

            try
            {
                // Get specific email address
                string result = apiInstance.SpecificAllowedEmailAddressGet(emailAddressId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling EmailMarketingApi.SpecificAllowedEmailAddressGet: " + e.Message );
            }
        }
    }
}

Parameters

Name	Type	Description	Notes
emailAddressId	int?	Allowed email address id

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]

VerifyAllowedEmailAddressGet

string VerifyAllowedEmailAddressGet (int? emailAddressId, string activationToken)

Verify email address using verification token

Example

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

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

            var apiInstance = new EmailMarketingApi();
            var emailAddressId = 56;  // int? | Allowed email address id
            var activationToken = activationToken_example;  // string | Your activation token.

            try
            {
                // Verify email address using verification token
                string result = apiInstance.VerifyAllowedEmailAddressGet(emailAddressId, activationToken);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling EmailMarketingApi.VerifyAllowedEmailAddressGet: " + e.Message );
            }
        }
    }
}

Parameters

Name	Type	Description	Notes
emailAddressId	int?	Allowed email address id
activationToken	string	Your activation token.

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]

Files

EmailMarketingApi.md

Latest commit

History

EmailMarketingApi.md

File metadata and controls

IO.ClickSend.ClickSend.Api.EmailMarketingApi

AllowedEmailAddressGet

Example

Parameters

Return type

Authorization

HTTP request headers

AllowedEmailAddressPost

Example

Parameters

Return type

Authorization

HTTP request headers

CancelEmailCampaignPut

Example

Parameters

Return type

Authorization

HTTP request headers

EmailCampaignGet

Example

Parameters

Return type

Authorization

HTTP request headers

EmailCampaignHistoryExportGet

Example

Parameters

Return type

Authorization

HTTP request headers

EmailCampaignHistoryGet

Example

Parameters

Return type

Authorization

HTTP request headers

EmailCampaignPost

Example

Parameters

Return type

Authorization

HTTP request headers

EmailCampaignPricePost

Example

Parameters

Return type

Authorization

HTTP request headers

EmailCampaignPut

Example

Parameters

Return type

Authorization

HTTP request headers

EmailCampaignsGet

Example

Parameters

Return type

Authorization

HTTP request headers

SendVerificationTokenGet

Example

Parameters

Return type

Authorization

HTTP request headers

SpecificAllowedEmailAddressDelete

Example

Parameters

Return type

Authorization

HTTP request headers

SpecificAllowedEmailAddressGet