Visitor Identification
POST
Generate a token
{{baseUrl}}/conversations/v3/visitor-identification/tokens/create
QUERY PARAMS
hapikey
{{apiKey}}
BODY json
{
"email": "",
"firstName": "",
"lastName": ""
}
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "POST");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/conversations/v3/visitor-identification/tokens/create?hapikey=%7B%7BapiKey%7D%7D");
struct curl_slist *headers = NULL;
headers = curl_slist_append(headers, "content-type: application/json");
curl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);
curl_easy_setopt(hnd, CURLOPT_POSTFIELDS, "{\n \"email\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\"\n}");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/post "{{baseUrl}}/conversations/v3/visitor-identification/tokens/create" {:query-params {:hapikey "{{apiKey}}"}
:content-type :json
:form-params {:email ""
:firstName ""
:lastName ""}})
require "http/client"
url = "{{baseUrl}}/conversations/v3/visitor-identification/tokens/create?hapikey=%7B%7BapiKey%7D%7D"
headers = HTTP::Headers{
"content-type" => "application/json"
}
reqBody = "{\n \"email\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\"\n}"
response = HTTP::Client.post url, headers: headers, body: reqBody
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Post,
RequestUri = new Uri("{{baseUrl}}/conversations/v3/visitor-identification/tokens/create?hapikey=%7B%7BapiKey%7D%7D"),
Content = new StringContent("{\n \"email\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\"\n}")
{
Headers =
{
ContentType = new MediaTypeHeaderValue("application/json")
}
}
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/conversations/v3/visitor-identification/tokens/create?hapikey=%7B%7BapiKey%7D%7D");
var request = new RestRequest("", Method.Post);
request.AddHeader("content-type", "application/json");
request.AddParameter("application/json", "{\n \"email\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\"\n}", ParameterType.RequestBody);
var response = client.Execute(request);
package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/conversations/v3/visitor-identification/tokens/create?hapikey=%7B%7BapiKey%7D%7D"
payload := strings.NewReader("{\n \"email\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("content-type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
POST /baseUrl/conversations/v3/visitor-identification/tokens/create?hapikey=%7B%7BapiKey%7D%7D HTTP/1.1
Content-Type: application/json
Host: example.com
Content-Length: 54
{
"email": "",
"firstName": "",
"lastName": ""
}
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("POST", "{{baseUrl}}/conversations/v3/visitor-identification/tokens/create?hapikey=%7B%7BapiKey%7D%7D")
.setHeader("content-type", "application/json")
.setBody("{\n \"email\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\"\n}")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/conversations/v3/visitor-identification/tokens/create?hapikey=%7B%7BapiKey%7D%7D"))
.header("content-type", "application/json")
.method("POST", HttpRequest.BodyPublishers.ofString("{\n \"email\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\"\n}"))
.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
OkHttpClient client = new OkHttpClient();
MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{\n \"email\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\"\n}");
Request request = new Request.Builder()
.url("{{baseUrl}}/conversations/v3/visitor-identification/tokens/create?hapikey=%7B%7BapiKey%7D%7D")
.post(body)
.addHeader("content-type", "application/json")
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.post("{{baseUrl}}/conversations/v3/visitor-identification/tokens/create?hapikey=%7B%7BapiKey%7D%7D")
.header("content-type", "application/json")
.body("{\n \"email\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\"\n}")
.asString();
const data = JSON.stringify({
email: '',
firstName: '',
lastName: ''
});
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('POST', '{{baseUrl}}/conversations/v3/visitor-identification/tokens/create?hapikey=%7B%7BapiKey%7D%7D');
xhr.setRequestHeader('content-type', 'application/json');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'POST',
url: '{{baseUrl}}/conversations/v3/visitor-identification/tokens/create',
params: {hapikey: '{{apiKey}}'},
headers: {'content-type': 'application/json'},
data: {email: '', firstName: '', lastName: ''}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/conversations/v3/visitor-identification/tokens/create?hapikey=%7B%7BapiKey%7D%7D';
const options = {
method: 'POST',
headers: {'content-type': 'application/json'},
body: '{"email":"","firstName":"","lastName":""}'
};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
const settings = {
async: true,
crossDomain: true,
url: '{{baseUrl}}/conversations/v3/visitor-identification/tokens/create?hapikey=%7B%7BapiKey%7D%7D',
method: 'POST',
headers: {
'content-type': 'application/json'
},
processData: false,
data: '{\n "email": "",\n "firstName": "",\n "lastName": ""\n}'
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val mediaType = MediaType.parse("application/json")
val body = RequestBody.create(mediaType, "{\n \"email\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\"\n}")
val request = Request.Builder()
.url("{{baseUrl}}/conversations/v3/visitor-identification/tokens/create?hapikey=%7B%7BapiKey%7D%7D")
.post(body)
.addHeader("content-type", "application/json")
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'POST',
hostname: 'example.com',
port: null,
path: '/baseUrl/conversations/v3/visitor-identification/tokens/create?hapikey=%7B%7BapiKey%7D%7D',
headers: {
'content-type': 'application/json'
}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on('data', function (chunk) {
chunks.push(chunk);
});
res.on('end', function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.write(JSON.stringify({email: '', firstName: '', lastName: ''}));
req.end();
const request = require('request');
const options = {
method: 'POST',
url: '{{baseUrl}}/conversations/v3/visitor-identification/tokens/create',
qs: {hapikey: '{{apiKey}}'},
headers: {'content-type': 'application/json'},
body: {email: '', firstName: '', lastName: ''},
json: true
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('POST', '{{baseUrl}}/conversations/v3/visitor-identification/tokens/create');
req.query({
hapikey: '{{apiKey}}'
});
req.headers({
'content-type': 'application/json'
});
req.type('json');
req.send({
email: '',
firstName: '',
lastName: ''
});
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});
const axios = require('axios').default;
const options = {
method: 'POST',
url: '{{baseUrl}}/conversations/v3/visitor-identification/tokens/create',
params: {hapikey: '{{apiKey}}'},
headers: {'content-type': 'application/json'},
data: {email: '', firstName: '', lastName: ''}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/conversations/v3/visitor-identification/tokens/create?hapikey=%7B%7BapiKey%7D%7D';
const options = {
method: 'POST',
headers: {'content-type': 'application/json'},
body: '{"email":"","firstName":"","lastName":""}'
};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
#import
NSDictionary *headers = @{ @"content-type": @"application/json" };
NSDictionary *parameters = @{ @"email": @"",
@"firstName": @"",
@"lastName": @"" };
NSData *postData = [NSJSONSerialization dataWithJSONObject:parameters options:0 error:nil];
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/conversations/v3/visitor-identification/tokens/create?hapikey=%7B%7BapiKey%7D%7D"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"POST"];
[request setAllHTTPHeaderFields:headers];
[request setHTTPBody:postData];
NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
if (error) {
NSLog(@"%@", error);
} else {
NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
NSLog(@"%@", httpResponse);
}
}];
[dataTask resume];
open Cohttp_lwt_unix
open Cohttp
open Lwt
let uri = Uri.of_string "{{baseUrl}}/conversations/v3/visitor-identification/tokens/create?hapikey=%7B%7BapiKey%7D%7D" in
let headers = Header.add (Header.init ()) "content-type" "application/json" in
let body = Cohttp_lwt_body.of_string "{\n \"email\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\"\n}" in
Client.call ~headers ~body `POST uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/conversations/v3/visitor-identification/tokens/create?hapikey=%7B%7BapiKey%7D%7D",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'email' => '',
'firstName' => '',
'lastName' => ''
]),
CURLOPT_HTTPHEADER => [
"content-type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
request('POST', '{{baseUrl}}/conversations/v3/visitor-identification/tokens/create?hapikey=%7B%7BapiKey%7D%7D', [
'body' => '{
"email": "",
"firstName": "",
"lastName": ""
}',
'headers' => [
'content-type' => 'application/json',
],
]);
echo $response->getBody();
setUrl('{{baseUrl}}/conversations/v3/visitor-identification/tokens/create');
$request->setMethod(HTTP_METH_POST);
$request->setQueryData([
'hapikey' => '{{apiKey}}'
]);
$request->setHeaders([
'content-type' => 'application/json'
]);
$request->setContentType('application/json');
$request->setBody(json_encode([
'email' => '',
'firstName' => '',
'lastName' => ''
]));
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
append(json_encode([
'email' => '',
'firstName' => '',
'lastName' => ''
]));
$request->setRequestUrl('{{baseUrl}}/conversations/v3/visitor-identification/tokens/create');
$request->setRequestMethod('POST');
$request->setBody($body);
$request->setQuery(new http\QueryString([
'hapikey' => '{{apiKey}}'
]));
$request->setHeaders([
'content-type' => 'application/json'
]);
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$headers=@{}
$headers.Add("content-type", "application/json")
$response = Invoke-WebRequest -Uri '{{baseUrl}}/conversations/v3/visitor-identification/tokens/create?hapikey=%7B%7BapiKey%7D%7D' -Method POST -Headers $headers -ContentType 'application/json' -Body '{
"email": "",
"firstName": "",
"lastName": ""
}'
$headers=@{}
$headers.Add("content-type", "application/json")
$response = Invoke-RestMethod -Uri '{{baseUrl}}/conversations/v3/visitor-identification/tokens/create?hapikey=%7B%7BapiKey%7D%7D' -Method POST -Headers $headers -ContentType 'application/json' -Body '{
"email": "",
"firstName": "",
"lastName": ""
}'
import http.client
conn = http.client.HTTPSConnection("example.com")
payload = "{\n \"email\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\"\n}"
headers = { 'content-type': "application/json" }
conn.request("POST", "/baseUrl/conversations/v3/visitor-identification/tokens/create?hapikey=%7B%7BapiKey%7D%7D", payload, headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/conversations/v3/visitor-identification/tokens/create"
querystring = {"hapikey":"{{apiKey}}"}
payload = {
"email": "",
"firstName": "",
"lastName": ""
}
headers = {"content-type": "application/json"}
response = requests.post(url, json=payload, headers=headers, params=querystring)
print(response.json())
library(httr)
url <- "{{baseUrl}}/conversations/v3/visitor-identification/tokens/create"
queryString <- list(hapikey = "{{apiKey}}")
payload <- "{\n \"email\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\"\n}"
encode <- "json"
response <- VERB("POST", url, body = payload, query = queryString, content_type("application/json"), encode = encode)
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/conversations/v3/visitor-identification/tokens/create?hapikey=%7B%7BapiKey%7D%7D")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["content-type"] = 'application/json'
request.body = "{\n \"email\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\"\n}"
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
headers: {'Content-Type' => 'application/json'}
)
response = conn.post('/baseUrl/conversations/v3/visitor-identification/tokens/create') do |req|
req.params['hapikey'] = '{{apiKey}}'
req.body = "{\n \"email\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\"\n}"
end
puts response.status
puts response.body
use serde_json::json;
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/conversations/v3/visitor-identification/tokens/create";
let querystring = [
("hapikey", "{{apiKey}}"),
];
let payload = json!({
"email": "",
"firstName": "",
"lastName": ""
});
let mut headers = reqwest::header::HeaderMap::new();
headers.insert("content-type", "application/json".parse().unwrap());
let client = reqwest::Client::new();
let response = client.post(url)
.query(&querystring)
.headers(headers)
.json(&payload)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request POST \
--url '{{baseUrl}}/conversations/v3/visitor-identification/tokens/create?hapikey=%7B%7BapiKey%7D%7D' \
--header 'content-type: application/json' \
--data '{
"email": "",
"firstName": "",
"lastName": ""
}'
echo '{
"email": "",
"firstName": "",
"lastName": ""
}' | \
http POST '{{baseUrl}}/conversations/v3/visitor-identification/tokens/create?hapikey=%7B%7BapiKey%7D%7D' \
content-type:application/json
wget --quiet \
--method POST \
--header 'content-type: application/json' \
--body-data '{\n "email": "",\n "firstName": "",\n "lastName": ""\n}' \
--output-document \
- '{{baseUrl}}/conversations/v3/visitor-identification/tokens/create?hapikey=%7B%7BapiKey%7D%7D'
import Foundation
let headers = ["content-type": "application/json"]
let parameters = [
"email": "",
"firstName": "",
"lastName": ""
] as [String : Any]
let postData = JSONSerialization.data(withJSONObject: parameters, options: [])
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/conversations/v3/visitor-identification/tokens/create?hapikey=%7B%7BapiKey%7D%7D")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "POST"
request.allHTTPHeaderFields = headers
request.httpBody = postData as Data
let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
if (error != nil) {
print(error as Any)
} else {
let httpResponse = response as? HTTPURLResponse
print(httpResponse)
}
})
dataTask.resume()
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c"
}
RESPONSE HEADERS
Content-Type
*/*
RESPONSE BODY text
{
"category": "VALIDATION_ERROR",
"correlationId": "aeb5f871-7f07-4993-9211-075dc63e7cbf",
"links": {
"knowledge-base": "https://www.hubspot.com/products/service/knowledge-base"
},
"message": "Invalid input (details will vary based on the error)"
}