Pular para o conteúdo
Esc
↑↓navegar↵abrir⌘Jpré-visualizar

Get a preferences link

BillionSend extension. Returns the contact’s hosted preferences URL, so a product settings screen can deep-link into it. The page lists the team’s unbound public topics and carries the team-wide unsubscribe, in the team’s default look: the link belongs to no domain. The link is a signed, contact-scoped capability with no expiry: anyone holding it can change that contact’s preferences, so hand it only to the contact.

POST/contacts/{id}/preferences-link
Autorização
AuthorizationToken Bearer · headerobrigatório

A BillionSend API key (bs_…).

Parâmetros de caminho
idstringobrigatório
comprimento mín. 1
Respostas
200

The contact's preference page URL

objectstringobrigatório
Valores permitidos:preferences_link
contactstring<uuid>obrigatório
urlstring<uri>obrigatório

The contact's hosted preference page; no expiry, treat as a secret

401

Missing, malformed, unknown or revoked API key

statusCodenumberobrigatório
namestringobrigatório
messagestringobrigatório
404

Not found

statusCodenumberobrigatório
namestringobrigatório
messagestringobrigatório
422

APP_BASE_URL or the encryption key is not configured

statusCodenumberobrigatório
namestringobrigatório
messagestringobrigatório
429

Over the rate limit (rate_limit_exceeded, with Retry-After)

statusCodenumberobrigatório
namestringobrigatório
messagestringobrigatório
Experimentar
Servidor
Autorização
Parâmetros
Requisição
curl -X POST 'https://api.billionsend.com/contacts/string/preferences-link' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Accept: application/json'
Resposta
{
  "object": "preferences_link",
  "contact": "ad596931-5d7c-4d2b-907e-5b64c9432eb4",
  "url": "http://example.com"
}

Esta página foi útil?