Buttondown logo

Sending a magic link

This endpoint sends a magic login link to a subscriber, allowing them to authenticate and access their subscription management portal.

This is useful for authors and integrations that need to trigger subscriber login flows programmatically, such as when you want to let subscribers manage their subscriptions from within your own application.

Example

curl -X POST "https://api.buttondown.com/v1/subscribers/{id_or_email}/send-magic-link" \
  -H "Authorization: Token YOUR_API_KEY"

Notes

  • The magic link will be sent to the subscriber's email address.
  • Magic links expire after 30 minutes.
  • The link will direct subscribers to the portal, where they can view and manage all their subscriptions associated with that email address.
  • If your newsletter has a custom domain configured, the magic link URL will use that domain.

Sample requests

These sample requests are autogenerated by the OpenAPI spec. This endpoint requires one or more parameters in the URL: those are offset in curly-braces.

import requests

url = "https://api.buttondown.com/v1/subscribers/{id_or_email}/send-magic-link"
headers = {
  "Authorization": "Token $BUTTONDOWN_API_KEY"
}

response = requests.request("POST", url, headers=headers)
print(response.text)

Sample responses

The IDs and values referenced in these responses are fake; please only rely on these responses for overall structure.

{}