clicksend_client.EmailMarketingApi

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

Method	HTTP request	Description
allowed_email_address_get	GET /email/addresses	Get all email addresses
allowed_email_address_post	POST /email/addresses	Create allowed Email Address
cancel_email_campaign_put	PUT /email-campaigns/{email_campaign_id}/cancel	Cancel email campaign
email_campaign_get	GET /email-campaigns/{email_campaign_id}	Get specific email campaign
email_campaign_history_export_get	GET /email-campaigns/{email_campaign_id}/history/export	Export specific email campaign history
email_campaign_history_get	GET /email-campaigns/{email_campaign_id}/history	Get specific email campaign history
email_campaign_post	POST /email-campaigns/send	Send email campaign
email_campaign_price_post	POST /email-campaigns/price	Calculate email campaign price
email_campaign_put	PUT /email-campaigns/{email_campaign_id}	Edit email campaign
email_campaigns_get	GET /email-campaigns	Get all email campaigns
send_verification_token_get	PUT /email/address-verify/{email_address_id}/send	Send verification token
specific_allowed_email_address_delete	DELETE /email/addresses/{email_address_id}	Delete specific email address
specific_allowed_email_address_get	GET /email/addresses/{email_address_id}	Get specific email address
verify_allowed_email_address_get	PUT /email/address-verify/{email_address_id}/verify/{activation_token}	Verify email address using verification token

allowed_email_address_get

str allowed_email_address_get(page=page, limit=limit)

Get all email addresses

Example

from __future__ import print_function
import time
import clicksend_client
from clicksend_client.rest import ApiException
from pprint import pprint

# Configure HTTP basic authorization: BasicAuth
configuration = clicksend_client.Configuration()
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = clicksend_client.EmailMarketingApi(clicksend_client.ApiClient(configuration))
page = 1 # int | Page number (optional) (default to 1)
limit = 10 # int | Number of records per page (optional) (default to 10)

try:
    # Get all email addresses
    api_response = api_instance.allowed_email_address_get(page=page, limit=limit)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling EmailMarketingApi->allowed_email_address_get: %s\n" % e)

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

str

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]

allowed_email_address_post

str allowed_email_address_post(email_address=email_address)

Create allowed Email Address

Example

from __future__ import print_function
import time
import clicksend_client
from clicksend_client.rest import ApiException
from pprint import pprint

# Configure HTTP basic authorization: BasicAuth
configuration = clicksend_client.Configuration()
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = clicksend_client.EmailMarketingApi(clicksend_client.ApiClient(configuration))
email_address = clicksend_client.EmailAddress() # EmailAddress |  (optional)

try:
    # Create allowed Email Address
    api_response = api_instance.allowed_email_address_post(email_address=email_address)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling EmailMarketingApi->allowed_email_address_post: %s\n" % e)

Parameters

Name	Type	Description	Notes
email_address	EmailAddress		[optional]

Return type

str

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]

cancel_email_campaign_put

str cancel_email_campaign_put(email_campaign_id)

Cancel email campaign

Example

from __future__ import print_function
import time
import clicksend_client
from clicksend_client.rest import ApiException
from pprint import pprint

# Configure HTTP basic authorization: BasicAuth
configuration = clicksend_client.Configuration()
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = clicksend_client.EmailMarketingApi(clicksend_client.ApiClient(configuration))
email_campaign_id = 56 # int | Allowed email campaign id

try:
    # Cancel email campaign
    api_response = api_instance.cancel_email_campaign_put(email_campaign_id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling EmailMarketingApi->cancel_email_campaign_put: %s\n" % e)

Parameters

Name	Type	Description	Notes
email_campaign_id	int	Allowed email campaign id

Return type

str

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]

email_campaign_get

str email_campaign_get(email_campaign_id)

Get specific email campaign

Example

from __future__ import print_function
import time
import clicksend_client
from clicksend_client.rest import ApiException
from pprint import pprint

# Configure HTTP basic authorization: BasicAuth
configuration = clicksend_client.Configuration()
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = clicksend_client.EmailMarketingApi(clicksend_client.ApiClient(configuration))
email_campaign_id = 56 # int | Allowed email campaign id

try:
    # Get specific email campaign
    api_response = api_instance.email_campaign_get(email_campaign_id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling EmailMarketingApi->email_campaign_get: %s\n" % e)

Parameters

Name	Type	Description	Notes
email_campaign_id	int	Allowed email campaign id

Return type

str

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]

email_campaign_history_export_get

str email_campaign_history_export_get(email_campaign_id, date_from=date_from, date_to=date_to)

Export specific email campaign history

Example

from __future__ import print_function
import time
import clicksend_client
from clicksend_client.rest import ApiException
from pprint import pprint

