messaging_preferences

Manually add a recipient to the opt-out list

Manually add a recipient to the opt-out list for a specific category or all marketing messages.

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

Request

  • Base URL: https://us.posthog.com
  • URL: https://us.posthog.com/api/projects/{project_id}/messaging_preferences/add_opt_out/
  • 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/.

Request body

identifierstring required

The recipient identifier to opt out (e.g. email address).

category_keystring

Optional message category key. If omitted, the recipient is opted out of all marketing messages.

Response

idstring uuid required

Server-assigned UUID for this recipient's preference record.

identifierstring required

The recipient identifier (e.g. email address).

updated_atstring date-time required

When the preference was last updated.

preferencesunknown required

Changes

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