org.egoi.client.api.Api.EmailApi

All URIs are relative to https://api.egoiapp.com

Method	HTTP request	Description
ActionEnableEmailRss	POST /campaigns/email/rss/{campaign_hash}/actions/enable	Enables a rss email campaign
ActionSendEmail	POST /campaigns/email/{campaign_hash}/actions/send	Send email message
CreateEmailCampaign	POST /campaigns/email	Create new email campaign
CreateEmailRssCampaign	POST /campaigns/email/rss	Create new email rss campaign
PatchEmailCampaign	PATCH /campaigns/email/{campaign_hash}	Update a specific email campaign

ActionEnableEmailRss

AcceptedResponse ActionEnableEmailRss (string campaignHash)

Enables a rss email campaign

Enables a rss email message

Example

using System.Collections.Generic;
using System.Diagnostics;
using org.egoi.client.api.Api;
using org.egoi.client.api.Client;
using org.egoi.client.api.Model;

namespace Example
{
    public class ActionEnableEmailRssExample
    {
        public static void Main()
        {
            Configuration.Default.BasePath = "https://api.egoiapp.com";
            // Configure API key authorization: Apikey
            Configuration.Default.AddApiKey("Apikey", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.AddApiKeyPrefix("Apikey", "Bearer");

            var apiInstance = new EmailApi(Configuration.Default);
            var campaignHash = campaignHash_example;  // string | ID of the Campaign

            try
            {
                // Enables a rss email campaign
                AcceptedResponse result = apiInstance.ActionEnableEmailRss(campaignHash);
                Debug.WriteLine(result);
            }
            catch (ApiException e)
            {
                Debug.Print("Exception when calling EmailApi.ActionEnableEmailRss: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name	Type	Description	Notes
campaignHash	string	ID of the Campaign

Return type

AcceptedResponse

Authorization

Apikey

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	OK	-
400	Bad Request	-
401	Unauthorized	-
403	Forbidden	-
408	Request Timeout	-
422	Unprocessable Entity	-
429	Too Many Requests	-
500	Internal Server Error	-
503	Service Unavailable	-

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

ActionSendEmail

AcceptedResponse ActionSendEmail (string campaignHash, CampaignEmailSendRequest campaignEmailSendRequest)

Send email message

Deploys and sends an email message

Example

using System.Collections.Generic;
using System.Diagnostics;
using org.egoi.client.api.Api;
using org.egoi.client.api.Client;
using org.egoi.client.api.Model;

namespace Example
{
    public class ActionSendEmailExample
    {
        public static void Main()
        {
            Configuration.Default.BasePath = "https://api.egoiapp.com";
            // Configure API key authorization: Apikey
            Configuration.Default.AddApiKey("Apikey", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.AddApiKeyPrefix("Apikey", "Bearer");

            var apiInstance = new EmailApi(Configuration.Default);
            var campaignHash = campaignHash_example;  // string | ID of the Campaign
            var campaignEmailSendRequest = new CampaignEmailSendRequest(); // CampaignEmailSendRequest | Parameters for the 'send email' action

            try
            {
                // Send email message
                AcceptedResponse result = apiInstance.ActionSendEmail(campaignHash, campaignEmailSendRequest);
                Debug.WriteLine(result);
            }
            catch (ApiException e)
            {
                Debug.Print("Exception when calling EmailApi.ActionSendEmail: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name	Type	Description	Notes
campaignHash	string	ID of the Campaign
campaignEmailSendRequest	CampaignEmailSendRequest	Parameters for the 'send email' action

Return type

AcceptedResponse

Authorization

Apikey

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
200	OK	-
400	Bad Request	-
401	Unauthorized	-
403	Forbidden	-
408	Request Timeout	-
409	Conflict	-
422	Unprocessable Entity	-
429	Too Many Requests	-
500	Internal Server Error	-
503	Service Unavailable	-

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

CreateEmailCampaign

HashcodeCampaign CreateEmailCampaign (EmailCampaignCreate emailCampaignCreate)

Create new email campaign

Create a new email campaign

Example

using System.Collections.Generic;
using System.Diagnostics;
using org.egoi.client.api.Api;
using org.egoi.client.api.Client;
using org.egoi.client.api.Model;

namespace Example
{
    public class CreateEmailCampaignExample
    {
        public static void Main()
        {
            Configuration.Default.BasePath = "https://api.egoiapp.com";
            // Configure API key authorization: Apikey
            Configuration.Default.AddApiKey("Apikey", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.AddApiKeyPrefix("Apikey", "Bearer");

            var apiInstance = new EmailApi(Configuration.Default);
            var emailCampaignCreate = new EmailCampaignCreate(); // EmailCampaignCreate | Parameters for the Email Campaign

            try
            {
                // Create new email campaign
                HashcodeCampaign result = apiInstance.CreateEmailCampaign(emailCampaignCreate);
                Debug.WriteLine(result);
            }
            catch (ApiException e)
            {
                Debug.Print("Exception when calling EmailApi.CreateEmailCampaign: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name	Type	Description	Notes
emailCampaignCreate	EmailCampaignCreate	Parameters for the Email Campaign

Return type

HashcodeCampaign

Authorization

Apikey

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
201	Created	-
400	Bad Request	-
401	Unauthorized	-
403	Forbidden	-
404	Not Found	-
408	Request Timeout	-
409	Conflict	-
422	Unprocessable Entity	-
429	Too Many Requests	-
500	Internal Server Error	-
503	Service Unavailable	-

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

CreateEmailRssCampaign

HashcodeCampaign CreateEmailRssCampaign (EmailRssCampaignCreate emailRssCampaignCreate)

Create new email rss campaign

Create a new email rss campaign

Example

using System.Collections.Generic;
using System.Diagnostics;
using org.egoi.client.api.Api;
using org.egoi.client.api.Client;
using org.egoi.client.api.Model;

namespace Example
{
    public class CreateEmailRssCampaignExample
    {
        public static void Main()
        {
            Configuration.Default.BasePath = "https://api.egoiapp.com";
            // Configure API key authorization: Apikey
            Configuration.Default.AddApiKey("Apikey", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.AddApiKeyPrefix("Apikey", "Bearer");

            var apiInstance = new EmailApi(Configuration.Default);
            var emailRssCampaignCreate = new EmailRssCampaignCreate(); // EmailRssCampaignCreate | Parameters for the Email Campaign

            try
            {
                // Create new email rss campaign
                HashcodeCampaign result = apiInstance.CreateEmailRssCampaign(emailRssCampaignCreate);
                Debug.WriteLine(result);
            }
            catch (ApiException e)
            {
                Debug.Print("Exception when calling EmailApi.CreateEmailRssCampaign: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name	Type	Description	Notes
emailRssCampaignCreate	EmailRssCampaignCreate	Parameters for the Email Campaign

Return type

HashcodeCampaign

Authorization

Apikey

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
201	Created	-
400	Bad Request	-
401	Unauthorized	-
403	Forbidden	-
404	Not Found	-
408	Request Timeout	-
409	Conflict	-
422	Unprocessable Entity	-
429	Too Many Requests	-
500	Internal Server Error	-
503	Service Unavailable	-

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

PatchEmailCampaign

HashcodeCampaign PatchEmailCampaign (string campaignHash, EmailCampaignPatch emailCampaignPatch)

Update a specific email campaign

Update email campaign

Example

using System.Collections.Generic;
using System.Diagnostics;
using org.egoi.client.api.Api;
using org.egoi.client.api.Client;
using org.egoi.client.api.Model;

namespace Example
{
    public class PatchEmailCampaignExample
    {
        public static void Main()
        {
            Configuration.Default.BasePath = "https://api.egoiapp.com";
            // Configure API key authorization: Apikey
            Configuration.Default.AddApiKey("Apikey", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.AddApiKeyPrefix("Apikey", "Bearer");

            var apiInstance = new EmailApi(Configuration.Default);
            var campaignHash = campaignHash_example;  // string | ID of the Campaign
            var emailCampaignPatch = new EmailCampaignPatch(); // EmailCampaignPatch | Parameters for the Email Campaign

            try
            {
                // Update a specific email campaign
                HashcodeCampaign result = apiInstance.PatchEmailCampaign(campaignHash, emailCampaignPatch);
                Debug.WriteLine(result);
            }
            catch (ApiException e)
            {
                Debug.Print("Exception when calling EmailApi.PatchEmailCampaign: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name	Type	Description	Notes
campaignHash	string	ID of the Campaign
emailCampaignPatch	EmailCampaignPatch	Parameters for the Email Campaign

Return type

HashcodeCampaign

Authorization

Apikey

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
200	OK	-
400	Bad Request	-
401	Unauthorized	-
403	Forbidden	-
404	Not Found	-
408	Request Timeout	-
422	Unprocessable Entity	-
429	Too Many Requests	-
500	Internal Server Error	-
503	Service Unavailable	-

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

Files

EmailApi.md

Latest commit

History

EmailApi.md

File metadata and controls

org.egoi.client.api.Api.EmailApi

ActionEnableEmailRss

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

ActionSendEmail

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

CreateEmailCampaign

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

CreateEmailRssCampaign

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

PatchEmailCampaign

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details