# Configure HTTP basic authorization: BasicAuth
configuration = clicksend_client.Configuration()
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = clicksend_client.EmailMarketingApi(clicksend_client.ApiClient(configuration))
email_campaign_id = 56 # int | Allowed email campaign id
date_from = 56 # int | Start date (optional)
date_to = 56 # int | End date (optional)

try:
    # Export specific email campaign history
    api_response = api_instance.email_campaign_history_export_get(email_campaign_id, date_from=date_from, date_to=date_to)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling EmailMarketingApi->email_campaign_history_export_get: %s\n" % e)

Parameters

Name	Type	Description	Notes
email_campaign_id	int	Allowed email campaign id
date_from	int	Start date	[optional]
date_to	int	End date	[optional]

Return type

str

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]

email_campaign_history_get

str email_campaign_history_get(email_campaign_id, date_from=date_from, date_to=date_to, page=page, limit=limit)

Get specific email campaign history

Example

from __future__ import print_function
import time
import clicksend_client
from clicksend_client.rest import ApiException
from pprint import pprint

# Configure HTTP basic authorization: BasicAuth
configuration = clicksend_client.Configuration()
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = clicksend_client.EmailMarketingApi(clicksend_client.ApiClient(configuration))
email_campaign_id = 56 # int | Allowed email campaign id
date_from = 56 # int | Start date (optional)
date_to = 56 # int | End date (optional)
page = 1 # int | Page number (optional) (default to 1)
limit = 10 # int | Number of records per page (optional) (default to 10)

try:
    # Get specific email campaign history
    api_response = api_instance.email_campaign_history_get(email_campaign_id, date_from=date_from, date_to=date_to, page=page, limit=limit)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling EmailMarketingApi->email_campaign_history_get: %s\n" % e)

Parameters

Name	Type	Description	Notes
email_campaign_id	int	Allowed email campaign id
date_from	int	Start date	[optional]
date_to	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

str

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]

email_campaign_post

str email_campaign_post(email_campaign)

Send email campaign

Example

from __future__ import print_function
import time
import clicksend_client
from clicksend_client.rest import ApiException
from pprint import pprint

# Configure HTTP basic authorization: BasicAuth
configuration = clicksend_client.Configuration()
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = clicksend_client.EmailMarketingApi(clicksend_client.ApiClient(configuration))
email_campaign = clicksend_client.EmailCampaign() # EmailCampaign | Email model

try:
    # Send email campaign
    api_response = api_instance.email_campaign_post(email_campaign)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling EmailMarketingApi->email_campaign_post: %s\n" % e)

Parameters

Name	Type	Description	Notes
email_campaign	EmailCampaign	Email model

Return type

str

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]

email_campaign_price_post

str email_campaign_price_post(email_campaign)

Calculate email campaign price

Example

from __future__ import print_function
import time
import clicksend_client
from clicksend_client.rest import ApiException
from pprint import pprint

# Configure HTTP basic authorization: BasicAuth
configuration = clicksend_client.Configuration()
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = clicksend_client.EmailMarketingApi(clicksend_client.ApiClient(configuration))
email_campaign = clicksend_client.EmailCampaign() # EmailCampaign | Email model

try:
    # Calculate email campaign price
    api_response = api_instance.email_campaign_price_post(email_campaign)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling EmailMarketingApi->email_campaign_price_post: %s\n" % e)

Parameters

Name	Type	Description	Notes
email_campaign	EmailCampaign	Email model

Return type

str

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]

email_campaign_put

str email_campaign_put(email_campaign_id, email_campaign)

Edit email campaign

Example

from __future__ import print_function
import time
import clicksend_client
from clicksend_client.rest import ApiException
from pprint import pprint

# Configure HTTP basic authorization: BasicAuth
configuration = clicksend_client.Configuration()
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = clicksend_client.EmailMarketingApi(clicksend_client.ApiClient(configuration))
email_campaign_id = 56 # int | Allowed email campaign id
email_campaign = clicksend_client.EmailCampaign() # EmailCampaign | Email model

try:
    # Edit email campaign
    api_response = api_instance.email_campaign_put(email_campaign_id, email_campaign)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling EmailMarketingApi->email_campaign_put: %s\n" % e)

Parameters

Name	Type	Description	Notes
email_campaign_id	int	Allowed email campaign id
email_campaign	EmailCampaign	Email model

Return type

str

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]

email_campaigns_get

str email_campaigns_get(page=page, limit=limit)

Get all email campaigns

Example

from __future__ import print_function
import time
import clicksend_client
from clicksend_client.rest import ApiException
from pprint import pprint

# Configure HTTP basic authorization: BasicAuth
configuration = clicksend_client.Configuration()
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = clicksend_client.EmailMarketingApi(clicksend_client.ApiClient(configuration))
page = 1 # int | Page number (optional) (default to 1)
limit = 10 # int | Number of records per page (optional) (default to 10)

