actions

patch/api/projects/{project_id}/actions/{id}/

Request

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

Path parameters

idinteger required

A unique integer value identifying this action.

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

format'csv' | 'json'

Request body

idinteger
namestring nullable

Name of the action (must be unique within the project).

descriptionstring

Human-readable description of what this action represents.

post_to_slackboolean

Whether to post a notification to Slack when this action is triggered.

slack_message_formatstring

Custom Slack message format. Supports templates with event properties.

created_atstring date-time
deletedboolean
is_calculatingboolean
last_calculated_atstring date-time
team_idinteger
is_actionboolean
bytecode_errorstring nullable
pinned_atstring date-time nullable

ISO 8601 timestamp when the action was pinned, or null if not pinned. Set any value to pin, null to unpin.

creation_contextstring nullable
_create_in_folderstring
user_access_levelstring nullable

The effective access level the user has for this object

Response

idinteger required
namestring nullable

Name of the action (must be unique within the project).

descriptionstring

Human-readable description of what this action represents.

post_to_slackboolean

Whether to post a notification to Slack when this action is triggered.

slack_message_formatstring

Custom Slack message format. Supports templates with event properties.

created_atstring date-time required
deletedboolean
is_calculatingboolean required
last_calculated_atstring date-time
team_idinteger required
is_actionboolean required
bytecode_errorstring nullable required
pinned_atstring date-time nullable

ISO 8601 timestamp when the action was pinned, or null if not pinned. Set any value to pin, null to unpin.

creation_contextstring nullable required
_create_in_folderstring
user_access_levelstring nullable required

The effective access level the user has for this object

Changes

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