workflow_sending_rules

Changed on

The project-wide rules every workflow and broadcast follows when it sends a message.

get/api/projects/{project_id}/workflow_sending_rules/current/

Request

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

Response

project_idinteger required

The project these sending rules belong to.

expected_project_idinteger

Optional. The project_id from the rules being changed. The update is rejected when it does not match the current project, so a change never lands in a project the user did not look at.

marketing_frequency_cap_max_messagesinteger nullable

The most marketing messages one person gets in the window, across all workflows and broadcasts. Set it together with marketing_frequency_cap_window_days, or set both to null to turn the cap off. Transactional messages are never capped. The recommended cap is 1 message every 2 days.

marketing_frequency_cap_window_daysinteger nullable

The length of the rolling frequency cap window, in days. Set it together with marketing_frequency_cap_max_messages, or set both to null to turn the cap off.

email_tracking_consent_mode'off' | 'opt_out' | 'opt_in'
  • off - Off
  • opt_out - Opt Out
  • opt_in - Opt In
capture_workflows_engagement_eventsboolean

Capture email sends, opens, clicks and bounces as PostHog events, so they can be used in insights and funnels. These events count toward the project's event usage.

Changes