sendx/sendx-api-python

Sendx API Python client

Python SendX API

NOTE: All API calls contain 2 parameters - 'api_key' and 'team_id'. These can be inferred from your settings page 'https://app.sendx.io/setting' under the sections 'Api Key' and 'Team Id' respectively.

SendX API has two methods:

• Identify
• Track

Identify API Method

Identify API Method is used to attach data to a visitor. If a contact is not yet created then we will create the contact. In case contact already exists then we update it.

Example Request:

{
  email: "[email protected]",  
  firstName: "John",
  lastName: "Doe",
  birthday: "1989-03-03",
  customFields: { "Designation": "Software Engineer", "Age": "27", "Experience": "5"},  
  tags: ["Developer", "API Team"],  
 }

Note that tags are an array of strings. In case they don't exist previously then API will create them and associate them with the contact.

Similarly if a custom field doesn't exist then it is first created and then associated with the contact along-with the corresponding value. In case custom field exists already then we simply update the value of it for the aforementioned contact.

We don't delete any of the properties based on identify call. What this means is that if for the same contact you did two API calls like:

API Call A

{
   email: "[email protected]", 
   firstName: "John",
   birthday: "1989-03-03",
   customFields: { "Designation": "Software Engineer"},  
   tags: ["Developer"],  
}

API Call B

{  
  email: "[email protected]",  
  customFields: { "Age": "29"},  
  tags: ["API Team"],  
}

The final contact will have firstName as John, birthday as 1989-03-03 present. Also both tags Developer and API Team shall be present alongwith custom fields Designation and Age.

Properties:

• firstName: type string
• lastName: type string
• email: type string
• newEmail: type string
• company: type string
• birthday: type string with format YYYY-MM-DD eg: 2016-11-21
• customFields: type map[string]string
• tags: type array of string

In case email of an already existing contact needs to be updated then specify current email under email property and updated email under newEmail property.

Response:

{ "status": "200", "message": "OK", "data": { "encryptedTeamId": "CLdh9Ig5GLIN1u8gTRvoja", "encryptedId": "c9QF63nrBenCaAXe660byz", "tags": [ "API Team", "Tech" ], "firstName": "John", "lastName": "Doe", "email": "[email protected]", "company": "", "birthday": "1989-03-03", "customFields": { "Age": "29", "Designation": "Software Engineer" } } }

Track API Method

Track API Method is used to track a contact. In the track API object you can:

• addTags:
• removeTags:

You can have automation rules based on tag addition as well as tag removal and they will get executed. For eg:

• On user registration tag start onboarding drip for him / her.
• Account Upgrade tag start add user to paid user list and start account expansion drip.
• On removal of trial user tag start upsell trial completed users drip.

Example Request:

{ "addTags": ["blogger", "female"] }

{ "addTags": ["paid user"], "removeTags": ["trial user"] }

Response:

{ "status": "200", "message": "OK", "data": "success" }

This Python package is automatically generated by the Swagger Codegen project:

• API version: v1
• Package version: 1.0.0
• Build package: class io.swagger.codegen.languages.PythonClientCodegen

Requirements.

Python 2.7 and 3.4+

Installation & Usage

pip install

If the python package is hosted on Github, you can install directly from Github

pip install git+https://github.com//.git

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

Then import the package:

import swagger_client 

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 swagger_client

Getting Started

Please follow the installation procedure and then run the following:

from __future__ import print_function
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint
# create an instance of the API class
api_instance = swagger_client.ContactApi()
api_key = 'api_key_example' # str | 
team_id = 'team_id_example' # str | 
contact_details = swagger_client.ContactRequest() # ContactRequest | Contact details
contact_details.email = "[email protected]" # Specifying contact email is mandatory

try:
    # Identify a contact as user
    api_response = api_instance.contact_identify_post(api_key, team_id, contact_details)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ContactApi->contact_identify_post: %s\n" % e)


track_details = swagger_client.TrackRequest() # TrackRequest | Track details
track_details.add_tags = ["paid user", "startup plan"] 
track_details.remove_tags = ["trial user"]


try:
    # Track contact 
    api_response = api_instance.contact_track_post(api_key, team_id, "[email protected]", track_details)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ContactApi->contact_track_post: %s\n" % e)

Documentation for API Endpoints

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

Class	Method	HTTP request	Description
ContactApi	contact_identify_post	POST /contact/identify	Identify a contact as user
ContactApi	contact_track_post	POST /contact/track	Add tracking info using tags to a contact

Documentation For Models

• Contact
• ContactRequest
• ContactResponse
• TrackRequest
• TrackResponse

Documentation For Authorization

All endpoints do not require authorization.

Author