messaging_preferences

Generate a preferences page link for a recipient

Generate an unsubscribe link for the current user's email address

post/api/projects/{project_id}/messaging_preferences/generate_link/

Request

  • Base URL: https://us.posthog.com
  • URL: https://us.posthog.com/api/projects/{project_id}/messaging_preferences/generate_link/
  • Auth: none declared

Path parameters

project_idstring required

Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/.

Request body

recipientstring

Recipient to generate the link for. Defaults to the requesting user's own email address.

Response

preferences_urlstring uri required

Token-gated URL where the recipient can manage their preferences.

Changes

No recorded changes to this operation across all 1 revision of this API.