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.
/contacts/{id}/preferences-linkAuthorizationBearer token · headerrequiredA BillionSend API key (bs_…).
idstringrequiredThe contact's preference page URL
objectstringrequiredpreferences_linkcontactstring<uuid>requiredurlstring<uri>requiredThe contact's hosted preference page; no expiry, treat as a secret
Missing, malformed, unknown or revoked API key
statusCodenumberrequirednamestringrequiredmessagestringrequiredNot found
statusCodenumberrequirednamestringrequiredmessagestringrequiredAPP_BASE_URL or the encryption key is not configured
statusCodenumberrequirednamestringrequiredmessagestringrequiredOver the rate limit (rate_limit_exceeded, with Retry-After)
statusCodenumberrequirednamestringrequiredmessagestringrequired