try:
    # Get all email campaigns
    api_response = api_instance.email_campaigns_get(page=page, limit=limit)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling EmailMarketingApi->email_campaigns_get: %s\n" % e)

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

str

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]

send_verification_token_get

str send_verification_token_get(email_address_id)

Send verification token

Example

from __future__ import print_function
import time
import clicksend_client
from clicksend_client.rest import ApiException
from pprint import pprint

# Configure HTTP basic authorization: BasicAuth
configuration = clicksend_client.Configuration()
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = clicksend_client.EmailMarketingApi(clicksend_client.ApiClient(configuration))
email_address_id = 56 # int | Allowed email address id

try:
    # Send verification token
    api_response = api_instance.send_verification_token_get(email_address_id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling EmailMarketingApi->send_verification_token_get: %s\n" % e)

Parameters

Name	Type	Description	Notes
email_address_id	int	Allowed email address id

Return type

str

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]

specific_allowed_email_address_delete

str specific_allowed_email_address_delete(email_address_id)

Delete specific email address

Example

from __future__ import print_function
import time
import clicksend_client
from clicksend_client.rest import ApiException
from pprint import pprint

# Configure HTTP basic authorization: BasicAuth
configuration = clicksend_client.Configuration()
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = clicksend_client.EmailMarketingApi(clicksend_client.ApiClient(configuration))
email_address_id = 56 # int | Allowed email address id

try:
    # Delete specific email address
    api_response = api_instance.specific_allowed_email_address_delete(email_address_id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling EmailMarketingApi->specific_allowed_email_address_delete: %s\n" % e)

Parameters

Name	Type	Description	Notes
email_address_id	int	Allowed email address id

Return type

str

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]

specific_allowed_email_address_get

str specific_allowed_email_address_get(email_address_id)

Get specific email address

Example

from __future__ import print_function
import time
import clicksend_client
from clicksend_client.rest import ApiException
from pprint import pprint

# Configure HTTP basic authorization: BasicAuth
configuration = clicksend_client.Configuration()
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = clicksend_client.EmailMarketingApi(clicksend_client.ApiClient(configuration))
email_address_id = 56 # int | Allowed email address id

try:
    # Get specific email address
    api_response = api_instance.specific_allowed_email_address_get(email_address_id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling EmailMarketingApi->specific_allowed_email_address_get: %s\n" % e)

Parameters

Name	Type	Description	Notes
email_address_id	int	Allowed email address id

Return type

str

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]

verify_allowed_email_address_get

str verify_allowed_email_address_get(email_address_id, activation_token)

Verify email address using verification token

Example

from __future__ import print_function
import time
import clicksend_client
from clicksend_client.rest import ApiException
from pprint import pprint

# Configure HTTP basic authorization: BasicAuth
configuration = clicksend_client.Configuration()
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = clicksend_client.EmailMarketingApi(clicksend_client.ApiClient(configuration))
email_address_id = 56 # int | Allowed email address id
activation_token = 'activation_token_example' # str | Your activation token.

try:
    # Verify email address using verification token
    api_response = api_instance.verify_allowed_email_address_get(email_address_id, activation_token)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling EmailMarketingApi->verify_allowed_email_address_get: %s\n" % e)

Parameters

Name	Type	Description	Notes
email_address_id	int	Allowed email address id
activation_token	str	Your activation token.

Return type

str

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]

FilesExpand file tree

EmailMarketingApi.md

Latest commit

History

EmailMarketingApi.md

File metadata and controls

clicksend_client.EmailMarketingApi

allowed_email_address_get

Example

Parameters

Return type

Authorization

HTTP request headers

allowed_email_address_post

Example

Parameters

Return type

Authorization

HTTP request headers

cancel_email_campaign_put

Example

Parameters

Return type

Authorization

HTTP request headers

email_campaign_get

Example

Parameters

Return type

Authorization

HTTP request headers

email_campaign_history_export_get

Example

Parameters

Return type

Authorization

HTTP request headers

email_campaign_history_get

Example

Parameters

Return type

Authorization

HTTP request headers

email_campaign_post

Example

Parameters

Return type

Authorization

HTTP request headers

email_campaign_price_post

Example

Parameters

Return type

Authorization

HTTP request headers

email_campaign_put

Example

Parameters

Return type

Authorization

HTTP request headers

email_campaigns_get

Example

Parameters

Return type

Authorization

HTTP request headers

send_verification_token_get

Example

Parameters

Return type

Authorization

HTTP request headers

specific_allowed_email_address_delete

Example

Parameters

Return type

Authorization

HTTP request headers

specific_allowed_email_address_get