Aller au contenu
Esc
↑↓naviguer↵ouvrir⌘Japerçu

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
Autorisation
AuthorizationJeton Bearer · headerrequis

A BillionSend API key (bs_…).

Paramètres de chemin
idstringrequis
longueur min 1
Réponses
200

The contact's preference page URL

objectstringrequis
Valeurs autorisées :preferences_link
contactstring<uuid>requis
urlstring<uri>requis

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

401

Missing, malformed, unknown or revoked API key

statusCodenumberrequis
namestringrequis
messagestringrequis
404

Not found

statusCodenumberrequis
namestringrequis
messagestringrequis
422

APP_BASE_URL or the encryption key is not configured

statusCodenumberrequis
namestringrequis
messagestringrequis
429

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

statusCodenumberrequis
namestringrequis
messagestringrequis
Essayer
Serveur
Autorisation
Paramètres
Requête
curl -X POST 'https://api.billionsend.com/contacts/string/preferences-link' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Accept: application/json'
Réponse
{
  "object": "preferences_link",
  "contact": "ad596931-5d7c-4d2b-907e-5b64c9432eb4",
  "url": "http://example.com"
}

Cette page vous a-t-elle été utile ?