Skip to content

Latest commit

 

History

History
338 lines (260 loc) · 10.8 KB

EmailDeliveryReceiptRulesApi.md

File metadata and controls

338 lines (260 loc) · 10.8 KB
Raw

IO.ClickSend.ClickSend.Api.EmailDeliveryReceiptRulesApi

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

Method HTTP request Description
EmailDeliveryReceiptAutomationDelete DELETE /automations/email/receipts/{receipt_rule_id} Delete email delivery receipt automation
EmailDeliveryReceiptAutomationGet GET /automations/email/receipts/{receipt_rule_id} Get specific email delivery receipt automation
EmailDeliveryReceiptAutomationPost POST /automations/email/receipts Create email delivery receipt automations
EmailDeliveryReceiptAutomationPut PUT /automations/email/receipts/{receipt_rule_id} Update email delivery receipt automation
EmailDeliveryReceiptAutomationsGet GET /automations/email/receipts Get all email delivery receipt automations

EmailDeliveryReceiptAutomationDelete

string EmailDeliveryReceiptAutomationDelete (int? receiptRuleId)

Delete email delivery receipt automation

Delete email delivery receipt automation

Example

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

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

            var apiInstance = new EmailDeliveryReceiptRulesApi();
            var receiptRuleId = 56;  // int? | Receipt rule id

            try
            {
                // Delete email delivery receipt automation
                string result = apiInstance.EmailDeliveryReceiptAutomationDelete(receiptRuleId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling EmailDeliveryReceiptRulesApi.EmailDeliveryReceiptAutomationDelete: " + e.Message );
            }
        }
    }
}

Parameters

Name Type Description Notes
receiptRuleId int? Receipt rule 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]

EmailDeliveryReceiptAutomationGet

string EmailDeliveryReceiptAutomationGet (int? receiptRuleId)

Get specific email delivery receipt automation

Get specific email delivery receipt automation

Example

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

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

            var apiInstance = new EmailDeliveryReceiptRulesApi();
            var receiptRuleId = 56;  // int? | Receipt rule id

            try
            {
                // Get specific email delivery receipt automation
                string result = apiInstance.EmailDeliveryReceiptAutomationGet(receiptRuleId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling EmailDeliveryReceiptRulesApi.EmailDeliveryReceiptAutomationGet: " + e.Message );
            }
        }
    }
}

Parameters

Name Type Description Notes
receiptRuleId int? Receipt rule 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]

EmailDeliveryReceiptAutomationPost

string EmailDeliveryReceiptAutomationPost (DeliveryReceiptRule body)

Create email delivery receipt automations

Create email delivery receipt automations

Example

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

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

            var apiInstance = new EmailDeliveryReceiptRulesApi();
            var body = new DeliveryReceiptRule(); // DeliveryReceiptRule | Email delivery receipt rule model

            try
            {
                // Create email delivery receipt automations
                string result = apiInstance.EmailDeliveryReceiptAutomationPost(body);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling EmailDeliveryReceiptRulesApi.EmailDeliveryReceiptAutomationPost: " + e.Message );
            }
        }
    }
}

Parameters

Name Type Description Notes
body DeliveryReceiptRule Email delivery receipt rule 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]

EmailDeliveryReceiptAutomationPut

string EmailDeliveryReceiptAutomationPut (DeliveryReceiptRule body, int? receiptRuleId)

Update email delivery receipt automation

Update email delivery receipt automation

Example

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

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

            var apiInstance = new EmailDeliveryReceiptRulesApi();
            var body = new DeliveryReceiptRule(); // DeliveryReceiptRule | Delivery receipt rule model
            var receiptRuleId = 56;  // int? | Receipt rule id

            try
            {
                // Update email delivery receipt automation
                string result = apiInstance.EmailDeliveryReceiptAutomationPut(body, receiptRuleId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling EmailDeliveryReceiptRulesApi.EmailDeliveryReceiptAutomationPut: " + e.Message );
            }
        }
    }
}

Parameters

Name Type Description Notes
body DeliveryReceiptRule Delivery receipt rule model
receiptRuleId int? Receipt rule 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]

EmailDeliveryReceiptAutomationsGet

string EmailDeliveryReceiptAutomationsGet (string q = null, int? page = null, int? limit = null)

Get all email delivery receipt automations

Get all email delivery receipt automations

Example

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

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

            var apiInstance = new EmailDeliveryReceiptRulesApi();
            var q = q_example;  // string | Your keyword or query. (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 email delivery receipt automations
                string result = apiInstance.EmailDeliveryReceiptAutomationsGet(q, page, limit);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling EmailDeliveryReceiptRulesApi.EmailDeliveryReceiptAutomationsGet: " + e.Message );
            }
        }
    }
}

Parameters

Name Type Description Notes
q string Your keyword or query. [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]