Skip to content

Latest commit

 

History

History
executable file
·
119 lines (72 loc) · 2.67 KB

ContactApi.md

File metadata and controls

executable file
·
119 lines (72 loc) · 2.67 KB
Raw

SwaggerClient::ContactApi

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

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

contact_identify_post

ContactResponse contact_identify_post(api_key, team_id, contact_details)

Identify a contact as user

Example

# load the gem
require 'swagger_client'

api_instance = SwaggerClient::ContactApi.new

api_key = "api_key_example" # String | 

team_id = "team_id_example" # String | 

contact_details = SwaggerClient::ContactRequest.new # ContactRequest | Contact details


begin
  #Identify a contact as user
  result = api_instance.contact_identify_post(api_key, team_id, contact_details)
  p result
rescue SwaggerClient::ApiError => e
  puts "Exception when calling ContactApi->contact_identify_post: #{e}"
end

Parameters

Name Type Description Notes
api_key String
team_id String
contact_details ContactRequest Contact details

Return type

ContactResponse

Authorization

No authorization required

HTTP request headers

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

contact_track_post

TrackResponse contact_track_post(api_key, team_id, email, track_details)

Add tracking info using tags to a contact

Example

# load the gem
require 'swagger_client'

api_instance = SwaggerClient::ContactApi.new

api_key = "api_key_example" # String | 

team_id = "team_id_example" # String | 

email = "email_example" # String | 

track_details = SwaggerClient::TrackRequest.new # TrackRequest | Track Details


begin
  #Add tracking info using tags to a contact
  result = api_instance.contact_track_post(api_key, team_id, email, track_details)
  p result
rescue SwaggerClient::ApiError => e
  puts "Exception when calling ContactApi->contact_track_post: #{e}"
end

Parameters

Name Type Description Notes
api_key String
team_id String
email String
track_details TrackRequest Track Details

Return type

TrackResponse

Authorization

No authorization required

HTTP request headers

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