pulse

put/api/projects/{project_id}/pulse/brief_configs/{id}/

Request

  • Base URL: https://us.posthog.com
  • URL: https://us.posthog.com/api/projects/{project_id}/pulse/brief_configs/{id}/
  • Auth: HTTP bearer

Path parameters

idstring uuid required

A UUID string identifying this brief config.

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

idstring uuid required
namestring required

Human-readable name for this brief focus.

focus_promptstring

Free-text focus steering gathering and tone, e.g. "we're the feature flags team". Max 2000 characters.

enabledboolean

Whether this config generates briefs.

deletedboolean

Soft-delete flag. Deleted configs are hidden from lists but recoverable by patching this back to false.

created_atstring date-time required
updated_atstring date-time nullable required

Response

idstring uuid required
namestring required

Human-readable name for this brief focus.

focus_promptstring

Free-text focus steering gathering and tone, e.g. "we're the feature flags team". Max 2000 characters.

enabledboolean

Whether this config generates briefs.

deletedboolean

Soft-delete flag. Deleted configs are hidden from lists but recoverable by patching this back to false.

created_atstring date-time required
updated_atstring date-time nullable required

Changes

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