Skip to content

EmailDeliveryReceiptRulesApi.md

Latest commit

 

History

History
284 lines (200 loc) · 9.61 KB

EmailDeliveryReceiptRulesApi.md

File metadata and controls

284 lines (200 loc) · 9.61 KB

clicksend_client.EmailDeliveryReceiptRulesApi

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

Method HTTP request Description
email_delivery_receipt_automation_delete DELETE /automations/email/receipts/{receipt_rule_id} Delete email delivery receipt automation
email_delivery_receipt_automation_get GET /automations/email/receipts/{receipt_rule_id} Get specific email delivery receipt automation
email_delivery_receipt_automation_post POST /automations/email/receipts Create email delivery receipt automations
email_delivery_receipt_automation_put PUT /automations/email/receipts/{receipt_rule_id} Update email delivery receipt automation
email_delivery_receipt_automations_get GET /automations/email/receipts Get all email delivery receipt automations

email_delivery_receipt_automation_delete

str email_delivery_receipt_automation_delete(receipt_rule_id)

Delete email delivery receipt automation

Delete email delivery receipt automation

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.EmailDeliveryReceiptRulesApi(clicksend_client.ApiClient(configuration))
receipt_rule_id = 56 # int | Receipt rule id

try:
    # Delete email delivery receipt automation
    api_response = api_instance.email_delivery_receipt_automation_delete(receipt_rule_id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling EmailDeliveryReceiptRulesApi->email_delivery_receipt_automation_delete: %s\n" % e)

Parameters

Name Type Description Notes
receipt_rule_id int Receipt rule 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_delivery_receipt_automation_get

str email_delivery_receipt_automation_get(receipt_rule_id)

Get specific email delivery receipt automation

Get specific email delivery receipt automation

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.EmailDeliveryReceiptRulesApi(clicksend_client.ApiClient(configuration))
receipt_rule_id = 56 # int | Receipt rule id

try:
    # Get specific email delivery receipt automation
    api_response = api_instance.email_delivery_receipt_automation_get(receipt_rule_id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling EmailDeliveryReceiptRulesApi->email_delivery_receipt_automation_get: %s\n" % e)

Parameters

Name Type Description Notes
receipt_rule_id int Receipt rule 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_delivery_receipt_automation_post

str email_delivery_receipt_automation_post(delivery_receipt_rule)

Create email delivery receipt automations

Create email delivery receipt automations

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.EmailDeliveryReceiptRulesApi(clicksend_client.ApiClient(configuration))
delivery_receipt_rule = clicksend_client.DeliveryReceiptRule() # DeliveryReceiptRule | Email delivery receipt rule model

try:
    # Create email delivery receipt automations
    api_response = api_instance.email_delivery_receipt_automation_post(delivery_receipt_rule)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling EmailDeliveryReceiptRulesApi->email_delivery_receipt_automation_post: %s\n" % e)

Parameters

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

str email_delivery_receipt_automation_put(receipt_rule_id, delivery_receipt_rule)

Update email delivery receipt automation

Update email delivery receipt automation

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.EmailDeliveryReceiptRulesApi(clicksend_client.ApiClient(configuration))
receipt_rule_id = 56 # int | Receipt rule id
delivery_receipt_rule = clicksend_client.DeliveryReceiptRule() # DeliveryReceiptRule | Delivery receipt rule model

try:
    # Update email delivery receipt automation
    api_response = api_instance.email_delivery_receipt_automation_put(receipt_rule_id, delivery_receipt_rule)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling EmailDeliveryReceiptRulesApi->email_delivery_receipt_automation_put: %s\n" % e)

Parameters

Name Type Description Notes
receipt_rule_id int Receipt rule id
delivery_receipt_rule DeliveryReceiptRule Delivery receipt rule 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_delivery_receipt_automations_get

str email_delivery_receipt_automations_get(q=q, page=page, limit=limit)

Get all email delivery receipt automations

Get all email delivery receipt automations

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.EmailDeliveryReceiptRulesApi(clicksend_client.ApiClient(configuration))
q = 'q_example' # str | Your keyword or query. (optional)
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 delivery receipt automations
    api_response = api_instance.email_delivery_receipt_automations_get(q=q, page=page, limit=limit)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling EmailDeliveryReceiptRulesApi->email_delivery_receipt_automations_get: %s\n" % e)

Parameters

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

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]