SendX 1.0.3

SendX REST API

SendX Python SDK

Introduction

SendX is an email marketing product. It helps you convert website visitors to customers, send them promotional emails, engage with them using drip sequences and craft custom journeys using powerful but simple automations.

The SendX API is organized around REST. Our API has predictable resource-oriented URLs, accepts form-encoded request bodies, returns JSON-encoded responses, and uses standard HTTP response codes, authentication, and verbs. The SendX Rest API doesn’t support bulk updates. You can work on only one object per request.

Requirements.

Python 3.7+

Installation & Usage

pip install

If the python package is hosted on a repository, you can install directly using:

pip install sendx

(you may need to run pip with root permission: sudo pip install git+https://github.com/sendx/sendx-python-sdk.git)

Then import the package:

import sendx_python_sdk

Setuptools

Install via Setuptools.

python setup.py install --user

(or sudo python setup.py install to install the package for all users)

Then import the package:

import sendx_python_sdk

Getting Started

Please follow the installation procedure and then run the following:

import sendx_python_sdk
from sendx_python_sdk.models.contact_request import ContactRequest
from sendx_python_sdk.models.response import Response
from sendx_python_sdk.rest import ApiException
from pprint import pprint


configuration = sendx_python_sdk.Configuration()

# Configure API key authorization: apiKeyAuth
configuration.api_key['apiKeyAuth'] = os.environ["API_KEY"]

# Enter a context with an instance of the API client
with sendx_python_sdk.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = sendx_python_sdk.ContactApi(api_client)
    contact_request = sendx_python_sdk.ContactRequest() # ContactRequest | 
    contact_request.email = "[e-mail]"
    contact_request.first_name = "John"
    contact_request.last_name = "Doe"
    contact_request.company = "SendX"
    contact_request.tags = ["12nb32nk43k2", "34njnk42bkj3"]
    contact_request.custom_fields = {"1434nfk324kn4d": "VIP", "34njnk42bkj3": "Gold"}
    contact_request.last_tracked_ip = "34.212.42.122"

    try:
        # Create a contact
        api_response = api_instance.create_contact(contact_request)
        print("The response of ContactApi->create_contact:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ContactApi->create_contact: %s\n" % e)

Documentation for API Endpoints

All URIs are relative to https://api.sendx.io/api/v1/rest

Class	Method	HTTP request	Description
CampaignApi	create_campaign	POST /campaign	Create Campaign
CampaignApi	delete_campaign	DELETE /campaign/{campaignId}	Delete Campaign
CampaignApi	edit_campaign	PUT /campaign/{campaignId}	Edit Campaign
CampaignApi	get_all_campaigns	GET /campaign	Get All Campaigns
CampaignApi	get_campaign_by_id	GET /campaign/{campaignId}	Get Campaign By Id
ContactApi	create_contact	POST /contact	Create a contact
ContactApi	delete_contact	DELETE /contact/{contactId}	Delete Contact
ContactApi	get_all_contacts	GET /contact	Get All Contacts
ContactApi	get_contact_by_id	GET /contact/{contactId}	Get Contact by ID
ContactApi	unsubscribe_contact	PUT /contact/unsubscribe/{contactId}	Unsubscribe Contact
ContactApi	update_contact	PUT /contact/{contactId}	Update Contact
ListApi	create_list	POST /list	Create List
ListApi	delete_list	DELETE /list/{listId}	Delete List
ListApi	get_all_lists	GET /list	Get All Lists
ListApi	get_list_by_id	GET /list/{listId}	Get List
ListApi	update_list	PUT /list/{listId}	Update List
ReportsApi	get_campaign_report	GET /report/campaign/{campaignId}	Get CampaignReport Data
SenderApi	create_sender	POST /sender	Create Sender
SenderApi	get_all_senders	GET /sender	Get All Senders
TagsApi	create_tag	POST /tag	Create a Tag
TagsApi	delete_tag	DELETE /tag/{tagId}	Delete a Tag
TagsApi	get_all_tags	GET /tag	Get All Tags
TagsApi	get_tag_by_id	GET /tag/{tagId}	Get a Tag by ID
TagsApi	update_tag	PUT /tag/{tagId}	Update a Tag

Documentation For Models

• Campaign
• CampaignDashboardData
• CampaignRequest
• Contact
• ContactRequest
• CreateResponse
• DashboardStats
• DeleteCampaign200Response
• DeleteRequest
• DeleteResponse
• LastSentCampaignStat
• ListModel
• ListRequest
• ReportData
• Response
• Sender
• SenderRequest
• SenderResponse
• Tag
• TagRequest

Documentation For Authorization

Authentication schemes defined for the API:

apiKeyAuth

• Type: API key
• API key parameter name: X-Team-ApiKey
• Location: HTTP header

Author

[e-mail]