send_x_rest_api v1.0.0

NodeJS 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: "john.doe@gmail.com",  
  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: "john.doe@gmail.com", 
   firstName: "John",
   birthday: "1989-03-03",
   customFields: { "Designation": "Software Engineer"},  
   tags: ["Developer"],  
}

API Call B

{  
  email: "john.doe@gmail.com",  
  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 mapstringstring
• 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": "john.doe@gmail.com", "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 SDK is automatically generated by the Swagger Codegen project:

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

Installation

For Node.js

npm

To publish the library as a npm, please follow the procedure in "Publishing npm packages".

Then install it via:

npm install send_x_rest_api --save

git

If the library is hosted at a git repository, e.g. https://github.com/YOUR_USERNAME/send_x_rest_api then install it via:

    npm install YOUR_USERNAME/send_x_rest_api --save

For browser

The library also works in the browser environment via npm and browserify. After following the above steps with Node.js and installing browserify with npm install -g browserify, perform the following (assuming main.js is your entry file):

browserify main.js > bundle.js

Then include bundle.js in the HTML pages.

Getting Started

Please follow the installation instruction and execute the following JS code:

var SendXRestApi = require('send_x_rest_api');

var api = new SendXRestApi.ContactApi()

var apiKey = "apiKey_example"; // {String} 

var teamId = "teamId_example"; // {String} 

var contactDetails = new SendXRestApi.ContactRequest(); // {ContactRequest} Contact details


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.contactIdentifyPost(apiKey, teamId, contactDetails, callback);

Documentation for API Endpoints

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

Documentation for Models

• SendXRestApi.Contact
• SendXRestApi.ContactRequest
• SendXRestApi.ContactResponse
• SendXRestApi.TrackRequest
• SendXRestApi.TrackResponse

Documentation for Authorization

All endpoints do not require authorization.