task_channels

Create a channel

Create a channel. Public channels use lowercase names with hyphens. If a public channel has that name, return it. The name general returns the project's general space. Private channels always get a new ID, even if another channel has the same name. The requester and users in member_ids with project access become members. New channels are starred for the requester unless star is false. The names "me" and "personal" are reserved.

post/api/projects/{project_id}/task_channels/

Request

  • Base URL: https://us.posthog.com
  • URL: https://us.posthog.com/api/projects/{project_id}/task_channels/
  • Auth: one of:
    • HTTP bearer
    • 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

namestring required

Channel name, shown as #<name>. Uses lowercase letters and hyphens.

channel_type'public' | 'private'
  • public - public
  • private - private
member_idsinteger[]

User IDs to add to a private channel. The requester is always a member. The endpoint ignores this field for public channels and skips users without project access.

starboolean

Star a new channel for the requester. This field does not change stars on an existing channel.

Response

idstring uuid required
namestring required
channel_typestring required
github_integrationinteger nullable required
repositoriesstring[] required
auto_archive_after_daysinteger nullable required
created_atstring date-time required
starredboolean

Changes

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