Skip to content
Esc
↑↓navigate↵open⌘Jpreview

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
Authorization
AuthorizationBearer token · headerrequired

A BillionSend API key (bs_…).

Path parameters
idstringrequired
min length 1
Responses
200

The contact's preference page URL

objectstringrequired
Allowed:preferences_link
contactstring<uuid>required
urlstring<uri>required

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

401

Missing, malformed, unknown or revoked API key

statusCodenumberrequired
namestringrequired
messagestringrequired
404

Not found

statusCodenumberrequired
namestringrequired
messagestringrequired
422

APP_BASE_URL or the encryption key is not configured

statusCodenumberrequired
namestringrequired
messagestringrequired
429

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

statusCodenumberrequired
namestringrequired
messagestringrequired
Try it
Server
Authorization
Parameters
Request
curl -X POST 'https://api.billionsend.com/contacts/string/preferences-link' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Accept: application/json'
Response
{
  "object": "preferences_link",
  "contact": "ad596931-5d7c-4d2b-907e-5b64c9432eb4",
  "url": "http://example.com"
}

Was this page helpful?