IO.ClickSend.ClickSend.Api.ContactApi

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

Method	HTTP request	Description
ListsContactsByListIdAndContactIdDelete	DELETE /lists/{list_id}/contacts/{contact_id}	Delete a contact
ListsContactsByListIdAndContactIdGet	GET /lists/{list_id}/contacts/{contact_id}	Get a specific contact
ListsContactsByListIdAndContactIdPut	PUT /lists/{list_id}/contacts/{contact_id}	Update specific contact
ListsContactsByListIdGet	GET /lists/{list_id}/contacts	Get all contacts in a list
ListsContactsByListIdPost	POST /lists/{list_id}/contacts	Create new contact
ListsCopyContactPut	PUT /lists/{from_list_id}/contacts/{contact_id}/copy/{to_list_id}	Copy contact to another list
ListsRemoveOptedOutContactsByListIdAndOptOutListIdPut	PUT /lists/{list_id}/remove-opted-out-contacts/{opt_out_list_id}	Remove all opted out contacts
ListsTransferContactPut	PUT /lists/{from_list_id}/contacts/{contact_id}/transfer/{to_list_id}	Transfer contact to another list

ListsContactsByListIdAndContactIdDelete

string ListsContactsByListIdAndContactIdDelete (int? listId, int? contactId)

Delete a contact

Example

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

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

            var apiInstance = new ContactApi();
            var listId = 56;  // int? | List ID
            var contactId = 56;  // int? | Contact ID

            try
            {
                // Delete a contact
                string result = apiInstance.ListsContactsByListIdAndContactIdDelete(listId, contactId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ContactApi.ListsContactsByListIdAndContactIdDelete: " + e.Message );
            }
        }
    }
}

Parameters

Name	Type	Description	Notes
listId	int?	List ID
contactId	int?	Contact 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]

ListsContactsByListIdAndContactIdGet

string ListsContactsByListIdAndContactIdGet (int? listId, int? contactId)

Get a specific contact

Example

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

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

            var apiInstance = new ContactApi();
            var listId = 56;  // int? | Your contact list id you want to access.
            var contactId = 56;  // int? | Your contact id you want to access.

            try
            {
                // Get a specific contact
                string result = apiInstance.ListsContactsByListIdAndContactIdGet(listId, contactId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ContactApi.ListsContactsByListIdAndContactIdGet: " + e.Message );
            }
        }
    }
}

Parameters

Name	Type	Description	Notes
listId	int?	Your contact list id you want to access.
contactId	int?	Your contact id you want to access.

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]

ListsContactsByListIdAndContactIdPut

string ListsContactsByListIdAndContactIdPut (Contact body, int? listId, int? contactId)

Update specific contact

Example

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

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

            var apiInstance = new ContactApi();
            var body = new Contact(); // Contact | Contact model
            var listId = 56;  // int? | Contact list id
            var contactId = 56;  // int? | Contact ID

            try
            {
                // Update specific contact
                string result = apiInstance.ListsContactsByListIdAndContactIdPut(body, listId, contactId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ContactApi.ListsContactsByListIdAndContactIdPut: " + e.Message );
            }
        }
    }
}

Parameters

Name	Type	Description
body	Contact	Contact model
listId	int?	Contact list id
contactId	int?	Contact 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]

ListsContactsByListIdGet

string ListsContactsByListIdGet (int? listId, int? page = null, int? limit = null, int? updatedAfter = null)

Get all contacts in a list

Example

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

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

            var apiInstance = new ContactApi();
            var listId = 56;  // int? | Contact list ID
            var page = 56;  // int? | Page number (optional)  (default to 1)
            var limit = 56;  // int? | Number of records per page (optional)  (default to 10)
            var updatedAfter = 56;  // int? | Get all contacts updated after a given timestamp. (optional)  (default to 10)

            try
            {
                // Get all contacts in a list
                string result = apiInstance.ListsContactsByListIdGet(listId, page, limit, updatedAfter);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ContactApi.ListsContactsByListIdGet: " + e.Message );
            }
        }
    }
}

Parameters

