hog_flows

Cheap read for the scene-wide suspension banner: single-row TeamWorkflowsConfig lookup with no reputation computation. Every project member sees this — a suspension stops everyone's email, so hiding it would leave silent send failures unexplained.

get/api/projects/{project_id}/hog_flows/email_sending_suspension/

Request

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

email_sending_suspendedboolean required

True while workflow email sending is suspended for this project to protect deliverability.

email_sending_suspended_atstring date-time nullable required

When email sending was suspended; null while sending is enabled.

email_sending_suspension_reasonstring required

Staff-authored reason shown to customers alongside the suspension notice; empty when not suspended.

Changes

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