messaging_preferences

List recipients opted out of a message category

Get opt-outs filtered by category or overall opt-outs if no category specified

get/api/projects/{project_id}/messaging_preferences/opt_outs/

Request

  • Base URL: https://us.posthog.com
  • URL: https://us.posthog.com/api/projects/{project_id}/messaging_preferences/opt_outs/
  • Auth: HTTP bearer

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/.

Query parameters

category_keystring

Message category key to list opt-outs for. If omitted, lists recipients opted out of all marketing messages.

pageinteger
page_sizeinteger
searchstring

Case-insensitive substring match on the recipient identifier.

Response

countinteger required

Total number of opted-out recipients for the category.

nextstring uri nullable required

URL for the next page, or null on the last page.

previousstring uri nullable required

URL for the previous page, or null on the first page.

Changes

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