Name	Type	Description	Notes
listId	int?	Contact list ID
page	int?	Page number	[optional] [default to 1]
limit	int?	Number of records per page	[optional] [default to 10]
updatedAfter	int?	Get all contacts updated after a given timestamp.	[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]

ListsContactsByListIdPost

string ListsContactsByListIdPost (Contact body, int? listId)

Create new contact

Example

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

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

            var apiInstance = new ContactApi();
            var body = new Contact(); // Contact | Contact model
            var listId = 56;  // int? | List id

            try
            {
                // Create new contact
                string result = apiInstance.ListsContactsByListIdPost(body, listId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ContactApi.ListsContactsByListIdPost: " + e.Message );
            }
        }
    }
}

Parameters

Name	Type	Description	Notes
body	Contact	Contact model
listId	int?	List 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]

ListsCopyContactPut

string ListsCopyContactPut (int? fromListId, int? contactId, int? toListId)

Copy contact to another list

Example

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

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

            var apiInstance = new ContactApi();
            var fromListId = 56;  // int? | List ID for list that contains contact.
            var contactId = 56;  // int? | Contact ID
            var toListId = 56;  // int? | List ID for list you want to copy the contact to.

            try
            {
                // Copy contact to another list
                string result = apiInstance.ListsCopyContactPut(fromListId, contactId, toListId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ContactApi.ListsCopyContactPut: " + e.Message );
            }
        }
    }
}

Parameters

Name	Type	Description
fromListId	int?	List ID for list that contains contact.
contactId	int?	Contact ID
toListId	int?	List ID for list you want to copy the contact to.

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]

ListsRemoveOptedOutContactsByListIdAndOptOutListIdPut

string ListsRemoveOptedOutContactsByListIdAndOptOutListIdPut (int? listId, int? optOutListId)

Remove all opted out contacts

Example

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

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

            var apiInstance = new ContactApi();
            var listId = 56;  // int? | Your list id
            var optOutListId = 56;  // int? | Your opt out list id

            try
            {
                // Remove all opted out contacts
                string result = apiInstance.ListsRemoveOptedOutContactsByListIdAndOptOutListIdPut(listId, optOutListId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ContactApi.ListsRemoveOptedOutContactsByListIdAndOptOutListIdPut: " + e.Message );
            }
        }
    }
}

Parameters

Name	Type	Description	Notes
listId	int?	Your list id
optOutListId	int?	Your opt out list 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]

ListsTransferContactPut

string ListsTransferContactPut (int? fromListId, int? contactId, int? toListId)

Transfer contact to another list

Example

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

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

            var apiInstance = new ContactApi();
            var fromListId = 56;  // int? | List ID for list that contains contact.
            var contactId = 56;  // int? | Contact ID
            var toListId = 56;  // int? | List ID for list you want to transfer contact to.

            try
            {
                // Transfer contact to another list
                string result = apiInstance.ListsTransferContactPut(fromListId, contactId, toListId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ContactApi.ListsTransferContactPut: " + e.Message );
            }
        }
    }
}

Parameters

Name	Type	Description
fromListId	int?	List ID for list that contains contact.
contactId	int?	Contact ID
toListId	int?	List ID for list you want to transfer contact to.

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

ContactApi.md

Latest commit

History

ContactApi.md

File metadata and controls

IO.ClickSend.ClickSend.Api.ContactApi

ListsContactsByListIdAndContactIdDelete

Example

Parameters

Return type

Authorization

HTTP request headers

ListsContactsByListIdAndContactIdGet

Example

Parameters

Return type

Authorization

HTTP request headers

ListsContactsByListIdAndContactIdPut

Example

Parameters

Return type

Authorization

HTTP request headers

ListsContactsByListIdGet

Example

Parameters

Return type

Authorization

HTTP request headers

ListsContactsByListIdPost

Example

Parameters

Return type

Authorization

HTTP request headers

ListsCopyContactPut

Example

Parameters

Return type

Authorization

HTTP request headers

ListsRemoveOptedOutContactsByListIdAndOptOutListIdPut

Example

Parameters

Return type

Authorization

HTTP request headers

ListsTransferContactPut

Example

Parameters

Return type

Authorization

HTTP request headers