Subscriptions
GET
Get subscription definitions
{{baseUrl}}/communication-preferences/v3/definitions
QUERY PARAMS
hapikey
{{apiKey}}
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/communication-preferences/v3/definitions?hapikey=%7B%7BapiKey%7D%7D");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/communication-preferences/v3/definitions" {:query-params {:hapikey "{{apiKey}}"}})
require "http/client"
url = "{{baseUrl}}/communication-preferences/v3/definitions?hapikey=%7B%7BapiKey%7D%7D"
response = HTTP::Client.get url
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Get,
RequestUri = new Uri("{{baseUrl}}/communication-preferences/v3/definitions?hapikey=%7B%7BapiKey%7D%7D"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/communication-preferences/v3/definitions?hapikey=%7B%7BapiKey%7D%7D");
var request = new RestRequest("", Method.Get);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/communication-preferences/v3/definitions?hapikey=%7B%7BapiKey%7D%7D"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
GET /baseUrl/communication-preferences/v3/definitions?hapikey=%7B%7BapiKey%7D%7D HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/communication-preferences/v3/definitions?hapikey=%7B%7BapiKey%7D%7D")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/communication-preferences/v3/definitions?hapikey=%7B%7BapiKey%7D%7D"))
.method("GET", HttpRequest.BodyPublishers.noBody())
.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
OkHttpClient client = new OkHttpClient();
Request request = new Request.Builder()
.url("{{baseUrl}}/communication-preferences/v3/definitions?hapikey=%7B%7BapiKey%7D%7D")
.get()
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.get("{{baseUrl}}/communication-preferences/v3/definitions?hapikey=%7B%7BapiKey%7D%7D")
.asString();
const data = null;
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('GET', '{{baseUrl}}/communication-preferences/v3/definitions?hapikey=%7B%7BapiKey%7D%7D');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'GET',
url: '{{baseUrl}}/communication-preferences/v3/definitions',
params: {hapikey: '{{apiKey}}'}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/communication-preferences/v3/definitions?hapikey=%7B%7BapiKey%7D%7D';
const options = {method: 'GET'};
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}}/communication-preferences/v3/definitions?hapikey=%7B%7BapiKey%7D%7D',
method: 'GET',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/communication-preferences/v3/definitions?hapikey=%7B%7BapiKey%7D%7D")
.get()
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/communication-preferences/v3/definitions?hapikey=%7B%7BapiKey%7D%7D',
headers: {}
};
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.end();
const request = require('request');
const options = {
method: 'GET',
url: '{{baseUrl}}/communication-preferences/v3/definitions',
qs: {hapikey: '{{apiKey}}'}
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('GET', '{{baseUrl}}/communication-preferences/v3/definitions');
req.query({
hapikey: '{{apiKey}}'
});
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});
const axios = require('axios').default;
const options = {
method: 'GET',
url: '{{baseUrl}}/communication-preferences/v3/definitions',
params: {hapikey: '{{apiKey}}'}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/communication-preferences/v3/definitions?hapikey=%7B%7BapiKey%7D%7D';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
#import
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/communication-preferences/v3/definitions?hapikey=%7B%7BapiKey%7D%7D"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"GET"];
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}}/communication-preferences/v3/definitions?hapikey=%7B%7BapiKey%7D%7D" in
Client.call `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/communication-preferences/v3/definitions?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 => "GET",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
request('GET', '{{baseUrl}}/communication-preferences/v3/definitions?hapikey=%7B%7BapiKey%7D%7D');
echo $response->getBody();
setUrl('{{baseUrl}}/communication-preferences/v3/definitions');
$request->setMethod(HTTP_METH_GET);
$request->setQueryData([
'hapikey' => '{{apiKey}}'
]);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/communication-preferences/v3/definitions');
$request->setRequestMethod('GET');
$request->setQuery(new http\QueryString([
'hapikey' => '{{apiKey}}'
]));
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/communication-preferences/v3/definitions?hapikey=%7B%7BapiKey%7D%7D' -Method GET
$response = Invoke-RestMethod -Uri '{{baseUrl}}/communication-preferences/v3/definitions?hapikey=%7B%7BapiKey%7D%7D' -Method GET
import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("GET", "/baseUrl/communication-preferences/v3/definitions?hapikey=%7B%7BapiKey%7D%7D")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/communication-preferences/v3/definitions"
querystring = {"hapikey":"{{apiKey}}"}
response = requests.get(url, params=querystring)
print(response.json())
library(httr)
url <- "{{baseUrl}}/communication-preferences/v3/definitions"
queryString <- list(hapikey = "{{apiKey}}")
response <- VERB("GET", url, query = queryString, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/communication-preferences/v3/definitions?hapikey=%7B%7BapiKey%7D%7D")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.get('/baseUrl/communication-preferences/v3/definitions') do |req|
req.params['hapikey'] = '{{apiKey}}'
end
puts response.status
puts response.body
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/communication-preferences/v3/definitions";
let querystring = [
("hapikey", "{{apiKey}}"),
];
let client = reqwest::Client::new();
let response = client.get(url)
.query(&querystring)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request GET \
--url '{{baseUrl}}/communication-preferences/v3/definitions?hapikey=%7B%7BapiKey%7D%7D'
http GET '{{baseUrl}}/communication-preferences/v3/definitions?hapikey=%7B%7BapiKey%7D%7D'
wget --quiet \
--method GET \
--output-document \
- '{{baseUrl}}/communication-preferences/v3/definitions?hapikey=%7B%7BapiKey%7D%7D'
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/communication-preferences/v3/definitions?hapikey=%7B%7BapiKey%7D%7D")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "GET"
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
{
"subscriptionDefinitions": [
{
"createdAt": "2019-08-05T13:01:15.875Z",
"description": "Receive timely updates with the latest blog posts.",
"id": "1805677",
"isActive": true,
"isDefault": false,
"isInternal": false,
"name": "Default HubSpot Blog Subscription",
"updatedAt": "2019-08-05T13:01:15.875Z"
},
{
"communicationMethod": "Email",
"createdAt": "2019-08-05T13:01:15.875Z",
"description": "Receive feedback requests and customer service information.",
"id": "1805669",
"isActive": true,
"isDefault": true,
"isInternal": true,
"name": "Customer Service Communication",
"purpose": "Service",
"updatedAt": "2019-08-05T13:01:15.875Z"
},
{
"communicationMethod": "Email",
"createdAt": "2019-08-05T13:01:15.875Z",
"description": "One to One emails",
"id": "1805670",
"isActive": true,
"isDefault": true,
"isInternal": true,
"name": "One to One",
"purpose": "Sales",
"updatedAt": "2019-08-05T13:01:15.875Z"
}
]
}
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)"
}
GET
Get subscription statuses for a contact
{{baseUrl}}/communication-preferences/v3/status/email/:emailAddress
QUERY PARAMS
hapikey
{{apiKey}}
emailAddress
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/communication-preferences/v3/status/email/:emailAddress?hapikey=%7B%7BapiKey%7D%7D");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/communication-preferences/v3/status/email/:emailAddress" {:query-params {:hapikey "{{apiKey}}"}})
require "http/client"
url = "{{baseUrl}}/communication-preferences/v3/status/email/:emailAddress?hapikey=%7B%7BapiKey%7D%7D"
response = HTTP::Client.get url
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Get,
RequestUri = new Uri("{{baseUrl}}/communication-preferences/v3/status/email/:emailAddress?hapikey=%7B%7BapiKey%7D%7D"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/communication-preferences/v3/status/email/:emailAddress?hapikey=%7B%7BapiKey%7D%7D");
var request = new RestRequest("", Method.Get);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/communication-preferences/v3/status/email/:emailAddress?hapikey=%7B%7BapiKey%7D%7D"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
GET /baseUrl/communication-preferences/v3/status/email/:emailAddress?hapikey=%7B%7BapiKey%7D%7D HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/communication-preferences/v3/status/email/:emailAddress?hapikey=%7B%7BapiKey%7D%7D")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/communication-preferences/v3/status/email/:emailAddress?hapikey=%7B%7BapiKey%7D%7D"))
.method("GET", HttpRequest.BodyPublishers.noBody())
.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
OkHttpClient client = new OkHttpClient();
Request request = new Request.Builder()
.url("{{baseUrl}}/communication-preferences/v3/status/email/:emailAddress?hapikey=%7B%7BapiKey%7D%7D")
.get()
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.get("{{baseUrl}}/communication-preferences/v3/status/email/:emailAddress?hapikey=%7B%7BapiKey%7D%7D")
.asString();
const data = null;
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('GET', '{{baseUrl}}/communication-preferences/v3/status/email/:emailAddress?hapikey=%7B%7BapiKey%7D%7D');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'GET',
url: '{{baseUrl}}/communication-preferences/v3/status/email/:emailAddress',
params: {hapikey: '{{apiKey}}'}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/communication-preferences/v3/status/email/:emailAddress?hapikey=%7B%7BapiKey%7D%7D';
const options = {method: 'GET'};
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}}/communication-preferences/v3/status/email/:emailAddress?hapikey=%7B%7BapiKey%7D%7D',
method: 'GET',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/communication-preferences/v3/status/email/:emailAddress?hapikey=%7B%7BapiKey%7D%7D")
.get()
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/communication-preferences/v3/status/email/:emailAddress?hapikey=%7B%7BapiKey%7D%7D',
headers: {}
};
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.end();
const request = require('request');
const options = {
method: 'GET',
url: '{{baseUrl}}/communication-preferences/v3/status/email/:emailAddress',
qs: {hapikey: '{{apiKey}}'}
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('GET', '{{baseUrl}}/communication-preferences/v3/status/email/:emailAddress');
req.query({
hapikey: '{{apiKey}}'
});
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});
const axios = require('axios').default;
const options = {
method: 'GET',
url: '{{baseUrl}}/communication-preferences/v3/status/email/:emailAddress',
params: {hapikey: '{{apiKey}}'}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/communication-preferences/v3/status/email/:emailAddress?hapikey=%7B%7BapiKey%7D%7D';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
#import
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/communication-preferences/v3/status/email/:emailAddress?hapikey=%7B%7BapiKey%7D%7D"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"GET"];
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}}/communication-preferences/v3/status/email/:emailAddress?hapikey=%7B%7BapiKey%7D%7D" in
Client.call `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/communication-preferences/v3/status/email/:emailAddress?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 => "GET",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
request('GET', '{{baseUrl}}/communication-preferences/v3/status/email/:emailAddress?hapikey=%7B%7BapiKey%7D%7D');
echo $response->getBody();
setUrl('{{baseUrl}}/communication-preferences/v3/status/email/:emailAddress');
$request->setMethod(HTTP_METH_GET);
$request->setQueryData([
'hapikey' => '{{apiKey}}'
]);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/communication-preferences/v3/status/email/:emailAddress');
$request->setRequestMethod('GET');
$request->setQuery(new http\QueryString([
'hapikey' => '{{apiKey}}'
]));
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/communication-preferences/v3/status/email/:emailAddress?hapikey=%7B%7BapiKey%7D%7D' -Method GET
$response = Invoke-RestMethod -Uri '{{baseUrl}}/communication-preferences/v3/status/email/:emailAddress?hapikey=%7B%7BapiKey%7D%7D' -Method GET
import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("GET", "/baseUrl/communication-preferences/v3/status/email/:emailAddress?hapikey=%7B%7BapiKey%7D%7D")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/communication-preferences/v3/status/email/:emailAddress"
querystring = {"hapikey":"{{apiKey}}"}
response = requests.get(url, params=querystring)
print(response.json())
library(httr)
url <- "{{baseUrl}}/communication-preferences/v3/status/email/:emailAddress"
queryString <- list(hapikey = "{{apiKey}}")
response <- VERB("GET", url, query = queryString, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/communication-preferences/v3/status/email/:emailAddress?hapikey=%7B%7BapiKey%7D%7D")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.get('/baseUrl/communication-preferences/v3/status/email/:emailAddress') do |req|
req.params['hapikey'] = '{{apiKey}}'
end
puts response.status
puts response.body
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/communication-preferences/v3/status/email/:emailAddress";
let querystring = [
("hapikey", "{{apiKey}}"),
];
let client = reqwest::Client::new();
let response = client.get(url)
.query(&querystring)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request GET \
--url '{{baseUrl}}/communication-preferences/v3/status/email/:emailAddress?hapikey=%7B%7BapiKey%7D%7D'
http GET '{{baseUrl}}/communication-preferences/v3/status/email/:emailAddress?hapikey=%7B%7BapiKey%7D%7D'
wget --quiet \
--method GET \
--output-document \
- '{{baseUrl}}/communication-preferences/v3/status/email/:emailAddress?hapikey=%7B%7BapiKey%7D%7D'
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/communication-preferences/v3/status/email/:emailAddress?hapikey=%7B%7BapiKey%7D%7D")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "GET"
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
{
"recipient": "example@example.com",
"subscriptionStatuses": [
{
"description": "Receive timely updates with the latest blog posts.",
"id": "7148714",
"legalBasis": "CONSENT_WITH_NOTICE",
"legalBasisExplanation": "At users request, we opted them in",
"name": "Default HubSpot Blog Subscription",
"preferenceGroupName": "Initial Group",
"sourceOfStatus": "SUBSCRIPTION_STATUS",
"status": "SUBSCRIBED"
},
{
"description": "One to One emails",
"id": "7148715",
"legalBasis": "CONSENT_WITH_NOTICE",
"legalBasisExplanation": "User has requested to be opted out",
"name": "One to One",
"sourceOfStatus": "SUBSCRIPTION_STATUS",
"status": "NOT_SUBSCRIBED"
}
]
}
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)"
}
POST
Subscribe a contact
{{baseUrl}}/communication-preferences/v3/subscribe
BODY json
{
"emailAddress": "",
"legalBasis": "",
"legalBasisExplanation": "",
"subscriptionId": ""
}
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "POST");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/communication-preferences/v3/subscribe");
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 \"emailAddress\": \"\",\n \"legalBasis\": \"\",\n \"legalBasisExplanation\": \"\",\n \"subscriptionId\": \"\"\n}");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/post "{{baseUrl}}/communication-preferences/v3/subscribe" {:content-type :json
:form-params {:emailAddress ""
:legalBasis ""
:legalBasisExplanation ""
:subscriptionId ""}})
require "http/client"
url = "{{baseUrl}}/communication-preferences/v3/subscribe"
headers = HTTP::Headers{
"content-type" => "application/json"
}
reqBody = "{\n \"emailAddress\": \"\",\n \"legalBasis\": \"\",\n \"legalBasisExplanation\": \"\",\n \"subscriptionId\": \"\"\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}}/communication-preferences/v3/subscribe"),
Content = new StringContent("{\n \"emailAddress\": \"\",\n \"legalBasis\": \"\",\n \"legalBasisExplanation\": \"\",\n \"subscriptionId\": \"\"\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}}/communication-preferences/v3/subscribe");
var request = new RestRequest("", Method.Post);
request.AddHeader("content-type", "application/json");
request.AddParameter("application/json", "{\n \"emailAddress\": \"\",\n \"legalBasis\": \"\",\n \"legalBasisExplanation\": \"\",\n \"subscriptionId\": \"\"\n}", ParameterType.RequestBody);
var response = client.Execute(request);
package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/communication-preferences/v3/subscribe"
payload := strings.NewReader("{\n \"emailAddress\": \"\",\n \"legalBasis\": \"\",\n \"legalBasisExplanation\": \"\",\n \"subscriptionId\": \"\"\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/communication-preferences/v3/subscribe HTTP/1.1
Content-Type: application/json
Host: example.com
Content-Length: 99
{
"emailAddress": "",
"legalBasis": "",
"legalBasisExplanation": "",
"subscriptionId": ""
}
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("POST", "{{baseUrl}}/communication-preferences/v3/subscribe")
.setHeader("content-type", "application/json")
.setBody("{\n \"emailAddress\": \"\",\n \"legalBasis\": \"\",\n \"legalBasisExplanation\": \"\",\n \"subscriptionId\": \"\"\n}")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/communication-preferences/v3/subscribe"))
.header("content-type", "application/json")
.method("POST", HttpRequest.BodyPublishers.ofString("{\n \"emailAddress\": \"\",\n \"legalBasis\": \"\",\n \"legalBasisExplanation\": \"\",\n \"subscriptionId\": \"\"\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 \"emailAddress\": \"\",\n \"legalBasis\": \"\",\n \"legalBasisExplanation\": \"\",\n \"subscriptionId\": \"\"\n}");
Request request = new Request.Builder()
.url("{{baseUrl}}/communication-preferences/v3/subscribe")
.post(body)
.addHeader("content-type", "application/json")
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.post("{{baseUrl}}/communication-preferences/v3/subscribe")
.header("content-type", "application/json")
.body("{\n \"emailAddress\": \"\",\n \"legalBasis\": \"\",\n \"legalBasisExplanation\": \"\",\n \"subscriptionId\": \"\"\n}")
.asString();
const data = JSON.stringify({
emailAddress: '',
legalBasis: '',
legalBasisExplanation: '',
subscriptionId: ''
});
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('POST', '{{baseUrl}}/communication-preferences/v3/subscribe');
xhr.setRequestHeader('content-type', 'application/json');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'POST',
url: '{{baseUrl}}/communication-preferences/v3/subscribe',
headers: {'content-type': 'application/json'},
data: {
emailAddress: '',
legalBasis: '',
legalBasisExplanation: '',
subscriptionId: ''
}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/communication-preferences/v3/subscribe';
const options = {
method: 'POST',
headers: {'content-type': 'application/json'},
body: '{"emailAddress":"","legalBasis":"","legalBasisExplanation":"","subscriptionId":""}'
};
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}}/communication-preferences/v3/subscribe',
method: 'POST',
headers: {
'content-type': 'application/json'
},
processData: false,
data: '{\n "emailAddress": "",\n "legalBasis": "",\n "legalBasisExplanation": "",\n "subscriptionId": ""\n}'
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val mediaType = MediaType.parse("application/json")
val body = RequestBody.create(mediaType, "{\n \"emailAddress\": \"\",\n \"legalBasis\": \"\",\n \"legalBasisExplanation\": \"\",\n \"subscriptionId\": \"\"\n}")
val request = Request.Builder()
.url("{{baseUrl}}/communication-preferences/v3/subscribe")
.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/communication-preferences/v3/subscribe',
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({
emailAddress: '',
legalBasis: '',
legalBasisExplanation: '',
subscriptionId: ''
}));
req.end();
const request = require('request');
const options = {
method: 'POST',
url: '{{baseUrl}}/communication-preferences/v3/subscribe',
headers: {'content-type': 'application/json'},
body: {
emailAddress: '',
legalBasis: '',
legalBasisExplanation: '',
subscriptionId: ''
},
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}}/communication-preferences/v3/subscribe');
req.headers({
'content-type': 'application/json'
});
req.type('json');
req.send({
emailAddress: '',
legalBasis: '',
legalBasisExplanation: '',
subscriptionId: ''
});
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}}/communication-preferences/v3/subscribe',
headers: {'content-type': 'application/json'},
data: {
emailAddress: '',
legalBasis: '',
legalBasisExplanation: '',
subscriptionId: ''
}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/communication-preferences/v3/subscribe';
const options = {
method: 'POST',
headers: {'content-type': 'application/json'},
body: '{"emailAddress":"","legalBasis":"","legalBasisExplanation":"","subscriptionId":""}'
};
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 = @{ @"emailAddress": @"",
@"legalBasis": @"",
@"legalBasisExplanation": @"",
@"subscriptionId": @"" };
NSData *postData = [NSJSONSerialization dataWithJSONObject:parameters options:0 error:nil];
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/communication-preferences/v3/subscribe"]
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}}/communication-preferences/v3/subscribe" in
let headers = Header.add (Header.init ()) "content-type" "application/json" in
let body = Cohttp_lwt_body.of_string "{\n \"emailAddress\": \"\",\n \"legalBasis\": \"\",\n \"legalBasisExplanation\": \"\",\n \"subscriptionId\": \"\"\n}" in
Client.call ~headers ~body `POST uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/communication-preferences/v3/subscribe",
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([
'emailAddress' => '',
'legalBasis' => '',
'legalBasisExplanation' => '',
'subscriptionId' => ''
]),
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}}/communication-preferences/v3/subscribe', [
'body' => '{
"emailAddress": "",
"legalBasis": "",
"legalBasisExplanation": "",
"subscriptionId": ""
}',
'headers' => [
'content-type' => 'application/json',
],
]);
echo $response->getBody();
setUrl('{{baseUrl}}/communication-preferences/v3/subscribe');
$request->setMethod(HTTP_METH_POST);
$request->setHeaders([
'content-type' => 'application/json'
]);
$request->setContentType('application/json');
$request->setBody(json_encode([
'emailAddress' => '',
'legalBasis' => '',
'legalBasisExplanation' => '',
'subscriptionId' => ''
]));
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
append(json_encode([
'emailAddress' => '',
'legalBasis' => '',
'legalBasisExplanation' => '',
'subscriptionId' => ''
]));
$request->setRequestUrl('{{baseUrl}}/communication-preferences/v3/subscribe');
$request->setRequestMethod('POST');
$request->setBody($body);
$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}}/communication-preferences/v3/subscribe' -Method POST -Headers $headers -ContentType 'application/json' -Body '{
"emailAddress": "",
"legalBasis": "",
"legalBasisExplanation": "",
"subscriptionId": ""
}'
$headers=@{}
$headers.Add("content-type", "application/json")
$response = Invoke-RestMethod -Uri '{{baseUrl}}/communication-preferences/v3/subscribe' -Method POST -Headers $headers -ContentType 'application/json' -Body '{
"emailAddress": "",
"legalBasis": "",
"legalBasisExplanation": "",
"subscriptionId": ""
}'
import http.client
conn = http.client.HTTPSConnection("example.com")
payload = "{\n \"emailAddress\": \"\",\n \"legalBasis\": \"\",\n \"legalBasisExplanation\": \"\",\n \"subscriptionId\": \"\"\n}"
headers = { 'content-type': "application/json" }
conn.request("POST", "/baseUrl/communication-preferences/v3/subscribe", payload, headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/communication-preferences/v3/subscribe"
payload = {
"emailAddress": "",
"legalBasis": "",
"legalBasisExplanation": "",
"subscriptionId": ""
}
headers = {"content-type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.json())
library(httr)
url <- "{{baseUrl}}/communication-preferences/v3/subscribe"
payload <- "{\n \"emailAddress\": \"\",\n \"legalBasis\": \"\",\n \"legalBasisExplanation\": \"\",\n \"subscriptionId\": \"\"\n}"
encode <- "json"
response <- VERB("POST", url, body = payload, content_type("application/json"), encode = encode)
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/communication-preferences/v3/subscribe")
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 \"emailAddress\": \"\",\n \"legalBasis\": \"\",\n \"legalBasisExplanation\": \"\",\n \"subscriptionId\": \"\"\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/communication-preferences/v3/subscribe') do |req|
req.body = "{\n \"emailAddress\": \"\",\n \"legalBasis\": \"\",\n \"legalBasisExplanation\": \"\",\n \"subscriptionId\": \"\"\n}"
end
puts response.status
puts response.body
use serde_json::json;
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/communication-preferences/v3/subscribe";
let payload = json!({
"emailAddress": "",
"legalBasis": "",
"legalBasisExplanation": "",
"subscriptionId": ""
});
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)
.headers(headers)
.json(&payload)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request POST \
--url {{baseUrl}}/communication-preferences/v3/subscribe \
--header 'content-type: application/json' \
--data '{
"emailAddress": "",
"legalBasis": "",
"legalBasisExplanation": "",
"subscriptionId": ""
}'
echo '{
"emailAddress": "",
"legalBasis": "",
"legalBasisExplanation": "",
"subscriptionId": ""
}' | \
http POST {{baseUrl}}/communication-preferences/v3/subscribe \
content-type:application/json
wget --quiet \
--method POST \
--header 'content-type: application/json' \
--body-data '{\n "emailAddress": "",\n "legalBasis": "",\n "legalBasisExplanation": "",\n "subscriptionId": ""\n}' \
--output-document \
- {{baseUrl}}/communication-preferences/v3/subscribe
import Foundation
let headers = ["content-type": "application/json"]
let parameters = [
"emailAddress": "",
"legalBasis": "",
"legalBasisExplanation": "",
"subscriptionId": ""
] as [String : Any]
let postData = JSONSerialization.data(withJSONObject: parameters, options: [])
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/communication-preferences/v3/subscribe")! 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
{
"description": "Receive timely updates with the latest blog posts.",
"id": "7148714",
"legalBasis": "CONSENT_WITH_NOTICE",
"legalBasisExplanation": "At users request, we opted them in",
"name": "Default HubSpot Blog Subscription",
"preferenceGroupName": "Initial Group",
"sourceOfStatus": "SUBSCRIPTION_STATUS",
"status": "SUBSCRIBED"
}
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)"
}
POST
Unsubscribe a contact
{{baseUrl}}/communication-preferences/v3/unsubscribe
BODY json
{
"emailAddress": "",
"legalBasis": "",
"legalBasisExplanation": "",
"subscriptionId": ""
}
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "POST");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/communication-preferences/v3/unsubscribe");
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 \"emailAddress\": \"\",\n \"legalBasis\": \"\",\n \"legalBasisExplanation\": \"\",\n \"subscriptionId\": \"\"\n}");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/post "{{baseUrl}}/communication-preferences/v3/unsubscribe" {:content-type :json
:form-params {:emailAddress ""
:legalBasis ""
:legalBasisExplanation ""
:subscriptionId ""}})
require "http/client"
url = "{{baseUrl}}/communication-preferences/v3/unsubscribe"
headers = HTTP::Headers{
"content-type" => "application/json"
}
reqBody = "{\n \"emailAddress\": \"\",\n \"legalBasis\": \"\",\n \"legalBasisExplanation\": \"\",\n \"subscriptionId\": \"\"\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}}/communication-preferences/v3/unsubscribe"),
Content = new StringContent("{\n \"emailAddress\": \"\",\n \"legalBasis\": \"\",\n \"legalBasisExplanation\": \"\",\n \"subscriptionId\": \"\"\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}}/communication-preferences/v3/unsubscribe");
var request = new RestRequest("", Method.Post);
request.AddHeader("content-type", "application/json");
request.AddParameter("application/json", "{\n \"emailAddress\": \"\",\n \"legalBasis\": \"\",\n \"legalBasisExplanation\": \"\",\n \"subscriptionId\": \"\"\n}", ParameterType.RequestBody);
var response = client.Execute(request);
package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/communication-preferences/v3/unsubscribe"
payload := strings.NewReader("{\n \"emailAddress\": \"\",\n \"legalBasis\": \"\",\n \"legalBasisExplanation\": \"\",\n \"subscriptionId\": \"\"\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/communication-preferences/v3/unsubscribe HTTP/1.1
Content-Type: application/json
Host: example.com
Content-Length: 99
{
"emailAddress": "",
"legalBasis": "",
"legalBasisExplanation": "",
"subscriptionId": ""
}
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("POST", "{{baseUrl}}/communication-preferences/v3/unsubscribe")
.setHeader("content-type", "application/json")
.setBody("{\n \"emailAddress\": \"\",\n \"legalBasis\": \"\",\n \"legalBasisExplanation\": \"\",\n \"subscriptionId\": \"\"\n}")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/communication-preferences/v3/unsubscribe"))
.header("content-type", "application/json")
.method("POST", HttpRequest.BodyPublishers.ofString("{\n \"emailAddress\": \"\",\n \"legalBasis\": \"\",\n \"legalBasisExplanation\": \"\",\n \"subscriptionId\": \"\"\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 \"emailAddress\": \"\",\n \"legalBasis\": \"\",\n \"legalBasisExplanation\": \"\",\n \"subscriptionId\": \"\"\n}");
Request request = new Request.Builder()
.url("{{baseUrl}}/communication-preferences/v3/unsubscribe")
.post(body)
.addHeader("content-type", "application/json")
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.post("{{baseUrl}}/communication-preferences/v3/unsubscribe")
.header("content-type", "application/json")
.body("{\n \"emailAddress\": \"\",\n \"legalBasis\": \"\",\n \"legalBasisExplanation\": \"\",\n \"subscriptionId\": \"\"\n}")
.asString();
const data = JSON.stringify({
emailAddress: '',
legalBasis: '',
legalBasisExplanation: '',
subscriptionId: ''
});
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('POST', '{{baseUrl}}/communication-preferences/v3/unsubscribe');
xhr.setRequestHeader('content-type', 'application/json');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'POST',
url: '{{baseUrl}}/communication-preferences/v3/unsubscribe',
headers: {'content-type': 'application/json'},
data: {
emailAddress: '',
legalBasis: '',
legalBasisExplanation: '',
subscriptionId: ''
}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/communication-preferences/v3/unsubscribe';
const options = {
method: 'POST',
headers: {'content-type': 'application/json'},
body: '{"emailAddress":"","legalBasis":"","legalBasisExplanation":"","subscriptionId":""}'
};
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}}/communication-preferences/v3/unsubscribe',
method: 'POST',
headers: {
'content-type': 'application/json'
},
processData: false,
data: '{\n "emailAddress": "",\n "legalBasis": "",\n "legalBasisExplanation": "",\n "subscriptionId": ""\n}'
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val mediaType = MediaType.parse("application/json")
val body = RequestBody.create(mediaType, "{\n \"emailAddress\": \"\",\n \"legalBasis\": \"\",\n \"legalBasisExplanation\": \"\",\n \"subscriptionId\": \"\"\n}")
val request = Request.Builder()
.url("{{baseUrl}}/communication-preferences/v3/unsubscribe")
.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/communication-preferences/v3/unsubscribe',
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({
emailAddress: '',
legalBasis: '',
legalBasisExplanation: '',
subscriptionId: ''
}));
req.end();
const request = require('request');
const options = {
method: 'POST',
url: '{{baseUrl}}/communication-preferences/v3/unsubscribe',
headers: {'content-type': 'application/json'},
body: {
emailAddress: '',
legalBasis: '',
legalBasisExplanation: '',
subscriptionId: ''
},
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}}/communication-preferences/v3/unsubscribe');
req.headers({
'content-type': 'application/json'
});
req.type('json');
req.send({
emailAddress: '',
legalBasis: '',
legalBasisExplanation: '',
subscriptionId: ''
});
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}}/communication-preferences/v3/unsubscribe',
headers: {'content-type': 'application/json'},
data: {
emailAddress: '',
legalBasis: '',
legalBasisExplanation: '',
subscriptionId: ''
}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/communication-preferences/v3/unsubscribe';
const options = {
method: 'POST',
headers: {'content-type': 'application/json'},
body: '{"emailAddress":"","legalBasis":"","legalBasisExplanation":"","subscriptionId":""}'
};
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 = @{ @"emailAddress": @"",
@"legalBasis": @"",
@"legalBasisExplanation": @"",
@"subscriptionId": @"" };
NSData *postData = [NSJSONSerialization dataWithJSONObject:parameters options:0 error:nil];
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/communication-preferences/v3/unsubscribe"]
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}}/communication-preferences/v3/unsubscribe" in
let headers = Header.add (Header.init ()) "content-type" "application/json" in
let body = Cohttp_lwt_body.of_string "{\n \"emailAddress\": \"\",\n \"legalBasis\": \"\",\n \"legalBasisExplanation\": \"\",\n \"subscriptionId\": \"\"\n}" in
Client.call ~headers ~body `POST uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/communication-preferences/v3/unsubscribe",
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([
'emailAddress' => '',
'legalBasis' => '',
'legalBasisExplanation' => '',
'subscriptionId' => ''
]),
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}}/communication-preferences/v3/unsubscribe', [
'body' => '{
"emailAddress": "",
"legalBasis": "",
"legalBasisExplanation": "",
"subscriptionId": ""
}',
'headers' => [
'content-type' => 'application/json',
],
]);
echo $response->getBody();
setUrl('{{baseUrl}}/communication-preferences/v3/unsubscribe');
$request->setMethod(HTTP_METH_POST);
$request->setHeaders([
'content-type' => 'application/json'
]);
$request->setContentType('application/json');
$request->setBody(json_encode([
'emailAddress' => '',
'legalBasis' => '',
'legalBasisExplanation' => '',
'subscriptionId' => ''
]));
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
append(json_encode([
'emailAddress' => '',
'legalBasis' => '',
'legalBasisExplanation' => '',
'subscriptionId' => ''
]));
$request->setRequestUrl('{{baseUrl}}/communication-preferences/v3/unsubscribe');
$request->setRequestMethod('POST');
$request->setBody($body);
$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}}/communication-preferences/v3/unsubscribe' -Method POST -Headers $headers -ContentType 'application/json' -Body '{
"emailAddress": "",
"legalBasis": "",
"legalBasisExplanation": "",
"subscriptionId": ""
}'
$headers=@{}
$headers.Add("content-type", "application/json")
$response = Invoke-RestMethod -Uri '{{baseUrl}}/communication-preferences/v3/unsubscribe' -Method POST -Headers $headers -ContentType 'application/json' -Body '{
"emailAddress": "",
"legalBasis": "",
"legalBasisExplanation": "",
"subscriptionId": ""
}'
import http.client
conn = http.client.HTTPSConnection("example.com")
payload = "{\n \"emailAddress\": \"\",\n \"legalBasis\": \"\",\n \"legalBasisExplanation\": \"\",\n \"subscriptionId\": \"\"\n}"
headers = { 'content-type': "application/json" }
conn.request("POST", "/baseUrl/communication-preferences/v3/unsubscribe", payload, headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/communication-preferences/v3/unsubscribe"
payload = {
"emailAddress": "",
"legalBasis": "",
"legalBasisExplanation": "",
"subscriptionId": ""
}
headers = {"content-type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.json())
library(httr)
url <- "{{baseUrl}}/communication-preferences/v3/unsubscribe"
payload <- "{\n \"emailAddress\": \"\",\n \"legalBasis\": \"\",\n \"legalBasisExplanation\": \"\",\n \"subscriptionId\": \"\"\n}"
encode <- "json"
response <- VERB("POST", url, body = payload, content_type("application/json"), encode = encode)
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/communication-preferences/v3/unsubscribe")
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 \"emailAddress\": \"\",\n \"legalBasis\": \"\",\n \"legalBasisExplanation\": \"\",\n \"subscriptionId\": \"\"\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/communication-preferences/v3/unsubscribe') do |req|
req.body = "{\n \"emailAddress\": \"\",\n \"legalBasis\": \"\",\n \"legalBasisExplanation\": \"\",\n \"subscriptionId\": \"\"\n}"
end
puts response.status
puts response.body
use serde_json::json;
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/communication-preferences/v3/unsubscribe";
let payload = json!({
"emailAddress": "",
"legalBasis": "",
"legalBasisExplanation": "",
"subscriptionId": ""
});
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)
.headers(headers)
.json(&payload)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request POST \
--url {{baseUrl}}/communication-preferences/v3/unsubscribe \
--header 'content-type: application/json' \
--data '{
"emailAddress": "",
"legalBasis": "",
"legalBasisExplanation": "",
"subscriptionId": ""
}'
echo '{
"emailAddress": "",
"legalBasis": "",
"legalBasisExplanation": "",
"subscriptionId": ""
}' | \
http POST {{baseUrl}}/communication-preferences/v3/unsubscribe \
content-type:application/json
wget --quiet \
--method POST \
--header 'content-type: application/json' \
--body-data '{\n "emailAddress": "",\n "legalBasis": "",\n "legalBasisExplanation": "",\n "subscriptionId": ""\n}' \
--output-document \
- {{baseUrl}}/communication-preferences/v3/unsubscribe
import Foundation
let headers = ["content-type": "application/json"]
let parameters = [
"emailAddress": "",
"legalBasis": "",
"legalBasisExplanation": "",
"subscriptionId": ""
] as [String : Any]
let postData = JSONSerialization.data(withJSONObject: parameters, options: [])
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/communication-preferences/v3/unsubscribe")! 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
{
"description": "Receive timely updates with the latest blog posts.",
"id": "7148714",
"legalBasis": "CONSENT_WITH_NOTICE",
"legalBasisExplanation": "At users request, we opted them out",
"name": "Default HubSpot Blog Subscription",
"preferenceGroupName": "Initial Group",
"sourceOfStatus": "SUBSCRIPTION_STATUS",
"status": "NOT_SUBSCRIBED"
}
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)"
}