Pular para o conteúdo principal
POST
/
communication-preferences
/
2026-03
/
links
/
generate
Gerar links de assinatura
curl --request POST \
  --url https://api.hubapi.com/communication-preferences/2026-03/links/generate \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "subscriberIdString": "<string>",
  "language": "<string>",
  "subscriptionId": 123
}
'
import requests

url = "https://api.hubapi.com/communication-preferences/2026-03/links/generate"

payload = {
"subscriberIdString": "<string>",
"language": "<string>",
"subscriptionId": 123
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)
const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({subscriberIdString: '<string>', language: '<string>', subscriptionId: 123})
};

fetch('https://api.hubapi.com/communication-preferences/2026-03/links/generate', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
CURLOPT_URL => "https://api.hubapi.com/communication-preferences/2026-03/links/generate",
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([
'subscriberIdString' => '<string>',
'language' => '<string>',
'subscriptionId' => 123
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
package main

import (
"fmt"
"strings"
"net/http"
"io"
)

func main() {

url := "https://api.hubapi.com/communication-preferences/2026-03/links/generate"

payload := strings.NewReader("{\n \"subscriberIdString\": \"<string>\",\n \"language\": \"<string>\",\n \"subscriptionId\": 123\n}")

req, _ := http.NewRequest("POST", url, payload)

req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")

res, _ := http.DefaultClient.Do(req)

defer res.Body.Close()
body, _ := io.ReadAll(res.Body)

fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.post("https://api.hubapi.com/communication-preferences/2026-03/links/generate")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"subscriberIdString\": \"<string>\",\n \"language\": \"<string>\",\n \"subscriptionId\": 123\n}")
.asString();
require 'uri'
require 'net/http'

url = URI("https://api.hubapi.com/communication-preferences/2026-03/links/generate")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"subscriberIdString\": \"<string>\",\n \"language\": \"<string>\",\n \"subscriptionId\": 123\n}"

response = http.request(request)
puts response.read_body
{
  "managePreferencesUrl": "<string>",
  "subscriberIdString": "<string>",
  "unsubscribeAllUrl": "<string>",
  "unsubscribeSingleUrl": "<string>"
}
{
"message": "Invalid input (details will vary based on the error)",
"correlationId": "aeb5f871-7f07-4993-9211-075dc63e7cbf",
"category": "VALIDATION_ERROR",
"links": {
"knowledge-base": "https://www.hubspot.com/products/service/knowledge-base"
}
}

Supported products

Autorizações

Authorization
string
header
obrigatório

The access token received from the authorization server in the OAuth 2.0 flow.

Parâmetros de consulta

channel
enum<string>
obrigatório

O canal de comunicação para o qual os links são gerados. Deve ser 'EMAIL'.

Opções disponíveis:
EMAIL
businessUnitId
integer<int64>
padrão:0

O identificador da unidade de negócio. O padrão é 0 se não for especificado.

Corpo

application/json
subscriberIdString
string
obrigatório

Uma string que representa o identificador exclusivo do assinante. Esta propriedade é obrigatória.

language
string

O idioma em que o link gerado deve ser apresentado, representado como uma string.

subscriptionId
integer<int64>

O identificador exclusivo da assinatura, representado como um número inteiro no formato int64.

Resposta

successful operation

managePreferencesUrl
string
obrigatório

O URL onde o assinante pode gerenciar suas preferências de comunicação.

subscriberIdString
string
obrigatório

Uma string que representa o identificador exclusivo do assinante.

unsubscribeAllUrl
string
obrigatório

Uma string contendo o URL para cancelar a inscrição do assinante de todas as comunicações.

unsubscribeSingleUrl
string

Uma string contendo o URL para cancelar a inscrição do contato de uma única comunicação.

Última modificação em 10 de abril de 2026