ContactApi.md

SendXRestApi.ContactApi

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

Method	HTTP request	Description
contactIdentifyPost	POST /contact/identify	Identify a contact as user
contactTrackPost	POST /contact/track	Add tracking info using tags to a contact

contactIdentifyPost

ContactResponse contactIdentifyPost(apiKey, teamId, contactDetails)

Identify a contact as user

Example

var SendXRestApi = require('send_x_rest_api');

var apiInstance = 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);
  }
};
apiInstance.contactIdentifyPost(apiKey, teamId, contactDetails, callback);

Parameters

Name	Type	Description	Notes
apiKey	String
teamId	String
contactDetails	ContactRequest	Contact details

Return type

ContactResponse

Authorization

No authorization required

HTTP request headers

• Content-Type: application/json
• Accept: application/json

contactTrackPost

TrackResponse contactTrackPost(apiKey, teamId, email, trackDetails)

Add tracking info using tags to a contact

Example

var SendXRestApi = require('send_x_rest_api');

var apiInstance = new SendXRestApi.ContactApi();

var apiKey = "apiKey_example"; // String | 

var teamId = "teamId_example"; // String | 

var email = "email_example"; // String | 

var trackDetails = new SendXRestApi.TrackRequest(); // TrackRequest | Track Details


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
apiInstance.contactTrackPost(apiKey, teamId, email, trackDetails, callback);

Parameters

Name	Type	Description	Notes
apiKey	String
teamId	String
email	String
trackDetails	TrackRequest	Track Details

Return type

TrackResponse

Authorization

No authorization required

HTTP request headers

• Content-Type: application/json
• Accept: application/json